Control handle returned by playCameraTour. Callers keep this around as long as they want playback running — call CameraTourPlayback.destroy to release the tick subscription.

interface CameraTourPlayback {
    currentWaypointIndex: number;
    playing: boolean;
    tour: CameraTour;
    destroy(): void;
    pause(): void;
    play(): void;
    seek(waypointIndex: number): void;
    stop(): void;
}

Properties

currentWaypointIndex: number

Index of the most-recently-arrived-at waypoint. While the camera is in transit from i to i + 1, this still reads i — it flips to i + 1 when the transit completes and the destination dwell begins.

playing: boolean

true if currently advancing time.

The tour being played. Same instance passed to playCameraTour.

Methods