Share via

VTDecompressionSession.DecodeFrame Method

Definition

Namespace:
VideoToolbox
Assembly:
Microsoft.iOS.dll
Assembly:
Microsoft.MacCatalyst.dll
Assembly:
Microsoft.macOS.dll
Assembly:
Microsoft.tvOS.dll

Overloads

Name Description
DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, VTDecodeFrameOptions, VTDecodeInfoFlags, VTDecompressionSession+VTDecompressionOutputHandler)

Decode a video frame that may contain more than one image.
DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, NSDictionary, VTDecodeInfoFlags, VTDecompressionSession+VTDecompressionOutputHandler)

Decode a video frame that may contain more than one image.
DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, NSDictionary, IntPtr, VTDecodeInfoFlags)

Decode a video frame that may contain more than one image.
DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, VTDecodeFrameOptions, IntPtr, VTDecodeInfoFlags)

Decode a video frame that may contain more than one image.
DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, VTDecodeInfoFlags, VTDecompressionSession+VTDecompressionMultiImageCapableOutputHandler)

Decode a video frame that may contain more than one image.
DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, IntPtr, VTDecodeInfoFlags)

Decode a video frame.
DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, VTDecodeInfoFlags, VTDecompressionSession+VTDecompressionOutputHandler)

Decode a video frame.

DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, VTDecodeFrameOptions, VTDecodeInfoFlags, VTDecompressionSession+VTDecompressionOutputHandler)

Decode a video frame that may contain more than one image.

public VideoToolbox.VTStatus DecodeFrame(CoreMedia.CMSampleBuffer sampleBuffer, VideoToolbox.VTDecodeFrameFlags decodeFlags, VideoToolbox.VTDecodeFrameOptions? frameOptions, out VideoToolbox.VTDecodeInfoFlags infoFlags, VideoToolbox.VTDecompressionSession.VTDecompressionOutputHandler outputHandler);
member this.DecodeFrame : CoreMedia.CMSampleBuffer * VideoToolbox.VTDecodeFrameFlags * VideoToolbox.VTDecodeFrameOptions * VTDecodeInfoFlags * VideoToolbox.VTDecompressionSession.VTDecompressionOutputHandler -> VideoToolbox.VTStatus

Parameters

sampleBuffer
CMSampleBuffer

A sample buffer with one or more video frames.

decodeFlags
VTDecodeFrameFlags

Any decoding flags to be passed to the decoder.

frameOptions
VTDecodeFrameOptions

Any additional decoding options to be passed to the decoder.

infoFlags
VTDecodeInfoFlags

Upon return, any informational flags about the decode operation.

outputHandler
VTDecompressionSession.VTDecompressionOutputHandler

A callback that will be called when the decoding operation is complete.

Returns

VTStatus

Ok if successful, or an error code otherwise.

Applies to

DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, NSDictionary, VTDecodeInfoFlags, VTDecompressionSession+VTDecompressionOutputHandler)

Decode a video frame that may contain more than one image.

[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.Optimizable)]
public VideoToolbox.VTStatus DecodeFrame(CoreMedia.CMSampleBuffer sampleBuffer, VideoToolbox.VTDecodeFrameFlags decodeFlags, Foundation.NSDictionary? frameOptions, out VideoToolbox.VTDecodeInfoFlags infoFlags, VideoToolbox.VTDecompressionSession.VTDecompressionOutputHandler outputHandler);
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.Optimizable)>]
member this.DecodeFrame : CoreMedia.CMSampleBuffer * VideoToolbox.VTDecodeFrameFlags * Foundation.NSDictionary * VTDecodeInfoFlags * VideoToolbox.VTDecompressionSession.VTDecompressionOutputHandler -> VideoToolbox.VTStatus

Parameters

sampleBuffer
CMSampleBuffer

A sample buffer with one or more video frames.

decodeFlags
VTDecodeFrameFlags

Any decoding flags to be passed to the decoder.

frameOptions
NSDictionary

Any additional decoding options to be passed to the decoder.

infoFlags
VTDecodeInfoFlags

Upon return, any informational flags about the decode operation.

outputHandler
VTDecompressionSession.VTDecompressionOutputHandler

A callback that will be called when the decoding operation is complete.

Returns

VTStatus

Ok if successful, or an error code otherwise.

Attributes
BindingImplAttribute

Applies to

DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, NSDictionary, IntPtr, VTDecodeInfoFlags)

Decode a video frame that may contain more than one image.

public VideoToolbox.VTStatus DecodeFrame(CoreMedia.CMSampleBuffer sampleBuffer, VideoToolbox.VTDecodeFrameFlags decodeFlags, Foundation.NSDictionary? frameOptions, IntPtr sourceFrameReference, out VideoToolbox.VTDecodeInfoFlags infoFlags);
member this.DecodeFrame : CoreMedia.CMSampleBuffer * VideoToolbox.VTDecodeFrameFlags * Foundation.NSDictionary * nativeint * VTDecodeInfoFlags -> VideoToolbox.VTStatus

Parameters

sampleBuffer
CMSampleBuffer

A sample buffer with one or more video frames.

decodeFlags
VTDecodeFrameFlags

Any decoding flags to be passed to the decoder.

frameOptions
NSDictionary

Any additional decoding options to be passed to the decoder.

sourceFrameReference
IntPtr

nativeint

A user-provided value that is passed to any decoding callbacks.

