Instance Property

sourcePixelBufferAttributes

The types of source frame pixel buffer attributes a video compositor can accept as input.

Required.

Declaration

@property(nonatomic, readonly) NSDictionary<NSString *,id> *sourcePixelBufferAttributes;

Discussion

The property is required to provide a kCVPixelBufferPixelFormatTypeKey key in the dictionary, along with attributes for which the compositor needs specific values to work properly. Omitted attributes will be supplied by the composition engine to allow for the best performance. If the attribute kCVPixelBufferPixelFormatTypeKey key is not in the dictionary an exception will be raised. The value of the kCVPixelBufferPixelFormatTypeKey is an array of kCVPixelFormatType_* constants as defined in Pixel_Format_Types.

If the custom compositor is meant to be used with an AVVideoCompositionCoreAnimationTool created using the videoCompositionCoreAnimationToolWithAdditionalLayer:asTrackID: method, kCVPixelFormatType_32BGRA should be included as one of the supported pixel format types.

Missing attributes will be set by the composition engine to values allowing the best performance.

This property is queried once before any composition request is sent to the compositor. Changing source buffer attributes afterwards is not supported.

See Also

Pixel Buffer Attributes

requiredPixelBufferAttributesForRenderContext

The pixel buffer attributes required by the video compositor for new buffers created for processing.

Required.