com.google.cloud.texttospeech.v1

Interface SynthesisInputOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SynthesisInput, SynthesisInput.Builder

public interface SynthesisInputOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
CustomPronunciations	getCustomPronunciations() Optional.
CustomPronunciationsOrBuilder	getCustomPronunciationsOrBuilder() Optional.
SynthesisInput.InputSourceCase	getInputSourceCase()
MultiSpeakerMarkup	getMultiSpeakerMarkup() The multi-speaker input to be synthesized.
MultiSpeakerMarkupOrBuilder	getMultiSpeakerMarkupOrBuilder() The multi-speaker input to be synthesized.
String	getSsml() The SSML document to be synthesized.
com.google.protobuf.ByteString	getSsmlBytes() The SSML document to be synthesized.
String	getText() The raw text to be synthesized.
com.google.protobuf.ByteString	getTextBytes() The raw text to be synthesized.
boolean	hasCustomPronunciations() Optional.
boolean	hasMultiSpeakerMarkup() The multi-speaker input to be synthesized.
boolean	hasSsml() The SSML document to be synthesized.
boolean	hasText() The raw text to be synthesized.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasText

boolean hasText()

 The raw text to be synthesized.
 

string text = 1;

Returns:

Whether the text field is set.

getText

String getText()

 The raw text to be synthesized.
 

string text = 1;

Returns:

The text.

getTextBytes

com.google.protobuf.ByteString getTextBytes()

 The raw text to be synthesized.
 

string text = 1;

Returns:

The bytes for text.

hasSsml

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][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
 

string ssml = 2;

Returns:

Whether the ssml field is set.

getSsml

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][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
 

string ssml = 2;

Returns:

The ssml.

getSsmlBytes

com.google.protobuf.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][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
 

string ssml = 2;

Returns:

The bytes for ssml.

hasMultiSpeakerMarkup

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:

Whether the multiSpeakerMarkup field is set.

getMultiSpeakerMarkup

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:

The multiSpeakerMarkup.

getMultiSpeakerMarkupOrBuilder

MultiSpeakerMarkupOrBuilder getMultiSpeakerMarkupOrBuilder()

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

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

hasCustomPronunciations

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.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the customPronunciations field is set.

getCustomPronunciations

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.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The customPronunciations.

getCustomPronunciationsOrBuilder

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.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

getInputSourceCase

SynthesisInput.InputSourceCase getInputSourceCase()