Class: Google::Apis::TexttospeechV1::VoiceSelectionParams

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ VoiceSelectionParams

Returns a new instance of VoiceSelectionParams



265
266
267
 
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 265

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#language_code ⇒ String

The language (and optionally also the region) of the voice expressed as a BCP-47 language tag, e.g. "en-US". Required. 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

Returns:

  • (String) 


248
249
250
 
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 248

def language_code
  @language_code
end

#name ⇒ String

The name of the voice. Optional; 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

Returns:

  • (String) 


254
255
256
 
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 254

def name
  @name
end

#ssml_gender ⇒ String

The preferred gender of the voice. Optional; 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

Returns:

  • (String) 


263
264
265
 
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 263

def ssml_gender
  @ssml_gender
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



270
271
272
273
274
 
# File 'generated/google/apis/texttospeech_v1/classes.rb', line 270

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