AVVideoComposition.Configuration

renderSize

get renderSize(): { width: number; height: number }

var renderSize: CGSize { get set }

The size at which the video composition should render.

renderSize

set renderSize(value: { width: number; height: number })

var renderSize: CGSize { get set }

The size at which the video composition should render.

renderScale

get renderScale(): number

var renderScale: Float { get set }

The scale at which the video composition should render.

renderScale

set renderScale(value: number)

var renderScale: Float { get set }

The scale at which the video composition should render.

instructions

get instructions(): Array<SDKHandle>

var instructions: [any AVVideoCompositionInstructionProtocol] { get set }

The video composition instructions.

instructions

set instructions(value: Array<SDKHandle>)

var instructions: [any AVVideoCompositionInstructionProtocol] { get set }

The video composition instructions.

init

static initAnimationToolColorPrimariesColorTransferFunctionColorYCbCrMatrixCustomVideoCompositorClassFrameDurationInstructionsOutputBufferDescriptionPerFrameHDRDisplayMetadataPolicyRenderScaleRenderSizeSourceSampleDataTrackIDsSourceTrackIDForFrameTimingSpatialVideoConfigurations(animationTool?: (AVVideoCompositionCoreAnimationTool) | null, colorPrimaries?: (string) | null, colorTransferFunction?: (string) | null, colorYCbCrMatrix?: (string) | null, customVideoCompositorClass?: (string) | null, frameDuration?: _CoreMedia_CMTime, instructions?: Array<SDKHandle>, outputBufferDescription?: (Array<Array<_CoreMedia_CMTag>>) | null, perFrameHDRDisplayMetadataPolicy?: AVVideoComposition_PerFrameHDRDisplayMetadataPolicy, renderScale?: number, renderSize?: { width: number; height: number }, sourceSampleDataTrackIDs?: Array<number>, sourceTrackIDForFrameTiming?: number, spatialVideoConfigurations?: Array<AVSpatialVideoConfiguration>): AVVideoComposition_Configuration

init(animationTool: AVVideoCompositionCoreAnimationTool? = nil, colorPrimaries: String? = nil, colorTransferFunction: String? = nil, colorYCbCrMatrix: String? = nil, customVideoCompositorClass: (any AVVideoCompositing.Type)? = nil, frameDuration: CMTime = CMTime.zero, instructions: [any AVVideoCompositionInstructionProtocol] = [any AVVideoCompositionInstructionProtocol](), outputBufferDescription: [[CMTag]]? = nil, perFrameHDRDisplayMetadataPolicy: AVVideoComposition.PerFrameHDRDisplayMetadataPolicy = .propagate, renderScale: Float = 1.0, renderSize: CGSize = .zero, sourceSampleDataTrackIDs: [CMPersistentTrackID] = [CMPersistentTrackID](), sourceTrackIDForFrameTiming: Int32 = CMPersistentTrackID.zero, spatialVideoConfigurations: [AVSpatialVideoConfiguration] = [])

animationTool

get animationTool(): (AVVideoCompositionCoreAnimationTool) | null

var animationTool: AVVideoCompositionCoreAnimationTool? { get set }

A video composition tool to use with Core Animation in offline rendering.

animationTool

set animationTool(value: (AVVideoCompositionCoreAnimationTool) | null)

var animationTool: AVVideoCompositionCoreAnimationTool? { get set }

A video composition tool to use with Core Animation in offline rendering.

frameDuration

get frameDuration(): _CoreMedia_CMTime

var frameDuration: CMTime { get set }

A time interval for which the video composition should render composed video frames.

frameDuration

set frameDuration(value: _CoreMedia_CMTime)

var frameDuration: CMTime { get set }

A time interval for which the video composition should render composed video frames.

colorPrimaries

get colorPrimaries(): (string) | null

var colorPrimaries: String? { get set }

The color primaries used for video composition.

colorPrimaries

set colorPrimaries(value: (string) | null)

var colorPrimaries: String? { get set }

The color primaries used for video composition.

colorYCbCrMatrix

get colorYCbCrMatrix(): (string) | null

var colorYCbCrMatrix: String? { get set }

The YCbCr matrix used for video composition.

colorYCbCrMatrix

set colorYCbCrMatrix(value: (string) | null)

var colorYCbCrMatrix: String? { get set }

The YCbCr matrix used for video composition.

colorTransferFunction

get colorTransferFunction(): (string) | null

var colorTransferFunction: String? { get set }

The transfer function used for video composition.

colorTransferFunction

set colorTransferFunction(value: (string) | null)

var colorTransferFunction: String? { get set }

The transfer function used for video composition.

outputBufferDescription

get outputBufferDescription(): (Array<Array<_CoreMedia_CMTag>>) | null

var outputBufferDescription: [[CMTag]]? { get set }

