Google Cloud Dialogflow V2 Client - Class SynthesizeSpeechConfig (1.5.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class SynthesizeSpeechConfig.

Configuration of how speech should be synthesized.

Generated from protobuf message google.cloud.dialogflow.v2.SynthesizeSpeechConfig

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ 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.

↳ 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.

↳ 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.

↳ effects_profile_id array

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.

↳ voice Google\Cloud\Dialogflow\V2\VoiceSelectionParams

Optional. The desired voice of the synthesized audio.

getSpeakingRate

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
TypeDescription
float

setSpeakingRate

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.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getPitch

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
TypeDescription
float

setPitch

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.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getVolumeGainDb

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
TypeDescription
float

setVolumeGainDb

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.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getEffectsProfileId

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
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEffectsProfileId

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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getVoice

Optional. The desired voice of the synthesized audio.

Returns
TypeDescription
Google\Cloud\Dialogflow\V2\VoiceSelectionParams|null

hasVoice

clearVoice

setVoice

Optional. The desired voice of the synthesized audio.

Parameter
NameDescription
var Google\Cloud\Dialogflow\V2\VoiceSelectionParams
Returns
TypeDescription
$this