com.google.cloud.texttospeech.v1beta1

Interface VoiceSelectionParamsOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

VoiceSelectionParams, VoiceSelectionParams.Builder

public interface VoiceSelectionParamsOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
CustomVoiceParams	getCustomVoice() The configuration for a custom voice.
CustomVoiceParamsOrBuilder	getCustomVoiceOrBuilder() The configuration for a custom voice.
String	getLanguageCode() Required.
ByteString	getLanguageCodeBytes() Required.
String	getName() The name of the voice.
ByteString	getNameBytes() The name of the voice.
SsmlVoiceGender	getSsmlGender() The preferred gender of the voice.
int	getSsmlGenderValue() The preferred gender of the voice.
boolean	hasCustomVoice() The configuration for a custom voice.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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

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 not set, the service will choose a
 voice based on the other parameters such as language_code and gender.
 

string name = 2;

Returns:

The name.

getNameBytes

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;

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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.CustomVoiceParams custom_voice = 4;