For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Platform docsVideosCommunitySign up
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
      • Overview
        • Player
        • PlayerEvents
        • StreamingAgent
        • StreamingAgentEvents
        • SequencePlayer
        • SequencePlayerEvents
        • Recorder
        • RecorderDirection
        • RecorderEvents
        • RecorderLabelFont
        • RecorderLabelPosition
        • RecorderLabelTextAlign
        • RecorderLayout
        • RecorderObjectFit
        • RecorderProfile
        • RecordExpireTime
        • URLPlayerRequestMethod
  • Management API
    • Reference
    • Authorization
    • Errors
  • Web SDK
    • Overview
  • Android SDK
    • Overview
  • Android SDK v3
    • Overview
  • iOS SDK
    • Overview
  • React Native SDK
    • Overview
  • Flutter SDK
    • Overview
LogoLogo
Platform docsVideosCommunitySign up
On this page
  • Values
VoxEngineMedia playback and recording

PlayerEvents

9 values
||View as Markdown|
Was this page helpful?
Edit this page
Previous

Player

Next

StreamingAgent

Built with

Values

Created
'Player.Created'

Triggered when Player created.

PlaybackReady
'Player.PlaybackReady'

Triggers by the createURLPlayer and createTTSPlayer methods when

  1. the audio file download to the Voximplant cache is finished;
  2. the audio file is found in the cache (i.e., it is in the cache before).
Started
'Player.Started'

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

Stopped
'Player.Stopped'

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

PlaybackFinished
'Player.PlaybackFinished'

Triggered when playback has finished successfully or with an error.

Error
'Player.Error'

Triggered when playback has finished with an error.

PlaybackMarkerReached
'Player.PlaybackMarkerReached'

Triggered when Player.addMarker is reached.

PlaybackBuffering
'Player.Buffering'

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

AudioChunksPlaybackFinished
'Player.AudioChunksPlaybackFinished'

Triggered when an audio chunk playback is finished. Note that this event is triggered only for RealtimeTTSPlayer instances.