Package com.google.cloud.texttospeech.v1

Class VoiceSelectionParams

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.texttospeech.v1.VoiceSelectionParams
All Implemented Interfaces:
VoiceSelectionParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class VoiceSelectionParams extends com.google.protobuf.GeneratedMessage implements VoiceSelectionParamsOrBuilder
 Description of which voice to use for a synthesis request.
Protobuf type google.cloud.texttospeech.v1.VoiceSelectionParams
See Also:

  • Field Details

    • LANGUAGE_CODE_FIELD_NUMBER

      public static final int LANGUAGE_CODE_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • SSML_GENDER_FIELD_NUMBER

      public static final int SSML_GENDER_FIELD_NUMBER
      See Also:

    • CUSTOM_VOICE_FIELD_NUMBER

      public static final int CUSTOM_VOICE_FIELD_NUMBER
      See Also:

    • VOICE_CLONE_FIELD_NUMBER

      public static final int VOICE_CLONE_FIELD_NUMBER
      See Also:

    • MODEL_NAME_FIELD_NUMBER

      public static final int MODEL_NAME_FIELD_NUMBER
      See Also:

    • MULTI_SPEAKER_VOICE_CONFIG_FIELD_NUMBER

      public static final int MULTI_SPEAKER_VOICE_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getLanguageCode

      public 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];
      Specified by:
      getLanguageCode in interface VoiceSelectionParamsOrBuilder
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      public 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];
      Specified by:
      getLanguageCodeBytes in interface VoiceSelectionParamsOrBuilder
      Returns:
      The bytes for languageCode.

    • getName

      public 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;
      Specified by:
      getName in interface VoiceSelectionParamsOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface VoiceSelectionParamsOrBuilder
      Returns:
      The bytes for name.

    • getSsmlGenderValue

      public 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;
      Specified by:
      getSsmlGenderValue in interface VoiceSelectionParamsOrBuilder
      Returns:
      The enum numeric value on the wire for ssmlGender.

    • getSsmlGender

      public 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;
      Specified by:
      getSsmlGender in interface VoiceSelectionParamsOrBuilder
      Returns:
      The ssmlGender.

    • hasCustomVoice

      public 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;
      Specified by:
      hasCustomVoice in interface VoiceSelectionParamsOrBuilder
      Returns:
      Whether the customVoice field is set.

    • getCustomVoice

      public 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;
      Specified by:
      getCustomVoice in interface VoiceSelectionParamsOrBuilder
      Returns:
      The customVoice.

    • getCustomVoiceOrBuilder

      public 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;
      Specified by:
      getCustomVoiceOrBuilder in interface VoiceSelectionParamsOrBuilder

    • hasVoiceClone

      public 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];
      Specified by:
      hasVoiceClone in interface VoiceSelectionParamsOrBuilder
      Returns:
      Whether the voiceClone field is set.

    • getVoiceClone

      public 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];
      Specified by:
      getVoiceClone in interface VoiceSelectionParamsOrBuilder
      Returns:
      The voiceClone.

    • getVoiceCloneOrBuilder

      public 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];
      Specified by:
      getVoiceCloneOrBuilder in interface VoiceSelectionParamsOrBuilder

    • getModelName

      public 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];
      Specified by:
      getModelName in interface VoiceSelectionParamsOrBuilder
      Returns:
      The modelName.

    • getModelNameBytes

      public 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];
      Specified by:
      getModelNameBytes in interface VoiceSelectionParamsOrBuilder
      Returns:
      The bytes for modelName.

    • hasMultiSpeakerVoiceConfig

      public 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];
      Specified by:
      hasMultiSpeakerVoiceConfig in interface VoiceSelectionParamsOrBuilder
      Returns:
      Whether the multiSpeakerVoiceConfig field is set.

    • getMultiSpeakerVoiceConfig

      public 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];
      Specified by:
      getMultiSpeakerVoiceConfig in interface VoiceSelectionParamsOrBuilder
      Returns:
      The multiSpeakerVoiceConfig.

    • getMultiSpeakerVoiceConfigOrBuilder

      public 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];
      Specified by:
      getMultiSpeakerVoiceConfigOrBuilder in interface VoiceSelectionParamsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static VoiceSelectionParams parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VoiceSelectionParams parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VoiceSelectionParams parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VoiceSelectionParams parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VoiceSelectionParams parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VoiceSelectionParams parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VoiceSelectionParams parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VoiceSelectionParams parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VoiceSelectionParams parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VoiceSelectionParams parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VoiceSelectionParams parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VoiceSelectionParams parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public VoiceSelectionParams.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static VoiceSelectionParams.Builder newBuilder()

    • newBuilder

      public static VoiceSelectionParams.Builder newBuilder(VoiceSelectionParams prototype)

    • toBuilder

      public VoiceSelectionParams.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected VoiceSelectionParams.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static VoiceSelectionParams getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<VoiceSelectionParams> parser()

    • getParserForType

      public com.google.protobuf.Parser<VoiceSelectionParams> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public VoiceSelectionParams getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder