Documentation

Support

Vivox Core SDK

Vivox Core SDK

Text-to-speech events

Learn about text-to-speech event callbacks.
Read time 1 minuteLast updated 20 hours ago
Text-to-speech (TTS) reports the following events through the standard Vivox events reporting mechanism: 
  • vx_evt_tts_injection_started
     - Raised when a TTS message has finished preparing for playback and is starting to play.     
    • num_consumers
      - The number of active sessions (for 
      tts_dest_remote_transmission
      ) or local playback players (for 
      tts_dest_local_playback
      ) that the TTS message is injected into.
    • utterance_id
      - The unique identifier of the TTS message or utterance. This is the same identifier as the one that is returned to you when calling 
      vx_tts_speak
      .
    • utterance_duration
      - The duration of the utterance in seconds.
    • tts_destination
      - The destination into which the TTS message is injected.
  • vx_evt_tts_injection_ended
     - Raised when a TTS message finishes playback.     
    • num_consumers
      - The number of active sessions (for 
      tts_dest_remote_transmission
      ) or local playback players (for 
      tts_dest_local_playback
      ) that the TTS message is injected into.
    • utterance_id
      - The unique identifier of the TTS message or utterance. This is the same identifier as the one that is returned to you when calling 
      vx_tts_speak
      .
    • tts_destination
      - The destination into which the TTS message is injected.
  • vx_evt_tts_injection_failed
     - Raised when playback of a TTS message has failed.     
    • status
      - The error code of the failure.
    • utterance_id
      - The unique identifier of the TTS message or utterance. This is the same identifier as the one that is returned to you when calling 
      vx_tts_speak
      .
    • tts_destination
      - The destination into which the TTS message is injected.