# Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::SynthesizeSpeechConfig (v1.16.1)

1.16.1 (latest) 1.16.0 1.15.0 1.14.0 1.13.0 1.12.1 1.11.0 1.10.1 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.1 1.0.0 0.34.0 0.33.0 0.32.2 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.1 0.16.0 0.15.2 0.14.0 0.13.0 0.12.0 Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::SynthesizeSpeechConfig.

Configuration of how speech should be synthesized.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #effects_profile_id

    def effects_profile_id() -> ::Array<::String>

**Returns**

- (::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.

### #effects_profile_id=

    def effects_profile_id=(value) -> ::Array<::String>

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #pitch

    def pitch() -> ::Float

**Returns**

- (::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.

### #pitch=

    def pitch=(value) -> ::Float

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #pronunciations

    def pronunciations() -> ::Array<::Google::Cloud::Dialogflow::V2::CustomPronunciationParams>

**Returns**

- (::Array\<[::Google::Cloud::Dialogflow::V2::CustomPronunciationParams](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-CustomPronunciationParams)\>) --- Optional. The custom pronunciations for the synthesized audio.

### #pronunciations=

    def pronunciations=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::CustomPronunciationParams>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Dialogflow::V2::CustomPronunciationParams](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-CustomPronunciationParams)\>) --- Optional. The custom pronunciations for the synthesized audio.
**Returns**

- (::Array\<[::Google::Cloud::Dialogflow::V2::CustomPronunciationParams](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-CustomPronunciationParams)\>) --- Optional. The custom pronunciations for the synthesized audio.

### #speaking_rate

    def speaking_rate() -> ::Float

**Returns**

- (::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.

### #speaking_rate=

    def speaking_rate=(value) -> ::Float

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #voice

    def voice() -> ::Google::Cloud::Dialogflow::V2::VoiceSelectionParams

**Returns**

- ([::Google::Cloud::Dialogflow::V2::VoiceSelectionParams](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-VoiceSelectionParams)) --- Optional. The desired voice of the synthesized audio.

### #voice=

    def voice=(value) -> ::Google::Cloud::Dialogflow::V2::VoiceSelectionParams

**Parameter**

- **value** ([::Google::Cloud::Dialogflow::V2::VoiceSelectionParams](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-VoiceSelectionParams)) --- Optional. The desired voice of the synthesized audio.
**Returns**

- ([::Google::Cloud::Dialogflow::V2::VoiceSelectionParams](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-VoiceSelectionParams)) --- Optional. The desired voice of the synthesized audio.

### #volume_gain_db

    def volume_gain_db() -> ::Float

**Returns**

- (::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.

### #volume_gain_db=

    def volume_gain_db=(value) -> ::Float

**Parameter**

- **value** (::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.
**Returns**

- (::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.