Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

constructor

Methods

close

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

    Returns void

get_leaveSettingsWhenStopped

  • get_leaveSettingsWhenStopped(): boolean

get_tour

nextSlide

  • nextSlide(): void

pauseTour

  • pauseTour(): void

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

playFromTourstop

  • playFromTourstop(stop: TourStop): void

set_leaveSettingsWhenStopped

  • set_leaveSettingsWhenStopped(v: boolean): boolean

set_tour

stop

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

    TODO: clarify how this differs from pauseTour.

    Parameters

    • ignored: boolean

    Returns void

Generated using TypeDoc