Class VideoTourInstance

Controls the playback of a video tour, animating the camera according to a predefined timeline and synchronizing with associated audio/video media. Instances are typically created and managed by the Tour.svelte component.

Index

Constructors

Accessors

currentTime duration ended paused progress

Methods

destroy pause play read

Constructors

constructor

new VideoTourInstance(image: MicrioImage, data: VideoTour): VideoTourInstance
Creates a VideoTourInstance.
Parameters
- image: MicrioImage
  The parent MicrioImage instance.
- data: VideoTour
  The Models.ImageData.VideoTour data object.
Returns VideoTourInstance

Accessors

currentTime

get currentTime(): number
Getter for the current playback time in seconds.

Returns number
set currentTime(v: number): void
Setter for the current playback time (seeks to the corresponding progress).
Parameters
- v: number
Returns void

duration

get duration(): number
Getter for the total duration of the tour in seconds.

Returns number
set duration(v: number): void
Setter for the total duration (updates internal content).
Parameters
- v: number
Returns void

ended

get ended(): boolean
Getter indicating if the tour has ended.

Returns boolean

paused

get paused(): boolean
Getter for the current paused state.

Returns boolean

progress

get progress(): number
Getter for the current progress percentage (0-1).

Returns number
set progress(v: number): void
Setter for the current progress percentage (seeks to that point).
Parameters
- v: number
Returns void

Methods

destroy

destroy(): void
Cleans up the tour instance, stops animations, and re-hooks events if necessary.

Returns void

pause

pause(): void
Pauses the tour playback.

Returns void

play

play(): void
Starts or resumes tour playback.

Returns void

read

read(): void
Parses the raw timeline data from the tour content into the internal timeline array.

Returns void