Class: Google::Apis::TexttospeechV1::VoiceSelectionParams
- Inherits:
-
Object
- Object
- Google::Apis::TexttospeechV1::VoiceSelectionParams
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/texttospeech_v1/classes.rb,
generated/google/apis/texttospeech_v1/representations.rb,
generated/google/apis/texttospeech_v1/representations.rb
Overview
Description of which voice to use for a synthesis request.
Instance Attribute Summary collapse
-
#language_code ⇒ String
Required.
-
#name ⇒ String
The name of the voice.
-
#ssml_gender ⇒ String
The preferred gender of the voice.
Instance Method Summary collapse
-
#initialize(**args) ⇒ VoiceSelectionParams
constructor
A new instance of VoiceSelectionParams.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ VoiceSelectionParams
Returns a new instance of VoiceSelectionParams.
279 280 281 |
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 279 def initialize(**args) update!(**args) end |
Instance Attribute Details
#language_code ⇒ 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)".
Corresponds to the JSON property languageCode
262 263 264 |
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 262 def language_code @language_code end |
#name ⇒ 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.
Corresponds to the JSON property name
268 269 270 |
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 268 def name @name end |
#ssml_gender ⇒ String
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.
Corresponds to the JSON property ssmlGender
277 278 279 |
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 277 def ssml_gender @ssml_gender end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
284 285 286 287 288 |
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 284 def update!(**args) @language_code = args[:language_code] if args.key?(:language_code) @name = args[:name] if args.key?(:name) @ssml_gender = args[:ssml_gender] if args.key?(:ssml_gender) end |