Cloud Text-to-Speech V1 Client - Class SynthesisInput (2.2.2)

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

Contains text input to be synthesized. Either text or ssml must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes.

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

Namespace

Google \ Cloud \ TextToSpeech \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ text`	`string` The raw text to be synthesized.
`↳ markup`	`string` Markup for HD voices specifically. This field may not be used with any other voices.
`↳ ssml`	`string` The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see SSML.
`↳ multi_speaker_markup`	`MultiSpeakerMarkup` The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis.
`↳ custom_pronunciations`	`CustomPronunciations` Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag.

getText

The raw text to be synthesized.

Returns
Type	Description
`string`

hasText

setText

The raw text to be synthesized.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMarkup

Markup for HD voices specifically. This field may not be used with any other voices.

Returns
Type	Description
`string`

hasMarkup

setMarkup

Markup for HD voices specifically. This field may not be used with any other voices.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSsml

The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see SSML.

Returns
Type	Description
`string`

hasSsml

setSsml

The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see SSML.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMultiSpeakerMarkup

The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis.

Returns
Type	Description
`MultiSpeakerMarkup\|null`

hasMultiSpeakerMarkup

setMultiSpeakerMarkup