Instance Property

customVideoCompositor

Returns the custom video compositor instance used, if any.

Declaration

var customVideoCompositor: AVVideoCompositing? { get }

Discussion

The custom video compositor instance that is used during image generation is accessible via this property after the value of videoComposition is set to an AVVideoComposition instance that specifies a custom video compositor class. Any additional communication between the application and that instance of the custom video compositor, if any is required for configuration or other purposes, can only occur once that has happened.

If the value of videoComposition is changed from an AVVideoComposition that specifies a custom video compositor class to another instance of AVVideoComposition that specifies the same custom video compositor class, the instance of the custom video compositor that was previously created will receive the renderContextChanged(_:) message and remain in use for subsequent image generation.

This property is nil if there is no video compositor, or if the internal video compositor is in use.

See Also

Configuring Image-Generation Behavior

var apertureMode: AVAssetImageGenerator.ApertureMode?

Specifies the aperture mode for the generated image.

struct AVAssetImageGenerator.ApertureMode

The aperture modes used when generating images.

var appliesPreferredTrackTransform: Bool

Specifies whether to apply the track matrix, or matrices. when extracting an image from the asset.

var asset: AVAsset

The asset that initialized the image generator.

var maximumSize: CGSize

Specifies the maximum dimensions for the generated image.

var videoComposition: AVVideoComposition?

The video composition to use when extracting images from assets with multiple video tracks.

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