Package com.google.cloud.texttospeech.v1

Interface VoiceSelectionParamsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
VoiceSelectionParams, VoiceSelectionParams.Builder
@Generated public interface VoiceSelectionParamsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getLanguageCode

      String getLanguageCode()
       Required. The language (and potentially also the region) of the voice
 expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
 language tag, e.g. "en-US". This should not include a script tag (e.g. use
 "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred
 from the input provided in the SynthesisInput.  The TTS service
 will use this parameter to help choose an appropriate voice.  Note that
 the TTS service may choose a voice with a slightly different language code
 than the one selected; it may substitute a different region
 (e.g. using en-US rather than en-CA if there isn't a Canadian voice
 available), or even a different language, e.g. using "nb" (Norwegian
 Bokmal) instead of "no" (Norwegian)".
      string language_code = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      com.google.protobuf.ByteString getLanguageCodeBytes()
       Required. The language (and potentially also the region) of the voice
 expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
 language tag, e.g. "en-US". This should not include a script tag (e.g. use
 "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred
 from the input provided in the SynthesisInput.  The TTS service
 will use this parameter to help choose an appropriate voice.  Note that
 the TTS service may choose a voice with a slightly different language code
 than the one selected; it may substitute a different region
 (e.g. using en-US rather than en-CA if there isn't a Canadian voice
 available), or even a different language, e.g. using "nb" (Norwegian
 Bokmal) instead of "no" (Norwegian)".
      string language_code = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for languageCode.

    • getName

      String getName()
       The name of the voice. If both the name and the gender are not set,
 the service will choose a voice based on the other parameters such as
 language_code.
      string name = 2;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the voice. If both the name and the gender are not set,
 the service will choose a voice based on the other parameters such as
 language_code.
      string name = 2;
      Returns:
      The bytes for name.

    • getSsmlGenderValue

      int getSsmlGenderValue()
       The preferred gender of the voice. If not set, the service will
 choose a voice based on the other parameters such as language_code and
 name. Note that this is only a preference, not requirement; if a
 voice of the appropriate gender is not available, the synthesizer should
 substitute a voice with a different gender rather than failing the request.
      .google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;
      Returns:
      The enum numeric value on the wire for ssmlGender.

    • getSsmlGender

      SsmlVoiceGender getSsmlGender()
       The preferred gender of the voice. If not set, the service will
 choose a voice based on the other parameters such as language_code and
 name. Note that this is only a preference, not requirement; if a
 voice of the appropriate gender is not available, the synthesizer should
 substitute a voice with a different gender rather than failing the request.
      .google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;
      Returns:
      The ssmlGender.

    • hasCustomVoice

      boolean hasCustomVoice()
       The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
      .google.cloud.texttospeech.v1.CustomVoiceParams custom_voice = 4;
      Returns:
      Whether the customVoice field is set.

    • getCustomVoice

      CustomVoiceParams getCustomVoice()
       The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
      .google.cloud.texttospeech.v1.CustomVoiceParams custom_voice = 4;
      Returns:
      The customVoice.

    • getCustomVoiceOrBuilder

      CustomVoiceParamsOrBuilder getCustomVoiceOrBuilder()
       The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
      .google.cloud.texttospeech.v1.CustomVoiceParams custom_voice = 4;

    • hasVoiceClone

      boolean hasVoiceClone()
       Optional. The configuration for a voice clone. If
 [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice
 clone matching the specified configuration.
      .google.cloud.texttospeech.v1.VoiceCloneParams voice_clone = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the voiceClone field is set.

    • getVoiceClone

      VoiceCloneParams getVoiceClone()
       Optional. The configuration for a voice clone. If
 [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice
 clone matching the specified configuration.
      .google.cloud.texttospeech.v1.VoiceCloneParams voice_clone = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The voiceClone.

    • getVoiceCloneOrBuilder

      VoiceCloneParamsOrBuilder getVoiceCloneOrBuilder()
       Optional. The configuration for a voice clone. If
 [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice
 clone matching the specified configuration.
      .google.cloud.texttospeech.v1.VoiceCloneParams voice_clone = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getModelName

      String getModelName()
       Optional. The name of the model. If set, the service will choose the model
 matching the specified configuration.
      string model_name = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The modelName.

    • getModelNameBytes

      com.google.protobuf.ByteString getModelNameBytes()
       Optional. The name of the model. If set, the service will choose the model
 matching the specified configuration.
      string model_name = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for modelName.

    • hasMultiSpeakerVoiceConfig

      boolean hasMultiSpeakerVoiceConfig()
       Optional. The configuration for a Gemini multi-speaker text-to-speech
 setup. Enables the use of two distinct voices in a single synthesis
 request.
      .google.cloud.texttospeech.v1.MultiSpeakerVoiceConfig multi_speaker_voice_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the multiSpeakerVoiceConfig field is set.

    • getMultiSpeakerVoiceConfig

      MultiSpeakerVoiceConfig getMultiSpeakerVoiceConfig()
       Optional. The configuration for a Gemini multi-speaker text-to-speech
 setup. Enables the use of two distinct voices in a single synthesis
 request.
      .google.cloud.texttospeech.v1.MultiSpeakerVoiceConfig multi_speaker_voice_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The multiSpeakerVoiceConfig.

    • getMultiSpeakerVoiceConfigOrBuilder

      MultiSpeakerVoiceConfigOrBuilder getMultiSpeakerVoiceConfigOrBuilder()
       Optional. The configuration for a Gemini multi-speaker text-to-speech
 setup. Enables the use of two distinct voices in a single synthesis
 request.
      .google.cloud.texttospeech.v1.MultiSpeakerVoiceConfig multi_speaker_voice_config = 7 [(.google.api.field_behavior) = OPTIONAL];