Cloud Text-to-Speech V1 Client - Class SynthesizeSpeechRequest (1.10.0)

Reference documentation and code samples for the Cloud Text-to-Speech V1 Client class SynthesizeSpeechRequest.

The top-level message sent by the client for the SynthesizeSpeech method.

Generated from protobuf message google.cloud.texttospeech.v1.SynthesizeSpeechRequest

Namespace

Google \ Cloud \ TextToSpeech \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ input Google\Cloud\TextToSpeech\V1\SynthesisInput

Required. The Synthesizer requires either plain text or SSML as input.

↳ voice Google\Cloud\TextToSpeech\V1\VoiceSelectionParams

Required. The desired voice of the synthesized audio.

↳ audio_config Google\Cloud\TextToSpeech\V1\AudioConfig

Required. The configuration of the synthesized audio.

↳ advanced_voice_options Google\Cloud\TextToSpeech\V1\AdvancedVoiceOptions

Advanced voice options.

getInput

Required. The Synthesizer requires either plain text or SSML as input.

Returns
Type Description
Google\Cloud\TextToSpeech\V1\SynthesisInput|null

hasInput

clearInput

setInput

Required. The Synthesizer requires either plain text or SSML as input.

Parameter
Name Description
var Google\Cloud\TextToSpeech\V1\SynthesisInput
Returns
Type Description
$this

getVoice

Required. The desired voice of the synthesized audio.

Returns
Type Description
Google\Cloud\TextToSpeech\V1\VoiceSelectionParams|null

hasVoice

clearVoice

setVoice

Required. The desired voice of the synthesized audio.

Parameter
Name Description
var Google\Cloud\TextToSpeech\V1\VoiceSelectionParams
Returns
Type Description
$this

getAudioConfig

Required. The configuration of the synthesized audio.

Returns
Type Description
Google\Cloud\TextToSpeech\V1\AudioConfig|null

hasAudioConfig

clearAudioConfig

setAudioConfig

Required. The configuration of the synthesized audio.

Parameter
Name Description
var Google\Cloud\TextToSpeech\V1\AudioConfig
Returns
Type Description
$this

getAdvancedVoiceOptions

Advanced voice options.

Returns
Type Description
Google\Cloud\TextToSpeech\V1\AdvancedVoiceOptions|null

hasAdvancedVoiceOptions

clearAdvancedVoiceOptions

setAdvancedVoiceOptions

Advanced voice options.

Parameter
Name Description
var Google\Cloud\TextToSpeech\V1\AdvancedVoiceOptions
Returns
Type Description
$this

static::build

Parameters
Name Description
input Google\Cloud\TextToSpeech\V1\SynthesisInput

Required. The Synthesizer requires either plain text or SSML as input.

voice Google\Cloud\TextToSpeech\V1\VoiceSelectionParams

Required. The desired voice of the synthesized audio.

audioConfig Google\Cloud\TextToSpeech\V1\AudioConfig

Required. The configuration of the synthesized audio.

Returns
Type Description
Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest