RealityFoundation · IOS API REFERENCE

VideoPlaybackController

class · iOS 14.0+ · SDK 27.1

@MainActor @preconcurrency class VideoPlaybackController

An object that controls the playback of video for a video material.

Members (8)

get · iOS 14.0+ · Deprecated in iOS 17.0

audioInputMode

TypeScript

get audioInputMode(): Promise<AudioResource_InputMode>

Swift declaration

@MainActor @preconcurrency var audioInputMode: AudioResource.InputMode { get set }

set · iOS 14.0+ · Deprecated in iOS 17.0

audioInputMode

TypeScript

setAudioInputMode(value: AudioResource_InputMode): Promise<void>

Swift declaration

@MainActor @preconcurrency var audioInputMode: AudioResource.InputMode { get set }

get · iOS 15.0+ · Deprecated in iOS 18.0

reverbSendLevel

TypeScript

get reverbSendLevel(): Promise<number>

Swift declaration

@MainActor @preconcurrency var reverbSendLevel: AudioPlaybackController.Decibel { get set }

set · iOS 15.0+ · Deprecated in iOS 18.0

reverbSendLevel

TypeScript

setReverbSendLevel(value: number): Promise<void>

Swift declaration

@MainActor @preconcurrency var reverbSendLevel: AudioPlaybackController.Decibel { get set }

get · iOS 18.0+

currentImageSize

TypeScript

get currentImageSize(): Promise<({ width: number; height: number }) | null>

Swift declaration

@MainActor @preconcurrency var currentImageSize: CGSize? { get }

What is the width and height of currently playing video (for stereo, the width and height of each eye)? This is optional because the video may not currently be playing, or the size is otherwise not available.

get · iOS 18.0+

currentViewingMode

TypeScript

get currentViewingMode(): Promise<(VideoPlaybackController_ViewingMode) | null>

Swift declaration

@MainActor @preconcurrency var currentViewingMode: VideoPlaybackController.ViewingMode? { get }

Is the currently playing video in mono or stereo? This is optional because the video may not currently be playing, or the mode is otherwise not available.

get · iOS 18.0+

preferredViewingMode

TypeScript

get preferredViewingMode(): Promise<VideoPlaybackController_ViewingMode>

Swift declaration

@MainActor @preconcurrency var preferredViewingMode: VideoPlaybackController.ViewingMode { get set }

Do we want to play stereo video in mono or stereo? Default is to play in stereo.

set · iOS 18.0+

preferredViewingMode

TypeScript

setPreferredViewingMode(value: VideoPlaybackController_ViewingMode): Promise<void>

Swift declaration

@MainActor @preconcurrency var preferredViewingMode: VideoPlaybackController.ViewingMode { get set }

Do we want to play stereo video in mono or stereo? Default is to play in stereo.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →