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