Interface VoiceSelectionParamsOrBuilder (2.55.0) 

public interface VoiceSelectionParamsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCustomVoice()

public abstract 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
Type Description
CustomVoiceParams

The customVoice.

getCustomVoiceOrBuilder()

public abstract 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;

Returns
Type Description
CustomVoiceParamsOrBuilder

getLanguageCode()

public abstract 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 abstract 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.

getName()

public abstract 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
Type Description
String

The name.

getNameBytes()

public abstract 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.

getSsmlGender()

public abstract 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
Type Description
SsmlVoiceGender

The ssmlGender.

getSsmlGenderValue()

public abstract 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 abstract VoiceCloneParams getVoiceClone()

Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration.

.google.cloud.texttospeech.v1.VoiceCloneParams voice_clone = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VoiceCloneParams

The voiceClone.

getVoiceCloneOrBuilder()

public abstract VoiceCloneParamsOrBuilder getVoiceCloneOrBuilder()

Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration.

.google.cloud.texttospeech.v1.VoiceCloneParams voice_clone = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VoiceCloneParamsOrBuilder

hasCustomVoice()

public abstract 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.

hasVoiceClone()

public abstract boolean hasVoiceClone()

Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose 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.