Documentation

Support

Vivox Core SDK

Vivox Core SDK

Queue a text-to-speech message

Queue a text-to-speech message for audio output.
Read time 1 minuteLast updated 20 hours ago
Some destinations offer a built-in queuing system. When a new message is injected and there is an ongoing message playing, then the new message is put into a queue. After the ongoing message finishes playing, the next message in the queue automatically starts to play. 
vx_tts_utterance_id firstUtteranceId;vx_tts_speak(managerId, voiceId, "Example message, this is great!", tts_dest_queued_local_playback, &firstUtteranceId);// Immediately injected and returns tts_status_successvx_tts_utterance_id secondUtteranceId;vx_tts_speak(managerId, voiceId, "Really amazing.", tts_dest_queued_local_playback, &secondUtteranceId);// Put in a queue and returns tts_status_input_text_was_enqueued. After the first message finishes playback, this message will start.
A queue is shared between 
tts_dest_queued_remote_transmission
and 
tts_dest_queued_remote_transmission_with_local_playback
. 
tts_dest_queued_local_playback
has its own queue. A destination queue can hold up to 10 messages. If a message is added when a destination queue is full, the Vivox SDK discards the message and returns the error 
tts_error_destination_queue_is_full
.