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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CUSTOM_VOICE_FIELD_NUMBER
public static final int CUSTOM_VOICE_FIELD_NUMBER
| Field Value |
| Type | Description |
int | |
LANGUAGE_CODE_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER
| Field Value |
| Type | Description |
int | |
MODEL_NAME_FIELD_NUMBER
public static final int MODEL_NAME_FIELD_NUMBER
| Field Value |
| Type | Description |
int | |
MULTI_SPEAKER_VOICE_CONFIG_FIELD_NUMBER
public static final int MULTI_SPEAKER_VOICE_CONFIG_FIELD_NUMBER
| Field Value |
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type | Description |
int | |
SSML_GENDER_FIELD_NUMBER
public static final int SSML_GENDER_FIELD_NUMBER
| Field Value |
| Type | Description |
int | |
VOICE_CLONE_FIELD_NUMBER
public static final int VOICE_CLONE_FIELD_NUMBER
| Field Value |
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static VoiceSelectionParams getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static VoiceSelectionParams.Builder newBuilder()
newBuilder(VoiceSelectionParams prototype)
public static VoiceSelectionParams.Builder newBuilder(VoiceSelectionParams prototype)
parseDelimitedFrom(InputStream input)
public static VoiceSelectionParams parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static VoiceSelectionParams parseFrom(byte[] data)
| Parameter |
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static VoiceSelectionParams parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static VoiceSelectionParams parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static VoiceSelectionParams parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static VoiceSelectionParams parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VoiceSelectionParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<VoiceSelectionParams> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name | Description |
obj | Object
|
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()
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];
| Returns |
| 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];
| Returns |
| Type | Description |
ByteString | The bytes for languageCode. |
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];
| Returns |
| Type | Description |
String | The modelName. |
getModelNameBytes()
public 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 |
| Type | Description |
ByteString | The bytes for modelName. |
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];
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];
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 |
| Type | Description |
String | The name. |
getNameBytes()
public 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 |
| Type | Description |
ByteString | The bytes for name. |
getParserForType()
public Parser<VoiceSelectionParams> getParserForType()
Overrides getSerializedSize()
public int getSerializedSize()
| Returns |
| Type | Description |
int | |
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;
| Returns |
| Type | Description |
int | The enum numeric value on the wire for ssmlGender. |
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];
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];
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;
| Returns |
| Type | Description |
boolean | Whether the customVoice field is set. |
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];
| Returns |
| Type | Description |
boolean | Whether the multiSpeakerVoiceConfig field is set. |
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];
| Returns |
| Type | Description |
boolean | Whether the voiceClone field is set. |
hashCode()
| Returns |
| Type | Description |
int | |
Overrides internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides isInitialized()
public final boolean isInitialized()
Overrides newBuilderForType()
public VoiceSelectionParams.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VoiceSelectionParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type | Description |
Object | |
Overrides toBuilder()
public VoiceSelectionParams.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides 