ImmersiveMediaSupport · IOS API REFERENCE

VenueDescriptor

class · iOS 26.4+ · SDK 27.1

final actor VenueDescriptor

The Apple Immersive Media Venue Descriptor is a collection of static metadata necessary for every Apple Immersive Video. This type contains information that includes camera definitions such as the lens calibration information, as well as data necessary for the rendering of the video frames.

Members (4)

get · iOS 26.4+

unownedExecutor

TypeScript

get unownedExecutor(): SDKHandle

Swift declaration

nonisolated final var unownedExecutor: UnownedSerialExecutor { get }

Retrieve the executor for this actor as an optimized, unowned reference. This property must always evaluate to the same executor for a given actor instance, and holding on to the actor must keep the executor alive. This property will be implicitly accessed when work needs to be scheduled onto this actor. These accesses may be merged, eliminated, and rearranged with other work, and they may even be introduced when not strictly required. Visible side effects are therefore strongly discouraged within this property. - SeeAlso: ``SerialExecutor`` - SeeAlso: ``TaskExecutor``

init · iOS 26.4+

init

TypeScript

static initDevice(device?: (SDKHandle) | null): VenueDescriptor

Swift declaration

init(device: (any MTLDevice)? = nil)

Creates an empty venue descriptor instance.

init · iOS 26.4+

init

TypeScript

static initAimeURLDevice(aimeURL: string, device?: (SDKHandle) | null): Promise<VenueDescriptor>

Swift declaration

convenience init(aimeURL: URL, device: (any MTLDevice)? = nil) async throws

Creates a venue descriptor instance from an AIME file. - Parameters: - aimeURL: A URL that points to a valid AIME file to load. - device: The Metal device to use when loading calibration meshes into memory. - Throws: This function throws exceptions if the input file doesn't exist, or contains invalid information.

init · iOS 26.4+

init

TypeScript

static initAimeDataDevice(aimeData: ArrayBuffer, device?: (SDKHandle) | null): Promise<VenueDescriptor>

Swift declaration

init(aimeData: Data, device: (any MTLDevice)? = nil) async throws

Creates a venue descriptor instance from memory. - Parameters: - aimeData: The Data that contains the venue descriptor to parse. - device: The Metal device to use when loading calibration meshes into memory.

Skipped declarations

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

VenueDescriptor.cameras

The iOS SDK compiler rejected this binding: actor-isolated property 'cameras' can not be referenced from a nonisolated context

VenueDescriptor.addCamera(_:)

The iOS SDK compiler rejected this binding: call to actor-isolated instance method 'addCamera' in a synchronous nonisolated context [#ActorIsolatedCall]

VenueDescriptor.removeCamera(id:)

The iOS SDK compiler rejected this binding: call to actor-isolated instance method 'removeCamera(id:)' in a synchronous nonisolated context [#ActorIsolatedCall]

VenueDescriptor.cameraViewModel(for:)

The iOS SDK compiler rejected this binding: call to actor-isolated instance method 'cameraViewModel(for:)' in a synchronous nonisolated context [#ActorIsolatedCall]

VenueDescriptor.save(to:)

The iOS SDK compiler rejected this binding: call to actor-isolated instance method 'save(to:)' in a synchronous nonisolated context [#ActorIsolatedCall]

All ImmersiveMediaSupport types →