AVVideoComposition

sourceSampleDataTrackIDs

get sourceSampleDataTrackIDs(): Array<number>

@objc(_sourceSampleDataTrackIDs) dynamic var sourceSampleDataTrackIDs: [CMPersistentTrackID] { get }

init

static initAssetApplyingCIFiltersWithHandler(asset: AVAsset, applier: ((arg0: AVAsynchronousCIImageFilteringRequest) => void)): AVVideoComposition

init(asset: AVAsset, applyingCIFiltersWithHandler applier: @escaping @Sendable (AVAsynchronousCIImageFilteringRequest) -> Void)

videoComposition

static videoCompositionWithApplyingCIFiltersWithHandlerCompletionHandler(asset: AVAsset, applier: ((arg0: AVAsynchronousCIImageFilteringRequest) => void), completionHandler: ((arg0: (AVVideoComposition) | null, arg1: (NativeError) | null) => void)): void

class func videoComposition(with asset: AVAsset, applyingCIFiltersWithHandler applier: @escaping @Sendable (AVAsynchronousCIImageFilteringRequest) -> Void) async throws -> AVVideoComposition

init

static initPropertiesOf(asset: AVAsset): AVVideoComposition

init(propertiesOf asset: AVAsset)

videoComposition

static videoCompositionWithPropertiesOfCompletionHandler(asset: AVAsset, completionHandler: ((arg0: (AVVideoComposition) | null, arg1: (NativeError) | null) => void)): void

class func videoComposition(withPropertiesOf asset: AVAsset) async throws -> AVVideoComposition

determineValidity

determineValidity(asset: (AVAsset) | null, timeRange: _CoreMedia_CMTimeRange, validationDelegate: (Implements<AVVideoCompositionValidationHandling> | SDKHandle) | null, completionHandler: ((arg0: boolean, arg1: (NativeError) | null) => void)): void

func isValid(for asset: AVAsset?, timeRange: CMTimeRange, validationDelegate: (any AVVideoCompositionValidationHandling)?) async throws -> Bool

isValid

isValidForTimeRangeValidationDelegate(asset: (AVAsset) | null, timeRange: _CoreMedia_CMTimeRange, validationDelegate?: (Implements<AVVideoCompositionValidationHandling> | SDKHandle) | null): boolean

func isValid(for asset: AVAsset?, timeRange: CMTimeRange, validationDelegate: (any AVVideoCompositionValidationHandling)?) -> Bool

isValid

isValidForAssetDurationTimeRangeValidationDelegate(tracks: Array<AVAssetTrack>, duration: _CoreMedia_CMTime, timeRange: _CoreMedia_CMTimeRange, validationDelegate?: (Implements<AVVideoCompositionValidationHandling> | SDKHandle) | null): boolean

func isValid(for tracks: [AVAssetTrack], assetDuration duration: CMTime, timeRange: CMTimeRange, validationDelegate: (any AVVideoCompositionValidationHandling)?) -> Bool

animationTool

get animationTool(): (AVVideoCompositionCoreAnimationTool) | null

var animationTool: AVVideoCompositionCoreAnimationTool? { get }

colorPrimaries

get colorPrimaries(): (string) | null

var colorPrimaries: String? { get }

colorTransferFunction

get colorTransferFunction(): (string) | null

var colorTransferFunction: String? { get }

colorYCbCrMatrix

get colorYCbCrMatrix(): (string) | null

var colorYCbCrMatrix: String? { get }

customVideoCompositorClass

get customVideoCompositorClass(): (string) | null

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

frameDuration

get frameDuration(): _CoreMedia_CMTime

var frameDuration: CMTime { get }

instructions

get instructions(): Array<SDKHandle>

var instructions: [any AVVideoCompositionInstructionProtocol] { get }

perFrameHDRDisplayMetadataPolicy

get perFrameHDRDisplayMetadataPolicy(): AVVideoComposition_PerFrameHDRDisplayMetadataPolicy

var perFrameHDRDisplayMetadataPolicy: AVVideoComposition.PerFrameHDRDisplayMetadataPolicy { get }

renderScale

get renderScale(): number

var renderScale: Float { get }

renderSize

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

var renderSize: CGSize { get }

sourceTrackIDForFrameTiming

get sourceTrackIDForFrameTiming(): number

var sourceTrackIDForFrameTiming: CMPersistentTrackID { get }

init

static initConfiguration(configuration: AVVideoComposition_Configuration): AVVideoComposition

convenience init(configuration: AVVideoComposition.Configuration)

Initialize an AVVideoComposition with a configuration. - Parameter configuration: contains the property values for a new AVVideoComposition.

init

static initApplyingFiltersToApplier(asset: AVAsset, applier: ((arg0: AVCIImageFilteringParameters) => Promise<AVCIImageFilteringResult>)): Promise<AVVideoComposition>

nonisolated(nonsending) convenience init(applyingFiltersTo asset: AVAsset, applier: @escaping @Sendable (AVCIImageFilteringParameters) async throws -> AVCIImageFilteringResult) async throws

Creates a video composition configured to apply Core Image filters to each video frame of the specified asset. - Parameter asset: The asset whose configuration matches the intended use of the video composition. - Parameter applier: A closure that AVFoundation calls when processing each video frame. - Returns: A new AVVideoComposition instance configured for Core Image filtering.

outputBufferDescription

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

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

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.

spatialVideoConfigurations

get spatialVideoConfigurations(): Array<AVSpatialVideoConfiguration>

var spatialVideoConfigurations: [AVSpatialVideoConfiguration] { get }

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.