Cloud Text-to-Speech V1 API - Class Google::Cloud::TextToSpeech::V1::VoiceSelectionParams (v1.0.0)

Reference documentation and code samples for the Cloud Text-to-Speech V1 API class Google::Cloud::TextToSpeech::V1::VoiceSelectionParams.

Description of which voice to use for a synthesis request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#custom_voice

def custom_voice() -> ::Google::Cloud::TextToSpeech::V1::CustomVoiceParams
Returns

#custom_voice=

def custom_voice=(value) -> ::Google::Cloud::TextToSpeech::V1::CustomVoiceParams
Parameter
Returns

#language_code

def language_code() -> ::String
Returns
  • (::String) — 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)".

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::String) — 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)".
Returns
  • (::String) — 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)".

#name

def name() -> ::String
Returns
  • (::String) — 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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
  • (::String) — 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.

#ssml_gender

def ssml_gender() -> ::Google::Cloud::TextToSpeech::V1::SsmlVoiceGender
Returns
  • (::Google::Cloud::TextToSpeech::V1::SsmlVoiceGender) — 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.

#ssml_gender=

def ssml_gender=(value) -> ::Google::Cloud::TextToSpeech::V1::SsmlVoiceGender
Parameter
  • value (::Google::Cloud::TextToSpeech::V1::SsmlVoiceGender) — 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
  • (::Google::Cloud::TextToSpeech::V1::SsmlVoiceGender) — 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.