Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

XRPlaybackState

Type Alias XRPlaybackState

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

The playback state of an XR sequence.

Type declaration

  • boomerang: boolean

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

    See

    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

    See

    RealityAPI.seekXRPlayback

  • currentPlaybackSpeed: number

    The fractional speed with which the sequence is played back currently

    Must be a value between 0 and 1

    See

    RealityAPI.setXRPlaybackSpeed

  • isPlaying: boolean

    Whether the sequence is playing or not

    See

See