Class: Google::Apis::TexttospeechV1beta1::VoiceSelectionParams
- Inherits:
-
Object
- Object
- Google::Apis::TexttospeechV1beta1::VoiceSelectionParams
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/texttospeech_v1beta1/classes.rb,
lib/google/apis/texttospeech_v1beta1/representations.rb,
lib/google/apis/texttospeech_v1beta1/representations.rb
Overview
Description of which voice to use for a synthesis request.
Instance Attribute Summary collapse
-
#custom_voice ⇒ Google::Apis::TexttospeechV1beta1::CustomVoiceParams
Description of the custom voice to be synthesized.
-
#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.
Constructor Details
#initialize(**args) ⇒ VoiceSelectionParams
Returns a new instance of VoiceSelectionParams.
578 579 580 |
# File 'lib/google/apis/texttospeech_v1beta1/classes.rb', line 578 def initialize(**args) update!(**args) end |
Instance Attribute Details
#custom_voice ⇒ Google::Apis::TexttospeechV1beta1::CustomVoiceParams
Description of the custom voice to be synthesized.
Corresponds to the JSON property customVoice
546 547 548 |
# File 'lib/google/apis/texttospeech_v1beta1/classes.rb', line 546 def custom_voice @custom_voice end |
#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
560 561 562 |
# File 'lib/google/apis/texttospeech_v1beta1/classes.rb', line 560 def language_code @language_code end |
#name ⇒ 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.
Corresponds to the JSON property name
567 568 569 |
# File 'lib/google/apis/texttospeech_v1beta1/classes.rb', line 567 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
576 577 578 |
# File 'lib/google/apis/texttospeech_v1beta1/classes.rb', line 576 def ssml_gender @ssml_gender end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
583 584 585 586 587 588 |
# File 'lib/google/apis/texttospeech_v1beta1/classes.rb', line 583 def update!(**args) @custom_voice = args[:custom_voice] if args.key?(:custom_voice) @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 |