Interface SynthesisInputOrBuilder (2.54.0)

Version latest

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.9
• 2.3.0
• 2.2.1
• 2.1.5

public interface SynthesisInputOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCustomPronunciations()

public abstract CustomPronunciations getCustomPronunciations()

Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations.

The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet.

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 (entirely or partially).

.google.cloud.texttospeech.v1beta1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CustomPronunciations	The customPronunciations.

getCustomPronunciationsOrBuilder()

public abstract CustomPronunciationsOrBuilder getCustomPronunciationsOrBuilder()

Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations.

The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet.

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 (entirely or partially).

.google.cloud.texttospeech.v1beta1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CustomPronunciationsOrBuilder

getInputSourceCase()

public abstract SynthesisInput.InputSourceCase getInputSourceCase()

Returns
Type	Description
SynthesisInput.InputSourceCase

getMultiSpeakerMarkup()

public abstract MultiSpeakerMarkup getMultiSpeakerMarkup()

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

.google.cloud.texttospeech.v1beta1.MultiSpeakerMarkup multi_speaker_markup = 4;

Returns
Type	Description
MultiSpeakerMarkup	The multiSpeakerMarkup.

getMultiSpeakerMarkupOrBuilder()

public abstract MultiSpeakerMarkupOrBuilder getMultiSpeakerMarkupOrBuilder()

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

.google.cloud.texttospeech.v1beta1.MultiSpeakerMarkup multi_speaker_markup = 4;

Returns
Type	Description
MultiSpeakerMarkupOrBuilder

getSsml()

public abstract String 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.

string ssml = 2;

Returns
Type	Description
String	The ssml.

getSsmlBytes()

public abstract ByteString getSsmlBytes()

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.

string ssml = 2;

Returns
Type	Description
ByteString	The bytes for ssml.

getText()

public abstract String getText()

The raw text to be synthesized.

string text = 1;

Returns
Type	Description
String	The text.

getTextBytes()

public abstract ByteString getTextBytes()

The raw text to be synthesized.

string text = 1;

Returns
Type	Description
ByteString	The bytes for text.

hasCustomPronunciations()

public abstract boolean hasCustomPronunciations()

Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations.

The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet.

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 (entirely or partially).

.google.cloud.texttospeech.v1beta1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the customPronunciations field is set.

hasMultiSpeakerMarkup()

public abstract boolean hasMultiSpeakerMarkup()

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

.google.cloud.texttospeech.v1beta1.MultiSpeakerMarkup multi_speaker_markup = 4;

Returns
Type	Description
boolean	Whether the multiSpeakerMarkup field is set.

hasSsml()

public abstract boolean hasSsml()

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.

string ssml = 2;

Returns
Type	Description
boolean	Whether the ssml field is set.

hasText()

public abstract boolean hasText()

The raw text to be synthesized.

string text = 1;

Returns
Type	Description
boolean	Whether the text field is set.