One Logo Pool Ball
AVFoundation · IOS API REFERENCE

AVAsynchronousVideoCompositionRequest

class · iOS 7.0+ · SDK 27.1

class AVAsynchronousVideoCompositionRequest

Members (17)

method · iOS 7.0+

finishCancelledRequest

TypeScript
finishCancelledRequest(): void
Swift declaration
func finishCancelledRequest()
method · iOS 7.0+ · Deprecated in iOS 27.0

finish

TypeScript
finishWithComposedVideoFrame(composedVideoFrame: _CoreVideo_CVBuffer): void
Swift declaration
func finish(withComposedVideoFrame composedVideoFrame: CVPixelBuffer)
method · iOS 7.0+

finish

TypeScript
finishWith(error: NativeError): void
Swift declaration
func finish(with error: any Error)
init

init

TypeScript
static init(): AVAsynchronousVideoCompositionRequest
Swift declaration
init()
method · iOS 7.0+ · Deprecated in iOS 27.0

sourceFrame

TypeScript
sourceFrame(trackID: number): (_CoreVideo_CVBuffer) | null
Swift declaration
func sourceFrame(byTrackID trackID: CMPersistentTrackID) -> CVPixelBuffer?
method · iOS 7.0+ · Deprecated in iOS 27.0

sourceSampleBuffer

TypeScript
sourceSampleBuffer(trackID: number): (_CoreMedia_CMSampleBuffer) | null
Swift declaration
func sourceSampleBuffer(byTrackID trackID: CMPersistentTrackID) -> CMSampleBuffer?
method · iOS 15.0+

sourceTimedMetadata

TypeScript
sourceTimedMetadata(trackID: number): (AVTimedMetadataGroup) | null
Swift declaration
func sourceTimedMetadata(byTrackID trackID: CMPersistentTrackID) -> AVTimedMetadataGroup?
get · iOS 7.0+

compositionTime

TypeScript
get compositionTime(): _CoreMedia_CMTime
Swift declaration
var compositionTime: CMTime { get }
get · iOS 7.0+

renderContext

TypeScript
get renderContext(): AVVideoCompositionRenderContext
Swift declaration
var renderContext: AVVideoCompositionRenderContext { get }
get · iOS 7.0+

sourceTrackIDs

TypeScript
get sourceTrackIDs(): Array<_Foundation_NSNumber>
Swift declaration
var sourceTrackIDs: [NSNumber] { get }
get · iOS 7.0+

videoCompositionInstruction

TypeScript
get videoCompositionInstruction(): SDKHandle
Swift declaration
var videoCompositionInstruction: any AVVideoCompositionInstructionProtocol { get }
method · iOS 26.0+

sourceReadySampleBuffer

TypeScript
sourceReadySampleBuffer(trackID: number): (_CoreMedia_CMReadySampleBuffer<_CoreMedia_CMSampleBuffer_DynamicContent>) | null
Swift declaration
func sourceReadySampleBuffer(byTrackID trackID: CMPersistentTrackID) -> CMReadySampleBuffer<CMSampleBuffer.DynamicContent>?

Returns the source CMReadySampleBuffer for the given track ID. - Parameter trackID: The track ID for the requested source frame. - Returns: the source CMReadySampleBuffer for the given track ID.

get · iOS 15.0+

sourceSampleDataTrackIDs

TypeScript
get sourceSampleDataTrackIDs(): Array<number>
Swift declaration
@nonobjc var sourceSampleDataTrackIDs: [CMPersistentTrackID] { get }
method · iOS 26.0+

sourceReadOnlyPixelBuffer

TypeScript
sourceReadOnlyPixelBuffer(trackID: number): (_CoreVideo_CVReadOnlyPixelBuffer) | null
Swift declaration
func sourceReadOnlyPixelBuffer(byTrackID trackID: CMPersistentTrackID) -> CVReadOnlyPixelBuffer?

Returns the source CVReadOnlyPixelBuffer for the given track ID. If the track contains tagged buffers, a pixel buffer from one of the tagged buffers will be returned. - Parameter trackID: The track ID for the requested source frame. - Returns: the source CVReadOnlyPixelBuffer for the given track ID.

method · iOS 26.0+

sourceTaggedDynamicBuffers

TypeScript
sourceTaggedDynamicBuffers(trackID: number): (Array<_CoreMedia_CMTaggedDynamicBuffer>) | null
Swift declaration
func sourceTaggedDynamicBuffers(byTrackID trackID: CMPersistentTrackID) -> [CMTaggedDynamicBuffer]?

Returns the source tagged dynamic buffers for the given track ID. Returns nil if the video track does not contain tagged buffers, or if the track does not contain video. This function should only be called when supportsSourceTaggedBuffers is YES. - Parameter byTrackID: The track ID for the requested source tagged dynamic buffers. - Returns: the source CMTaggedBuffer array for the given track ID.

method · iOS 26.0+

finish

TypeScript
finishWithComposedPixelBuffer(readOnlyPixelBuffer: _CoreVideo_CVReadOnlyPixelBuffer): void
Swift declaration
func finish(withComposedPixelBuffer readOnlyPixelBuffer: CVReadOnlyPixelBuffer)

The method that the custom compositor calls when composition succeeds. - Parameter composedPixelBuffer: The video frame to finish with. Call finishWithComposedTaggedBufferGroup: instead if outputBufferDescription is non-nil.

method · iOS 26.0+

finish

TypeScript
finishWithComposedTaggedBuffers(taggedBuffers: Array<_CoreMedia_CMTaggedDynamicBuffer>): void
Swift declaration
func finish(withComposedTaggedBuffers taggedBuffers: [CMTaggedDynamicBuffer])

The method that the custom compositor calls when composition succeeds. - Parameter taggedBuffers: The tagged buffers containing the composed tagged buffers. The tagged buffers must be compatible with the outputBufferDescription specified in the video composition. The outputBufferDescription must not be nil when calling this function. NOTE: If ``AVVideoComposition/spatialConfigurations`` is not empty, then ``attach(spatialVideoConfiguration:to:)`` must be called with one of the spatial configurations. An exception will be thrown otherwise. Also, all pixel buffers must be associated with the same spatial configuration. An exception will be thrown otherwise.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

AVAsynchronousVideoCompositionRequest.attach(_:to:)

The iOS SDK compiler rejected this binding: instance method 'arg' requires that 'CVMutablePixelBuffer' conform to 'Copyable'

All AVFoundation types →