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.

XRImageSourceConfigPlayback

Type Alias XRImageSourceConfigPlayback

XRImageSourceConfigPlayback: {
    autoPlay?: boolean;
    endFrame?: number;
    speed?: number;
    startFrame?: number;
    type: PLAYBACK;
    url?: string;
}

Configuration for an XRImageSource that provides XRImages from an image source that can be played back.

Type declaration

  • OptionalautoPlay?: boolean

    Whether the playback should start pushing the XRImages automatically or not.

    Default

    false
  • OptionalendFrame?: number

    The index of the end frame of the playback.

    Default

    <totalFrames> - 1

    See

    XRPlaybackProperties

  • Optionalspeed?: number

    The speed of the playback relative of to the original FPS. Must be a value between 0 and 1.

    Default

    1.0
  • OptionalstartFrame?: number

    The index of the start frame of the playback.

    Default

    0
  • type: PLAYBACK

    The type of the XRImageSource.

  • Optionalurl?: string

    The URL of the image source.

    Default

    <HUB_URL>/repo/webvis/data/manifest.json

    See

    SettingStrings.HUB_URL