Function

VTCompressionSessionEncodeFrame(_:imageBuffer:presentationTimeStamp:duration:frameProperties:infoFlagsOut:outputHandler:)

Presents frames to the compression session and invokes the output callback when compression is complete.

Declaration

func VTCompressionSessionEncodeFrame(_ session: VTCompressionSession, imageBuffer: CVImageBuffer, presentationTimeStamp: CMTime, duration: CMTime, frameProperties: CFDictionary?, infoFlagsOut: UnsafeMutablePointer<VTEncodeInfoFlags>?, outputHandler: @escaping VTCompressionOutputHandler) -> OSStatus

Parameters

session

The compression session.

imageBuffer

A Core Video image buffer (CVImageBuffer) containing a video frame to be compressed. The buffer must have a nonzero reference count.

presentationTimeStamp

The presentation timestamp for this frame, to be attached to the sample buffer. Each presentation timestamp passed to a session must be greater than the previous one.

duration

The presentation duration for this frame, to be attached to the sample buffer. If you do not have duration information, pass invalid.

frameProperties

Key/value pairs specifying additional properties for encoding this frame. Note that some session properties may also be changed between frames. Such changes affect subsequently encoded frames.

infoFlagsOut

A pointer to a VTEncodeInfoFlags to receive information about the encode operation.

The asynchronous bit may be set if the encode is (or was) running asynchronously.

The frameDropped bit may be set if the frame was dropped (synchronously).

Pass NULL if you do not want to receive this information.

outputHandler

The block to be called when encoding the frame is completed. This block may be called asynchronously, on a different thread from the one that calls VTCompressionSessionEncodeFrameWithOutputHandler.

Discussion

Encoded frames may or may not be output before the function returns. The client should not modify the pixel data after making this call. The session and/or encoder retains the image buffer as long as necessary.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software