One Logo Pool Ball
AVFoundation · IOS API REFERENCE

AVAssetWriterInput.CaptionReceiver

class · iOS 26.0+ · SDK 27.1

class CaptionReceiver

Provides an interface for writing caption data to an input.

Members (5)

method · iOS 26.0+

appendImmediately

TypeScript
appendImmediately(captionGroup: AVCaptionGroup): boolean
Swift declaration
func appendImmediately(_ captionGroup: AVCaptionGroup) throws -> Bool

Appends the caption group synchronously if the input is ready for more media data. - Parameter captionGroup: The caption group to be appended. - Returns: Returns true if the append was successful, false if the input was not ready for more media data. - Throws: An error if the underlying writer failed.

method · iOS 26.0+

appendImmediately

TypeScript
appendImmediately11268(caption: AVCaption): boolean
Swift declaration
func appendImmediately(_ caption: AVCaption) throws -> Bool

Appends the caption synchronously if the input is ready for more media data. - Parameter caption: The caption to be appended. - Returns: Returns true if the append was successful, false if the input was not ready for more media data. - Throws: An error if the underlying writer failed.

method · iOS 26.0+

append

TypeScript
append(captionGroup: AVCaptionGroup): Promise<void>
Swift declaration
nonisolated(nonsending) func append(_ captionGroup: AVCaptionGroup) async throws

Suspends until the input is ready for more media data, then appends the caption group. - Parameter captionGroup: The caption group to be appended. - Throws: An error if the underlying writer failed.

method · iOS 26.0+

append

TypeScript
append66766(caption: AVCaption): Promise<void>
Swift declaration
nonisolated(nonsending) func append(_ caption: AVCaption) async throws

Suspends until the input is ready for more media data, then appends the caption. - Parameter caption: The caption to be appended. - Throws: An error if the underlying writer failed.

method · iOS 26.0+

finish

TypeScript
finish(): void
Swift declaration
func finish()

Indicates to the AVAssetWriter that no more buffers will be appended to this receiver.

Skipped declarations

No declarations were skipped in this snapshot.

All AVFoundation types →