XRPlaybackState

Interface XRPlaybackState

The playback state of an XR sequence.

interface XRPlaybackState {
    boomerang: boolean;
    bufferHeadFrame: number;
    currentFrame: number;
    currentPlaybackSpeed: number;
    isPlaying: boolean;
}
Index

Properties

boomerang bufferHeadFrame currentFrame currentPlaybackSpeed isPlaying

Properties

boomerang: boolean

Whether the playback does "boomerang" (play forward and backward) or not

RealityAPI.setXRPlaybackBoomerang

bufferHeadFrame: number

The current frame up to which the playback has been buffered. If the replayed sequence is small enough (i.e. contains max. 64 frames), this value will be fixed to the last frame of the sequence.

currentFrame: number

The current frame at which the playback is currently

RealityAPI.seekXRPlayback

currentPlaybackSpeed: number

The fractional speed with which the sequence is played back currently

Must be a value between 0 and 1

RealityAPI.setXRPlaybackSpeed

isPlaying: boolean

Whether the sequence is playing or not