KmlTourController QML Type

  • Esri.ArcGISRuntime
  • KmlTourController
  • Used to play, pause, or reset a KML tour. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.6





    Detailed Description

    A KML tour may contain audio. KmlTourController manages all audio internally and plays the audio along with the tour.

    Property Documentation

    [read-only] currentPosition : double

    Returns the current position of the KML tour, in seconds (read-only).

    [read-only] totalDuration : double

    Returns the total duration of the KML tour, in seconds (read-only).

    tour : KmlTour

    Returns the KmlTour object that the controller is managing.

    Note: you may set null to manage no KML tour.

    Signal Documentation


    Emitted when the currentPosition property changes.

    Note: The corresponding handler is onCurrentPositionChanged.


    Emitted when the totalDuration property changes.

    Note: The corresponding handler is onTotalDurationChanged.


    Emitted when the tour property changes.

    Note: The corresponding handler is onTourChanged.

    Method Documentation

    void pause()

    Pauses the associated tour.

    Any associated audio content will also be paused.

    void play()

    Plays the associated tour, which may include audio content.

    If the tour is in the paused state, playing will resume where the tour was left off.

    void reset()

    Resets the associated tour.

    Use this to reset the tour to the beginning, which includes resetting any KML content to its original state before the tour was played.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.