Package com.vonage.client.conversations

Class AudioSayEvent

java.lang.Object
com.vonage.client.JsonableBaseObject
com.vonage.client.conversations.Event
com.vonage.client.conversations.AudioSayEvent
All Implemented Interfaces:
Jsonable
public final class AudioSayEvent extends Event
Represents an EventType.AUDIO_SAY event.

  • Method Details

    • getSayId

      public UUID getSayId()
      Unique audio say identifier.
      Returns:
      The say ID, or null if unknown.

    • getText

      public String getText()
      Text to be spoken.
      Returns:
      The speech text.

    • getStyle

      public Integer getStyle()
      Text-to-speech voice style. See the Voice API documentation for valid options.
      Returns:
      The TTS style as an Integer, or null if unspecified.

    • getLanguage

      public TextToSpeechLanguage getLanguage()
      Language for the spoken text.
      Returns:
      The TTS language as an enum, or null if unspecified.

    • getPremium

      public Boolean getPremium()
      Whether to use the premium version of the text-to-speech voice.
      Returns:
      true to use Premium TTS, or null if unspecified.

    • getSsml

      public Boolean getSsml()
      Whether to enable Synthesized Speech Markup Language (SSML).
      Returns:
      true to use SSML, or null if unspecified.

    • builder

      public static AudioSayEvent.Builder builder()
      Entry point for constructing an instance of this class.
      Returns:
      A new Builder.

    • getQueue

      public Boolean getQueue()
      Whether to queue the audio.
      Returns:
      true if queuing is enabled, or null if unspecified.

    • getLevel

      public Double getLevel()
      Audio volume level, with -1 being quietest, +1 being loudest and 0 the default.
      Returns:
      The volume as a Double, or null if unspecified.

    • getLoop

      public Integer getLoop()
      Number of times to repeat the audio.
      Returns:
      The loop count as an Integer, or null if unspecified.