Class: Google::Cloud::TextToSpeech::V1::VoiceSelectionParams

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb

Overview

Description of which voice to use for a synthesis request.

Instance Attribute Summary collapse

Instance Attribute Details

#custom_voice ⇒ ::Google::Cloud::TextToSpeech::V1::CustomVoiceParams

Returns The configuration for a custom voice. If [CustomVoiceParams.model] is set, the service will choose the custom voice matching the specified configuration.

Returns:



233
234
235
236
 
# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 233

class VoiceSelectionParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#language_code ⇒ ::String

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



233
234
235
236
 
# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 233

class VoiceSelectionParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



233
234
235
236
 
# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 233

class VoiceSelectionParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#ssml_gender ⇒ ::Google::Cloud::TextToSpeech::V1::SsmlVoiceGender

Returns 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.



233
234
235
236
 
# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 233

class VoiceSelectionParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#voice_clone ⇒ ::Google::Cloud::TextToSpeech::V1::VoiceCloneParams

Returns 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.

Returns:



233
234
235
236
 
# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 233

class VoiceSelectionParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end