VTCompressionSession Class

Definition

Namespace:: VideoToolbox

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.macOS.dll

Assembly:: Microsoft.tvOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Turns uncompressed frames into compressed video frames

public class VTCompressionSession : VideoToolbox.VTSession

type VTCompressionSession = class
    inherit VTSession

Inheritance: Object

DisposableObject

NativeObject

VTSession
VTCompressionSession

Properties

Name	Description
Handle	(Inherited from DisposableObject)
Owns	(Inherited from DisposableObject)

Methods

Name	Description
BeginPass(VTCompressionSessionOptionFlags)	Start a compression pass.
ClearHandle()	(Inherited from DisposableObject)
CompleteFrames(CMTime)	Finish decoding all frames.
Create(Int32, Int32, CMVideoCodecType, VTCompressionSession+VTCompressionOutputCallback, VTVideoEncoderSpecification, CVPixelBufferAttributes)	Create a new compression session
Create(Int32, Int32, CMVideoCodecType, VTCompressionSession+VTCompressionOutputCallback, VTVideoEncoderSpecification, NSDictionary)	Create a new compression session
Dispose()	(Inherited from DisposableObject)
Dispose(Boolean)
EncodeFrame(CVImageBuffer, CMTime, CMTime, NSDictionary, CVImageBuffer, VTEncodeInfoFlags)
EncodeFrame(CVImageBuffer, CMTime, CMTime, NSDictionary, IntPtr, VTEncodeInfoFlags)	Encode a video frame.
EncodeMultiImageFrame(CMTaggedBufferGroup, CMTime, CMTime, NSDictionary, IntPtr, VTEncodeInfoFlags)	Encode a multi-image video frame.
EncodeMultiImageFrame(CMTaggedBufferGroup, CMTime, CMTime, NSDictionary, VTEncodeInfoFlags, VTCompressionSession+VTCompressionOutputHandler)	Encode a multi-image video frame.
EndPass(Boolean)	End a compression pass.
EndPassAsFinal()	End a compression pass, marking this pass as the final pass.
Equals(Object)	(Inherited from DisposableObject)
GetCheckedHandle()	(Inherited from DisposableObject)
GetHashCode()	(Inherited from DisposableObject)
GetPixelBufferPool()	Get the pixel buffer pool for this compression session.
GetProperties()	(Inherited from VTSession)
GetProperty(NSString)	(Inherited from VTSession)
GetSerializableProperties()	(Inherited from VTSession)
GetSupportedProperties()	(Inherited from VTSession)
GetTimeRangesForNextPass(CMTimeRange[])	Get the time ranges for the next pass.
InitializeHandle(NativeHandle)	(Inherited from DisposableObject)
IsStereoMvHevcEncodeSupported()	Returns whether the current system supports stereo MV-HEVC encode.
PrepareToEncodeFrames()	Prepare to encode frames.
Release()	(Inherited from NativeObject)
Retain()	(Inherited from NativeObject)
SetCompressionProperties(VTCompressionProperties)	Set any compression properties.
SetProperties(VTPropertyOptions)	(Inherited from VTSession)
SetProperty(NSString, NSObject)	(Inherited from VTSession)

Extension Methods

Name	Description
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)

Applies to