com.google.api.services.texttospeech.v1.model

Class VoiceSelectionParams

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.texttospeech.v1.model.VoiceSelectionParams

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class VoiceSelectionParams
extends com.google.api.client.json.GenericJson

Description of which voice to use for a synthesis request.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Text-to-Speech API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
VoiceSelectionParams()

Method Summary

Modifier and Type	Method and Description
VoiceSelectionParams	clone()
java.lang.String	getLanguageCode() Required.
java.lang.String	getName() The name of the voice.
java.lang.String	getSsmlGender() The preferred gender of the voice.
VoiceSelectionParams	set(java.lang.String fieldName, java.lang.Object value)
VoiceSelectionParams	setLanguageCode(java.lang.String languageCode) Required.
VoiceSelectionParams	setName(java.lang.String name) The name of the voice.
VoiceSelectionParams	setSsmlGender(java.lang.String ssmlGender) The preferred gender of the voice.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

VoiceSelectionParams

public VoiceSelectionParams()

Method Detail

getLanguageCode

public java.lang.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)".

Returns:

value or null for none

setLanguageCode

public VoiceSelectionParams setLanguageCode(java.lang.String languageCode)

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)".

Parameters:

languageCode - languageCode or null for none

getName

public java.lang.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.

Returns:

value or null for none

setName

public VoiceSelectionParams setName(java.lang.String name)

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.

Parameters:

name - name or null for none

getSsmlGender

public java.lang.String 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.

Returns:

value or null for none

setSsmlGender

public VoiceSelectionParams setSsmlGender(java.lang.String ssmlGender)

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.

Parameters:

ssmlGender - ssmlGender or null for none

set

public VoiceSelectionParams set(java.lang.String fieldName,
                                java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public VoiceSelectionParams clone()

Overrides:

clone in class com.google.api.client.json.GenericJson