Interface TemporalPlaybackExperimental

Playback controller returned by createTemporalPlayback.

interface TemporalPlayback {
    extent: TemporalWindow;
    playing: boolean;
    speed: number;
    stepMs: number;
    window: TemporalWindow;
    dispose(): void;
    on(type: "tick", listener: ((event: TemporalPlaybackTick) => void)): TemporalPlaybackSubscription;
    on(type: "end" | "play" | "pause", listener: (() => void)): TemporalPlaybackSubscription;
    on(type: "error", listener: ((error: unknown) => void)): TemporalPlaybackSubscription;
    pause(): void;
    play(): void;
    scrub(time: TemporalInstant): void;
    setSpeed(multiplier: number): void;
    setWindow(windowMs: number): void;
    step(direction?: 1 | -1): void;
}

Properties

extent playing speed stepMs window

Methods

dispose on pause play scrub setSpeed setWindow step

Properties

Readonly Experimentalextent

extent: TemporalWindow

The normalized extent (epoch ms).

Readonly Experimentalplaying

playing: boolean

Readonly Experimentalspeed

speed: number

Current playback rate multiplier. See TemporalPlaybackOptions.speed.

Readonly ExperimentalstepMs

stepMs: number

How far the window advances per frame, in milliseconds.

Readonly Experimentalwindow

window: TemporalWindow

The current window (epoch ms, half-open).

Methods

dispose

on

pause

play

scrub

setSpeed

  • setSpeed(multiplier): void
  • Experimental

    Change the playback rate multiplier. While playing, the frame timer is restarted at the new cadence without re-emitting "play" or re-applying the current window; while paused, the next play() uses the new rate.

    Parameters

    • multiplier: number

    Returns void

setWindow

step

Settings

Member Visibility

On This Page

Properties
Methods