Share via

VTCompressionSession.EncodeFrame Method

Definition

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

Overloads

EncodeFrame(CVImageBuffer, CMTime, CMTime, NSDictionary, CVImageBuffer, VTEncodeInfoFlags)

Caution

Call 'EncodeFrame(CVImageBuffer,CMTime,CMTime,NSDictionary,IntPtr,out VTEncodeInfoFlags)' instead.

[System.Obsolete("Call 'EncodeFrame(CVImageBuffer,CMTime,CMTime,NSDictionary,IntPtr,out VTEncodeInfoFlags)' instead.")]
public VideoToolbox.VTStatus EncodeFrame(CoreVideo.CVImageBuffer imageBuffer, CoreMedia.CMTime presentationTimestamp, CoreMedia.CMTime duration, Foundation.NSDictionary frameProperties, CoreVideo.CVImageBuffer sourceFrame, out VideoToolbox.VTEncodeInfoFlags infoFlags);
[<System.Obsolete("Call 'EncodeFrame(CVImageBuffer,CMTime,CMTime,NSDictionary,IntPtr,out VTEncodeInfoFlags)' instead.")>]
member this.EncodeFrame : CoreVideo.CVImageBuffer * CoreMedia.CMTime * CoreMedia.CMTime * Foundation.NSDictionary * CoreVideo.CVImageBuffer * VTEncodeInfoFlags -> VideoToolbox.VTStatus

Parameters

imageBuffer
CVImageBuffer
presentationTimestamp
CMTime
duration
CMTime
frameProperties
NSDictionary
sourceFrame
CVImageBuffer
infoFlags
VTEncodeInfoFlags

Returns

VTStatus
Attributes
ObsoleteAttribute

Applies to

EncodeFrame(CVImageBuffer, CMTime, CMTime, NSDictionary, IntPtr, VTEncodeInfoFlags)

Encode a video frame.

public VideoToolbox.VTStatus EncodeFrame(CoreVideo.CVImageBuffer imageBuffer, CoreMedia.CMTime presentationTimestamp, CoreMedia.CMTime duration, Foundation.NSDictionary? frameProperties, IntPtr sourceFrame, out VideoToolbox.VTEncodeInfoFlags infoFlags);
member this.EncodeFrame : CoreVideo.CVImageBuffer * CoreMedia.CMTime * CoreMedia.CMTime * Foundation.NSDictionary * nativeint * VTEncodeInfoFlags -> VideoToolbox.VTStatus

Parameters

imageBuffer
CVImageBuffer

The image buffer with the image data to compress.

presentationTimestamp
CMTime

The presentation timestamp for this frame.

duration
CMTime

The duration of this frame.

frameProperties
NSDictionary

Any frame properties for this frame.

sourceFrame
IntPtr

nativeint

This value will be passed to the VTCompressionSession.VTCompressionOutputCallback callback that was specified when the compression session was created.

infoFlags
VTEncodeInfoFlags

Upon return, any information flags from the encoder for this frame.

Returns

VTStatus

Ok if successful, or an error code otherwise.

Applies to