ImmersiveMediaSupport · IOS API REFERENCE

SetCameraCommand

struct · iOS 26.4+ · SDK 27.1

struct SetCameraCommand

A command type for immersive camera switching during playback. Use the property `cameraID` to hold the camera identifier string, to enable switching from one immersive camera to another.

Members (13)

init · iOS 27.0+

init

TypeScript

static initIdTimeCameraIDOverrides(id: number, time: _CoreMedia_CMTime, cameraID: string, overrides?: (SetCameraCommand_Overrides) | null): SetCameraCommand

Swift declaration

init(id: Int, time: CMTime, cameraID: String, overrides: SetCameraCommand.Overrides?)

Creates a command with a specific ID, cameraID, start time and override parameters. - Parameters: - id: The unique ID of this command. - time: The time for this command to start during playback. - cameraID: The `cameraID` associated with this command. - overrides: The override parameters for the camera

init · iOS 26.4+

init

TypeScript

static initIdTimeCameraID(id: number, time: _CoreMedia_CMTime, cameraID: string): SetCameraCommand

Swift declaration

init(id: Int, time: CMTime, cameraID: String)

Creates a command with a specific ID, cameraID and start time. - Parameters: - id: The unique ID of this command. - time: The time for this command to start during playback. - cameraID: The `cameraID` associated with this command.

get · iOS 26.4+

id

TypeScript

get id(): number

Swift declaration

var id: Int { get }

A unique command ID for the entire immersive media file.

get · iOS 26.4+

time

TypeScript

get time(): _CoreMedia_CMTime

Swift declaration

var time: CMTime

The time this command starts during playback.

set · iOS 26.4+

time

TypeScript

set time(value: _CoreMedia_CMTime)

Swift declaration

var time: CMTime

The time this command starts during playback.

get · iOS 26.4+

offset

TypeScript

get offset(): (_CoreMedia_CMTime) | null

Swift declaration

var offset: CMTime?

Reserved for later use.

set · iOS 26.4+

offset

TypeScript

set offset(value: (_CoreMedia_CMTime) | null)

Swift declaration

var offset: CMTime?

Reserved for later use.

get · iOS 26.4+

cameraID

TypeScript

get cameraID(): string

Swift declaration

var cameraID: String

The camera ID to use for the duration of this command.

set · iOS 26.4+

cameraID

TypeScript

set cameraID(value: string)

Swift declaration

var cameraID: String

The camera ID to use for the duration of this command.

get · iOS 26.4+

duration

TypeScript

get duration(): _CoreMedia_CMTime

Swift declaration

var duration: CMTime

The duration of the command.

set · iOS 26.4+

duration

TypeScript

set duration(value: _CoreMedia_CMTime)

Swift declaration

var duration: CMTime

The duration of the command.

get · iOS 27.0+

overrides

TypeScript

get overrides(): (SetCameraCommand_Overrides) | null

Swift declaration

var overrides: SetCameraCommand.Overrides?

The override parameters for the camera.

set · iOS 27.0+

overrides

TypeScript

set overrides(value: (SetCameraCommand_Overrides) | null)

Swift declaration

var overrides: SetCameraCommand.Overrides?

The override parameters for the camera.

Skipped declarations

No declarations were skipped in this snapshot.

All ImmersiveMediaSupport types →