FadeCommand

struct · iOS 26.4+ · SDK 27.1

struct FadeCommand

A command type for color fading during immersive media playback. You use a color fade to either fade into the video frame from a requested color, or fade out of the video frame to a requested color. The fade commands are usually used for fading in at the start of the playback and fading out at the end of the playback. These commands are also used during immersive camera view switches during the playback. Fade commands can be absolute time-based or offset-based. If absolute time-based, then `time` dictates the time it needs to start executing and keep fading until the `duration` property value. On the other hand if they are offset based, then the `offset` dictates the fade percentage from the start `time` of the fade command until the `duration` of the fade. If the fade has to start at time `0.0` second of the playback for duration of `1.0` seconds and if the media FPS is `90`, then first frame is accompanied with presentation metadata that has fade command with `0.011` as offset, the second frame has fade command with offset of `0.022`, and so on; the 90th frame has an offset of `1.0`.

Members (12)

static init(id: number, time: _CoreMedia_CMTime, duration: _CoreMedia_CMTime, direction: FadeCommand_FadeDirection, color: SDKHandle, offset?: (_CoreMedia_CMTime) | null): FadeCommand

init(id: Int, time: CMTime, duration: CMTime, direction: FadeCommand.FadeDirection, color: simd_float3, offset: CMTime? = nil)

get id(): number

var id: Int { get }

get time(): _CoreMedia_CMTime

var time: CMTime

set time(value: _CoreMedia_CMTime)

var time: CMTime

get color(): SDKHandle

var color: simd_float3

set color(value: SDKHandle)

var color: simd_float3

get offset(): (_CoreMedia_CMTime) | null

var offset: CMTime?

set offset(value: (_CoreMedia_CMTime) | null)

var offset: CMTime?

get duration(): _CoreMedia_CMTime

var duration: CMTime

set duration(value: _CoreMedia_CMTime)

var duration: CMTime

get direction(): FadeCommand_FadeDirection

var direction: FadeCommand.FadeDirection

set direction(value: FadeCommand_FadeDirection)

var direction: FadeCommand.FadeDirection

All ImmersiveMediaSupport types →