The output buffers of the video composition can be specified with the outputBufferDescription. The value is an array of an array of CMTag objects that describes the output buffers. If the video composition will output tagged buffers, the details of those buffers should be specified with CMTags. Specifically, the StereoView (eyes) and ProjectionKind must be specified. The behavior is undefined if the output buffers do not match the outputBufferDescription. The default is nil, which means monoscopic output. Note that an empty array is not valid. Note that tagged buffers are only supported for custom compositors.

outputBufferDescription

set outputBufferDescription(value: (Array<Array<_CoreMedia_CMTag>>) | null)

var outputBufferDescription: [[CMTag]]? { get set }

The output buffers of the video composition can be specified with the outputBufferDescription. The value is an array of an array of CMTag objects that describes the output buffers. If the video composition will output tagged buffers, the details of those buffers should be specified with CMTags. Specifically, the StereoView (eyes) and ProjectionKind must be specified. The behavior is undefined if the output buffers do not match the outputBufferDescription. The default is nil, which means monoscopic output. Note that an empty array is not valid. Note that tagged buffers are only supported for custom compositors.

sourceSampleDataTrackIDs

get sourceSampleDataTrackIDs(): Array<number>

var sourceSampleDataTrackIDs: [CMPersistentTrackID] { get set }

The identifiers of source sample data tracks in the composition that the object requires to compose frames.

sourceSampleDataTrackIDs

set sourceSampleDataTrackIDs(value: Array<number>)

var sourceSampleDataTrackIDs: [CMPersistentTrackID] { get set }

The identifiers of source sample data tracks in the composition that the object requires to compose frames.

customVideoCompositorClass

get customVideoCompositorClass(): (string) | null

var customVideoCompositorClass: (any AVVideoCompositing.Type)? { get set }

A custom compositor class to use.

customVideoCompositorClass

set customVideoCompositorClass(value: (string) | null)

var customVideoCompositorClass: (any AVVideoCompositing.Type)? { get set }

A custom compositor class to use.

spatialVideoConfigurations

get spatialVideoConfigurations(): Array<AVSpatialVideoConfiguration>

var spatialVideoConfigurations: [AVSpatialVideoConfiguration] { get set }

Indicates the spatial configurations that are available to associate with the output of the video composition. A custom compositor can output spatial video by specifying one of these spatial configurations. A spatial configuration with all nil values indicates the video is not spatial. A nil spatial configuration also indicates the video is not spatial. The value can be nil, which indicates the output will not be spatial. NOTE: If this property is not empty, then the client must attach one of the spatial configurations in this array to all of the pixel buffers, otherwise an exception will be thrown.

spatialVideoConfigurations

set spatialVideoConfigurations(value: Array<AVSpatialVideoConfiguration>)

var spatialVideoConfigurations: [AVSpatialVideoConfiguration] { get set }

Indicates the spatial configurations that are available to associate with the output of the video composition. A custom compositor can output spatial video by specifying one of these spatial configurations. A spatial configuration with all nil values indicates the video is not spatial. A nil spatial configuration also indicates the video is not spatial. The value can be nil, which indicates the output will not be spatial. NOTE: If this property is not empty, then the client must attach one of the spatial configurations in this array to all of the pixel buffers, otherwise an exception will be thrown.

sourceTrackIDForFrameTiming

get sourceTrackIDForFrameTiming(): number

var sourceTrackIDForFrameTiming: CMPersistentTrackID { get set }

An identifier of the source track from which the video composition derives frame timing.

sourceTrackIDForFrameTiming

set sourceTrackIDForFrameTiming(value: number)

var sourceTrackIDForFrameTiming: CMPersistentTrackID { get set }

An identifier of the source track from which the video composition derives frame timing.

perFrameHDRDisplayMetadataPolicy

get perFrameHDRDisplayMetadataPolicy(): AVVideoComposition_PerFrameHDRDisplayMetadataPolicy

var perFrameHDRDisplayMetadataPolicy: AVVideoComposition.PerFrameHDRDisplayMetadataPolicy { get set }

The policy for display of HDR display metadata on the rendered frame.

perFrameHDRDisplayMetadataPolicy

set perFrameHDRDisplayMetadataPolicy(value: AVVideoComposition_PerFrameHDRDisplayMetadataPolicy)

var perFrameHDRDisplayMetadataPolicy: AVVideoComposition.PerFrameHDRDisplayMetadataPolicy { get set }

The policy for display of HDR display metadata on the rendered frame.

init

static initForPrototypeInstruction(asset: AVAsset, prototypeInstruction?: (AVVideoCompositionInstruction) | null): Promise<AVVideoComposition_Configuration>

nonisolated(nonsending) init(for asset: AVAsset, prototypeInstruction: AVVideoCompositionInstruction? = nil) async throws

Initializes a video composition configuration with the specified asset properties and optional prototype video composition instruction. - Parameter asset: asset to use with the video composition - Parameter prototypeInstruction: a video composition instruction to use as a prototype.