One Logo Pool Ball
AVFoundation · IOS API REFERENCE

AVAssetImageGenerator

class · iOS 4.0+ · SDK 27.1

class AVAssetImageGenerator

Members (23)

method · iOS 4.0+

cancelAllCGImageGeneration

TypeScript
cancelAllCGImageGeneration(): void
Swift declaration
func cancelAllCGImageGeneration()
method · iOS 4.0+ · Deprecated in iOS 18.0

copyCGImage

TypeScript
copyCGImage(requestedTime: _CoreMedia_CMTime, actualTime?: (SDKHandle) | null): _CoreGraphics_CGImage
Swift declaration
func copyCGImage(at requestedTime: CMTime, actualTime: UnsafeMutablePointer<CMTime>?) throws -> CGImage
method · iOS 16.0+

generateCGImageAsynchronously

TypeScript
generateCGImageAsynchronously(requestedTime: _CoreMedia_CMTime, handler: ((arg0: (_CoreGraphics_CGImage) | null, arg1: _CoreMedia_CMTime, arg2: (NativeError) | null) => void)): void
Swift declaration
func generateCGImageAsynchronously(for requestedTime: CMTime, completionHandler handler: @escaping @Sendable (CGImage?, CMTime, (any Error)?) -> Void)
method · iOS 4.0+

generateCGImagesAsynchronously

TypeScript
generateCGImagesAsynchronously(requestedTimes: Array<_Foundation_NSValue>, handler: ((arg0: _CoreMedia_CMTime, arg1: (_CoreGraphics_CGImage) | null, arg2: _CoreMedia_CMTime, arg3: AVAssetImageGenerator_Result, arg4: (NativeError) | null) => void)): void
Swift declaration
func generateCGImagesAsynchronously(forTimes requestedTimes: [NSValue], completionHandler handler: @escaping AVAssetImageGeneratorCompletionHandler)
init · iOS 4.0+

init

TypeScript
static init(asset: AVAsset): AVAssetImageGenerator
Swift declaration
init(asset: AVAsset)
get · iOS 4.0+

apertureMode

TypeScript
get apertureMode(): (AVAssetImageGenerator_ApertureMode) | null
Swift declaration
var apertureMode: AVAssetImageGenerator.ApertureMode? { get set }
set · iOS 4.0+

apertureMode

TypeScript
set apertureMode(value: (AVAssetImageGenerator_ApertureMode) | null)
Swift declaration
var apertureMode: AVAssetImageGenerator.ApertureMode? { get set }
get · iOS 4.0+

appliesPreferredTrackTransform

TypeScript
get appliesPreferredTrackTransform(): boolean
Swift declaration
var appliesPreferredTrackTransform: Bool { get set }
set · iOS 4.0+

appliesPreferredTrackTransform

TypeScript
set appliesPreferredTrackTransform(value: boolean)
Swift declaration
var appliesPreferredTrackTransform: Bool { get set }
get · iOS 6.0+

asset

TypeScript
get asset(): AVAsset
Swift declaration
var asset: AVAsset { get }
get · iOS 7.0+

customVideoCompositor

TypeScript
get customVideoCompositor(): (SDKHandle) | null
Swift declaration
var customVideoCompositor: (any AVVideoCompositing)? { get }
get · iOS 18.0+

dynamicRangePolicy

TypeScript
get dynamicRangePolicy(): AVAssetImageGenerator_DynamicRangePolicy
Swift declaration
var dynamicRangePolicy: AVAssetImageGenerator.DynamicRangePolicy { get set }
set · iOS 18.0+

dynamicRangePolicy

TypeScript
set dynamicRangePolicy(value: AVAssetImageGenerator_DynamicRangePolicy)
Swift declaration
var dynamicRangePolicy: AVAssetImageGenerator.DynamicRangePolicy { get set }
get · iOS 4.0+

maximumSize

TypeScript
get maximumSize(): { width: number; height: number }
Swift declaration
var maximumSize: CGSize { get set }
set · iOS 4.0+

maximumSize

TypeScript
set maximumSize(value: { width: number; height: number })
Swift declaration
var maximumSize: CGSize { get set }
get · iOS 5.0+

requestedTimeToleranceAfter

TypeScript
get requestedTimeToleranceAfter(): _CoreMedia_CMTime
Swift declaration
var requestedTimeToleranceAfter: CMTime { get set }
set · iOS 5.0+

requestedTimeToleranceAfter

TypeScript
set requestedTimeToleranceAfter(value: _CoreMedia_CMTime)
Swift declaration
var requestedTimeToleranceAfter: CMTime { get set }
get · iOS 5.0+

requestedTimeToleranceBefore

TypeScript
get requestedTimeToleranceBefore(): _CoreMedia_CMTime
Swift declaration
var requestedTimeToleranceBefore: CMTime { get set }
set · iOS 5.0+

requestedTimeToleranceBefore

TypeScript
set requestedTimeToleranceBefore(value: _CoreMedia_CMTime)
Swift declaration
var requestedTimeToleranceBefore: CMTime { get set }
get · iOS 4.0+

videoComposition

TypeScript
get videoComposition(): (AVVideoComposition) | null
Swift declaration
@NSCopying var videoComposition: AVVideoComposition? { get set }
set · iOS 4.0+

videoComposition

TypeScript
set videoComposition(value: (AVVideoComposition) | null)
Swift declaration
@NSCopying var videoComposition: AVVideoComposition? { get set }
method · iOS 16.0+

image

TypeScript
image(time: _CoreMedia_CMTime): Promise<{ "image": _CoreGraphics_CGImage; "actualTime": _CoreMedia_CMTime }>
Swift declaration
func image(at time: CMTime) async throws -> (image: CGImage, actualTime: CMTime)

Creates an image object for an asset at or near specified the time. - Parameter time: The time at which the image of the asset is to be created. - Returns: A tuple containing the image object as a CGImage, and the time at which the image was actually generated as a CMTime.

method · iOS 16.0+

images

TypeScript
images(times: Array<_CoreMedia_CMTime>): AVAssetImageGenerator_Images
Swift declaration
func images(for times: [CMTime]) -> sending AVAssetImageGenerator.Images

Creates a series of image objects for an asset at or near specified times. - Parameter times: An array of times at which the images of the asset are to be created. - Returns: The generated images or errors for each time, as an asynchronous sequence of Results.

Skipped declarations

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

AVAssetImageGenerator.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All AVFoundation types →