public final class VoiceSelectionParams extends GeneratedMessageV3 implements VoiceSelectionParamsOrBuilder
Description of which voice to use for a synthesis request.
Protobuf type google.cloud.texttospeech.v1.VoiceSelectionParams
Static Fields
CUSTOM_VOICE_FIELD_NUMBER
public static final int CUSTOM_VOICE_FIELD_NUMBER
Field Value
LANGUAGE_CODE_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SSML_GENDER_FIELD_NUMBER
public static final int SSML_GENDER_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static VoiceSelectionParams getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static VoiceSelectionParams.Builder newBuilder()
Returns
newBuilder(VoiceSelectionParams prototype)
public static VoiceSelectionParams.Builder newBuilder(VoiceSelectionParams prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static VoiceSelectionParams parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static VoiceSelectionParams parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static VoiceSelectionParams parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static VoiceSelectionParams parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static VoiceSelectionParams parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static VoiceSelectionParams parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<VoiceSelectionParams> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
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;
getDefaultInstanceForType()
public VoiceSelectionParams getDefaultInstanceForType()
Returns
getLanguageCode()
public String getLanguageCode()
Required. The language (and potentially also the region) of the voice expressed as a
BCP-47 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];
| Type | Description |
| String | The languageCode.
|
getLanguageCodeBytes()
public ByteString getLanguageCodeBytes()
Required. The language (and potentially also the region) of the voice expressed as a
BCP-47 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];
| Type | Description |
| ByteString | The bytes for languageCode.
|
getName()
The name of the voice. If not set, the service will choose a
voice based on the other parameters such as language_code and gender.
string name = 2;
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The name of the voice. If not set, the service will choose a
voice based on the other parameters such as language_code and gender.
string name = 2;
getParserForType()
public Parser<VoiceSelectionParams> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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;
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;
| Type | Description |
| int | The enum numeric value on the wire for ssmlGender.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
| boolean | Whether the customVoice field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public VoiceSelectionParams.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VoiceSelectionParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public VoiceSelectionParams.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
