Class TourPlayer

An object that manages the playback of a tour.

Each TourPlayer may be associated with an underlying TourDocument, which defines the tour in question. It may be accessed using the get_tour method.

Hierarchy

TourPlayer

Implements

UiController

Index

Constructors

Methods

close get_leaveSettingsWhenStopped get_tour nextSlide pauseTour play playFromTourstop set_leaveSettingsWhenStopped set_tour stop

Constructors

constructor

new TourPlayer(): TourPlayer
Returns TourPlayer

Methods

close

close(): void
Stop playing the current tour, if needed, and clear the current tour document.

Returns void
- Defined in engine/src/index.d.ts:2091

get_leaveSettingsWhenStopped

get_leaveSettingsWhenStopped(): boolean
Get whether this player will leave slide Settings applied when it stops.

Returns boolean
- Defined in engine/src/index.d.ts:2065

get_tour

get_tour(): null | TourDocument
Get the tour associated with this tour player, if there is one.

Returns null | TourDocument
- Defined in engine/src/index.d.ts:2059

nextSlide

nextSlide(): void
Force the currently playing tour to advance to the next slide.

Returns void
- Defined in engine/src/index.d.ts:2071

pauseTour

pauseTour(): void
Toggle the playback state of the current tour, to or from paused.

Returns void
- Defined in engine/src/index.d.ts:2094

play

play(): void
Start or resume playing the current tour.

TODO: clarify semantics about where we start from. Beginning of the current slide, I think?

Returns void
- Defined in engine/src/index.d.ts:2078

playFromTourstop

playFromTourstop(stop): void
Start playing the current tour from the beginning of the specified stop.
Parameters
- stop: TourStop
Returns void
- Defined in engine/src/index.d.ts:2082

set_leaveSettingsWhenStopped

set_leaveSettingsWhenStopped(v): boolean
Set whether this player will leave slide Settings applied when it stops.
Parameters
- v: boolean
Returns boolean
- Defined in engine/src/index.d.ts:2068

set_tour

set_tour(tour): null | TourDocument
Set the tour associated with this tour player.
Parameters
- tour: null | TourDocument
Returns null | TourDocument
- Defined in engine/src/index.d.ts:2062

stop

stop(ignored): void
Stop playing the current tour.

TODO: clarify how this differs from pauseTour.
Parameters
- ignored: boolean
Returns void
- Defined in engine/src/index.d.ts:2088

Generated using TypeDoc