infoFlags
VTDecodeInfoFlags

Upon return, any informational flags about the decode operation.

Returns

VTStatus

Ok if successful, or an error code otherwise.

Applies to

DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, VTDecodeFrameOptions, IntPtr, VTDecodeInfoFlags)

Decode a video frame that may contain more than one image.

public VideoToolbox.VTStatus DecodeFrame(CoreMedia.CMSampleBuffer sampleBuffer, VideoToolbox.VTDecodeFrameFlags decodeFlags, VideoToolbox.VTDecodeFrameOptions? frameOptions, IntPtr sourceFrameReference, out VideoToolbox.VTDecodeInfoFlags infoFlags);
member this.DecodeFrame : CoreMedia.CMSampleBuffer * VideoToolbox.VTDecodeFrameFlags * VideoToolbox.VTDecodeFrameOptions * nativeint * VTDecodeInfoFlags -> VideoToolbox.VTStatus

Parameters

sampleBuffer
CMSampleBuffer

A sample buffer with one or more video frames.

decodeFlags
VTDecodeFrameFlags

Any decoding flags to be passed to the decoder.

frameOptions
VTDecodeFrameOptions

Any additional decoding options to be passed to the decoder.

sourceFrameReference
IntPtr

nativeint

A user-provided value that is passed to any decoding callbacks.

infoFlags
VTDecodeInfoFlags

Upon return, any informational flags about the decode operation.

Returns

VTStatus

Ok if successful, or an error code otherwise.

Applies to

DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, VTDecodeInfoFlags, VTDecompressionSession+VTDecompressionMultiImageCapableOutputHandler)

Decode a video frame that may contain more than one image.

[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.Optimizable)]
public VideoToolbox.VTStatus DecodeFrame(CoreMedia.CMSampleBuffer sampleBuffer, VideoToolbox.VTDecodeFrameFlags decodeFlags, out VideoToolbox.VTDecodeInfoFlags infoFlags, VideoToolbox.VTDecompressionSession.VTDecompressionMultiImageCapableOutputHandler multiImageCapableOutputHandler);
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.Optimizable)>]
member this.DecodeFrame : CoreMedia.CMSampleBuffer * VideoToolbox.VTDecodeFrameFlags * VTDecodeInfoFlags * VideoToolbox.VTDecompressionSession.VTDecompressionMultiImageCapableOutputHandler -> VideoToolbox.VTStatus

Parameters

sampleBuffer
CMSampleBuffer

A sample buffer with one or more video frames.

decodeFlags
VTDecodeFrameFlags

Any decoding flags to be passed to the decoder.

infoFlags
VTDecodeInfoFlags

Upon return, any informational flags about the decode operation.

multiImageCapableOutputHandler
VTDecompressionSession.VTDecompressionMultiImageCapableOutputHandler

A callback that will be called when the decoding operation is complete.

Returns

VTStatus

Ok if successful, or an error code otherwise.

Attributes
BindingImplAttribute

Applies to

DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, IntPtr, VTDecodeInfoFlags)

Decode a video frame.

public VideoToolbox.VTStatus DecodeFrame(CoreMedia.CMSampleBuffer sampleBuffer, VideoToolbox.VTDecodeFrameFlags decodeFlags, IntPtr sourceFrame, out VideoToolbox.VTDecodeInfoFlags infoFlags);
member this.DecodeFrame : CoreMedia.CMSampleBuffer * VideoToolbox.VTDecodeFrameFlags * nativeint * VTDecodeInfoFlags -> VideoToolbox.VTStatus

Parameters

sampleBuffer
CMSampleBuffer

A sample buffer with one or more video frames.

decodeFlags
VTDecodeFrameFlags

Any decoding flags to be passed to the decoder.

sourceFrame
IntPtr

nativeint

A user-provided value that is passed to any decoding callbacks.

infoFlags
VTDecodeInfoFlags

Upon return, any informational flags about the decode operation.

Returns

VTStatus

Ok if successful, or an error code otherwise.

Applies to

DecodeFrame(CMSampleBuffer, VTDecodeFrameFlags, VTDecodeInfoFlags, VTDecompressionSession+VTDecompressionOutputHandler)

Decode a video frame.

[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.Optimizable)]
public VideoToolbox.VTStatus DecodeFrame(CoreMedia.CMSampleBuffer sampleBuffer, VideoToolbox.VTDecodeFrameFlags decodeFlags, out VideoToolbox.VTDecodeInfoFlags infoFlags, VideoToolbox.VTDecompressionSession.VTDecompressionOutputHandler outputHandler);
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.Optimizable)>]
member this.DecodeFrame : CoreMedia.CMSampleBuffer * VideoToolbox.VTDecodeFrameFlags * VTDecodeInfoFlags * VideoToolbox.VTDecompressionSession.VTDecompressionOutputHandler -> VideoToolbox.VTStatus

Parameters

sampleBuffer
CMSampleBuffer

A sample buffer with one or more video frames.

decodeFlags
VTDecodeFrameFlags

Any decoding flags to be passed to the decoder.

infoFlags
VTDecodeInfoFlags

Upon return, any informational flags about the decode operation.

outputHandler
VTDecompressionSession.VTDecompressionOutputHandler

A callback that will be called when the decoding operation is complete.

Returns

VTStatus

Ok if successful, or an error code otherwise.

Attributes
BindingImplAttribute

Applies to