Interface SynthesisInputOrBuilder (2.63.0)

public interface SynthesisInputOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCustomPronunciations()

public abstract CustomPronunciations getCustomPronunciations()

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.

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

Returns
Type Description
CustomPronunciations

The customPronunciations.

getCustomPronunciationsOrBuilder()

public abstract CustomPronunciationsOrBuilder getCustomPronunciationsOrBuilder()

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.

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

Returns
Type Description
CustomPronunciationsOrBuilder

getInputSourceCase()

public abstract SynthesisInput.InputSourceCase getInputSourceCase()
Returns
Type Description
SynthesisInput.InputSourceCase

getMarkup()

public abstract String getMarkup()

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

string markup = 5;

Returns
Type Description
String

The markup.

getMarkupBytes()

public abstract ByteString getMarkupBytes()

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

string markup = 5;

Returns
Type Description
ByteString

The bytes for markup.

getMultiSpeakerMarkup()

public abstract MultiSpeakerMarkup getMultiSpeakerMarkup()

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

.google.cloud.texttospeech.v1.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.v1.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 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.

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

Returns
Type Description
boolean

Whether the customPronunciations field is set.

hasMarkup()

public abstract boolean hasMarkup()

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

string markup = 5;

Returns
Type Description
boolean

Whether the markup field is set.

hasMultiSpeakerMarkup()

public abstract boolean hasMultiSpeakerMarkup()

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

.google.cloud.texttospeech.v1.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.