Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SynthesizeSpeechConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v2/classes.rb,
generated/google/apis/dialogflow_v2/representations.rb,
generated/google/apis/dialogflow_v2/representations.rb

Overview

Configuration of how speech should be synthesized.

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) ⇒ GoogleCloudDialogflowV2SynthesizeSpeechConfig

Returns a new instance of GoogleCloudDialogflowV2SynthesizeSpeechConfig



2472
2473
2474
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2472

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

Instance Attribute Details

#effects_profile_id ⇒ Array<String>

Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. Corresponds to the JSON property effectsProfileId

Returns:

  • (Array<String>) 


2438
2439
2440
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2438

def effects_profile_id
  @effects_profile_id
end

#pitch ⇒ Float

Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. Corresponds to the JSON property pitch

Returns:

  • (Float) 


2445
2446
2447
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2445

def pitch
  @pitch
end

#speaking_rate ⇒ Float

Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. Corresponds to the JSON property speakingRate

Returns:

  • (Float) 


2453
2454
2455
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2453

def speaking_rate
  @speaking_rate
end

#voice ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2VoiceSelectionParams

Description of which voice to use for speech synthesis. Corresponds to the JSON property voice

Returns:



2458
2459
2460
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2458

def voice
  @voice
end

#volume_gain_db ⇒ Float

Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. Corresponds to the JSON property volumeGainDb

Returns:

  • (Float) 


2470
2471
2472
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2470

def volume_gain_db
  @volume_gain_db
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2477
2478
2479
2480
2481
2482
2483
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2477

def update!(**args)
  @effects_profile_id = args[:effects_profile_id] if args.key?(:effects_profile_id)
  @pitch = args[:pitch] if args.key?(:pitch)
  @speaking_rate = args[:speaking_rate] if args.key?(:speaking_rate)
  @voice = args[:voice] if args.key?(:voice)
  @volume_gain_db = args[:volume_gain_db] if args.key?(:volume_gain_db)
end