Rate this page:

PlayerEvents

Constants

PlaybackBuffering

Copy URL

Triggers when an audio file is playing faster than it is being loaded.

Parameters

  • player:

    Player

    Player that generated the event

PlaybackFinished

Copy URL

Triggers when playback has finished successfully or in case of playback error

Parameters

  • error:

    string

    Optional

    Error message

  • player:

    Player

    Player that generated the event

PlaybackMarkerReached

Copy URL

Triggers when Player.addMarker is reached

Parameters

  • offset:

    number

    The marker offset

  • player:

    Player

    Player that generated the event

PlaybackReady

Copy URL

Triggers by the createURLPlayer and createTTSPlayer methods when
1) the audio file download to the Voximpant cache is finished;
2) the audio file is found in the cache (i.e., it is in the cache before).

Parameters

  • player:

    Player

    Player that generated the event

Started

Copy URL

Triggers when playback is started. Note that if the createURLPlayer method is called with the onPause parameter that is set to true, the event is not triggered; it is triggered after the Player.resume method call.

Parameters

  • player:

    Player

    Player that generated the event

Stopped

Copy URL

Triggers as a result of the Player.stop method call.

Parameters

  • player:

    Player

    Player that generated the event