Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class SynthesizeSpeechConfig.
Configuration of how speech should be synthesized.
Generated from protobuf messagegoogle.cloud.dialogflow.v2.SynthesizeSpeechConfig
Namespace
Google \ Cloud \ Dialogflow \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
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.
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
Type
Description
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
Name
Description
var
float
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
float
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
float
Returns
Type
Description
$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.
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
Name
Description
var
string[]
Returns
Type
Description
$this
getVoice
Optional. The desired voice of the synthesized audio.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dialogflow V2 Client - Class SynthesizeSpeechConfig (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-dialogflow/latest/V2.SynthesizeSpeechConfig)\n- [2.1.1](/php/docs/reference/cloud-dialogflow/2.1.1/V2.SynthesizeSpeechConfig)\n- [2.0.1](/php/docs/reference/cloud-dialogflow/2.0.1/V2.SynthesizeSpeechConfig)\n- [1.17.2](/php/docs/reference/cloud-dialogflow/1.17.2/V2.SynthesizeSpeechConfig)\n- [1.16.0](/php/docs/reference/cloud-dialogflow/1.16.0/V2.SynthesizeSpeechConfig)\n- [1.15.1](/php/docs/reference/cloud-dialogflow/1.15.1/V2.SynthesizeSpeechConfig)\n- [1.14.0](/php/docs/reference/cloud-dialogflow/1.14.0/V2.SynthesizeSpeechConfig)\n- [1.13.0](/php/docs/reference/cloud-dialogflow/1.13.0/V2.SynthesizeSpeechConfig)\n- [1.12.3](/php/docs/reference/cloud-dialogflow/1.12.3/V2.SynthesizeSpeechConfig)\n- [1.11.0](/php/docs/reference/cloud-dialogflow/1.11.0/V2.SynthesizeSpeechConfig)\n- [1.10.2](/php/docs/reference/cloud-dialogflow/1.10.2/V2.SynthesizeSpeechConfig)\n- [1.9.0](/php/docs/reference/cloud-dialogflow/1.9.0/V2.SynthesizeSpeechConfig)\n- [1.8.0](/php/docs/reference/cloud-dialogflow/1.8.0/V2.SynthesizeSpeechConfig)\n- [1.7.2](/php/docs/reference/cloud-dialogflow/1.7.2/V2.SynthesizeSpeechConfig)\n- [1.6.0](/php/docs/reference/cloud-dialogflow/1.6.0/V2.SynthesizeSpeechConfig)\n- [1.5.0](/php/docs/reference/cloud-dialogflow/1.5.0/V2.SynthesizeSpeechConfig)\n- [1.4.0](/php/docs/reference/cloud-dialogflow/1.4.0/V2.SynthesizeSpeechConfig)\n- [1.3.2](/php/docs/reference/cloud-dialogflow/1.3.2/V2.SynthesizeSpeechConfig)\n- [1.2.0](/php/docs/reference/cloud-dialogflow/1.2.0/V2.SynthesizeSpeechConfig)\n- [1.1.1](/php/docs/reference/cloud-dialogflow/1.1.1/V2.SynthesizeSpeechConfig)\n- [1.0.1](/php/docs/reference/cloud-dialogflow/1.0.1/V2.SynthesizeSpeechConfig) \nReference documentation and code samples for the Google Cloud Dialogflow V2 Client class SynthesizeSpeechConfig.\n\nConfiguration of how speech should be synthesized.\n\nGenerated from protobuf message `google.cloud.dialogflow.v2.SynthesizeSpeechConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSpeakingRate\n\nOptional. Speaking rate/speed, in the range \\[0.25, 4.0\\]. 1.0 is the normal\nnative speed supported by the specific voice. 2.0 is twice as fast, and 0.5\nis half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other\nvalues \\\u003c 0.25 or \\\u003e 4.0 will return an error.\n\n### setSpeakingRate\n\nOptional. Speaking rate/speed, in the range \\[0.25, 4.0\\]. 1.0 is the normal\nnative speed supported by the specific voice. 2.0 is twice as fast, and 0.5\nis half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other\nvalues \\\u003c 0.25 or \\\u003e 4.0 will return an error.\n\n### getPitch\n\nOptional. Speaking pitch, in the range \\[-20.0, 20.0\\]. 20 means increase 20\nsemitones from the original pitch. -20 means decrease 20 semitones from the\noriginal pitch.\n\n### setPitch\n\nOptional. Speaking pitch, in the range \\[-20.0, 20.0\\]. 20 means increase 20\nsemitones from the original pitch. -20 means decrease 20 semitones from the\noriginal pitch.\n\n### getVolumeGainDb\n\nOptional. Volume gain (in dB) of the normal native volume supported by the\nspecific voice, in the range \\[-96.0, 16.0\\]. If unset, or set to a value of\n0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)\nwill play at approximately half the amplitude of the normal native signal\namplitude. A value of +6.0 (dB) will play at approximately twice the\namplitude of the normal native signal amplitude. We strongly recommend not\nto exceed +10 (dB) as there's usually no effective increase in loudness for\nany value greater than that.\n\n### setVolumeGainDb\n\nOptional. Volume gain (in dB) of the normal native volume supported by the\nspecific voice, in the range \\[-96.0, 16.0\\]. If unset, or set to a value of\n0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)\nwill play at approximately half the amplitude of the normal native signal\namplitude. A value of +6.0 (dB) will play at approximately twice the\namplitude of the normal native signal amplitude. We strongly recommend not\nto exceed +10 (dB) as there's usually no effective increase in loudness for\nany value greater than that.\n\n### getEffectsProfileId\n\nOptional. An identifier which selects 'audio effects' profiles that are\napplied on (post synthesized) text to speech. Effects are applied on top of\neach other in the order they are given.\n\n### setEffectsProfileId\n\nOptional. An identifier which selects 'audio effects' profiles that are\napplied on (post synthesized) text to speech. Effects are applied on top of\neach other in the order they are given.\n\n### getVoice\n\nOptional. The desired voice of the synthesized audio.\n\n### hasVoice\n\n### clearVoice\n\n### setVoice\n\nOptional. The desired voice of the synthesized audio."]]
