com.google.cloud.texttospeech.v1

Class SynthesisInput

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.texttospeech.v1.SynthesisInput

All Implemented Interfaces:

SynthesisInputOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class SynthesisInput
extends com.google.protobuf.GeneratedMessageV3
implements SynthesisInputOrBuilder

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

Protobuf type google.cloud.texttospeech.v1.SynthesisInput

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SynthesisInput.Builder Contains text input to be synthesized.
static class	SynthesisInput.InputSourceCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CUSTOM_PRONUNCIATIONS_FIELD_NUMBER
static int	MULTI_SPEAKER_MARKUP_FIELD_NUMBER
static int	SSML_FIELD_NUMBER
static int	TEXT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
CustomPronunciations	getCustomPronunciations() Optional.
CustomPronunciationsOrBuilder	getCustomPronunciationsOrBuilder() Optional.
static SynthesisInput	getDefaultInstance()
SynthesisInput	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
SynthesisInput.InputSourceCase	getInputSourceCase()
MultiSpeakerMarkup	getMultiSpeakerMarkup() The multi-speaker input to be synthesized.
MultiSpeakerMarkupOrBuilder	getMultiSpeakerMarkupOrBuilder() The multi-speaker input to be synthesized.
com.google.protobuf.Parser<SynthesisInput>	getParserForType()
int	getSerializedSize()
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.
int	hashCode()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SynthesisInput.Builder	newBuilder()
static SynthesisInput.Builder	newBuilder(SynthesisInput prototype)
SynthesisInput.Builder	newBuilderForType()
protected SynthesisInput.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SynthesisInput	parseDelimitedFrom(InputStream input)
static SynthesisInput	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SynthesisInput	parseFrom(byte[] data)
static SynthesisInput	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SynthesisInput	parseFrom(ByteBuffer data)
static SynthesisInput	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SynthesisInput	parseFrom(com.google.protobuf.ByteString data)
static SynthesisInput	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SynthesisInput	parseFrom(com.google.protobuf.CodedInputStream input)
static SynthesisInput	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SynthesisInput	parseFrom(InputStream input)
static SynthesisInput	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SynthesisInput>	parser()
SynthesisInput.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER

See Also:

Constant Field Values

SSML_FIELD_NUMBER

public static final int SSML_FIELD_NUMBER

See Also:

Constant Field Values

MULTI_SPEAKER_MARKUP_FIELD_NUMBER

public static final int MULTI_SPEAKER_MARKUP_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOM_PRONUNCIATIONS_FIELD_NUMBER

public static final int CUSTOM_PRONUNCIATIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getInputSourceCase

public SynthesisInput.InputSourceCase getInputSourceCase()

Specified by:

getInputSourceCase in interface SynthesisInputOrBuilder

hasText

public boolean hasText()

 The raw text to be synthesized.
 

string text = 1;

Specified by:

hasText in interface SynthesisInputOrBuilder

Returns:

Whether the text field is set.

getText

public String getText()

 The raw text to be synthesized.
 

string text = 1;

Specified by:

getText in interface SynthesisInputOrBuilder

Returns:

The text.

getTextBytes

public com.google.protobuf.ByteString getTextBytes()

 The raw text to be synthesized.
 

string text = 1;

Specified by:

getTextBytes in interface SynthesisInputOrBuilder

Returns:

The bytes for text.

hasSsml

public 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;

Specified by:

hasSsml in interface SynthesisInputOrBuilder

Returns:

Whether the ssml field is set.

getSsml

public 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;

Specified by:

getSsml in interface SynthesisInputOrBuilder

Returns:

The ssml.

getSsmlBytes

public 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;

Specified by:

getSsmlBytes in interface SynthesisInputOrBuilder

Returns:

The bytes for ssml.

hasMultiSpeakerMarkup

public boolean hasMultiSpeakerMarkup()

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

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

Specified by:

hasMultiSpeakerMarkup in interface SynthesisInputOrBuilder

Returns:

Whether the multiSpeakerMarkup field is set.

getMultiSpeakerMarkup

public MultiSpeakerMarkup getMultiSpeakerMarkup()

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

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

Specified by:

getMultiSpeakerMarkup in interface SynthesisInputOrBuilder

Returns:

The multiSpeakerMarkup.

getMultiSpeakerMarkupOrBuilder

public MultiSpeakerMarkupOrBuilder getMultiSpeakerMarkupOrBuilder()

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

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

Specified by:

getMultiSpeakerMarkupOrBuilder in interface SynthesisInputOrBuilder

hasCustomPronunciations

public 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];

Specified by:

hasCustomPronunciations in interface SynthesisInputOrBuilder

Returns:

Whether the customPronunciations field is set.

getCustomPronunciations

public 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];

Specified by:

getCustomPronunciations in interface SynthesisInputOrBuilder

Returns:

The customPronunciations.

getCustomPronunciationsOrBuilder

public 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];

Specified by:

getCustomPronunciationsOrBuilder in interface SynthesisInputOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SynthesisInput parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SynthesisInput parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SynthesisInput parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SynthesisInput parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SynthesisInput parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SynthesisInput parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SynthesisInput parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static SynthesisInput parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static SynthesisInput parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static SynthesisInput parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static SynthesisInput parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static SynthesisInput parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public SynthesisInput.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SynthesisInput.Builder newBuilder()

newBuilder

public static SynthesisInput.Builder newBuilder(SynthesisInput prototype)

toBuilder

public SynthesisInput.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SynthesisInput.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SynthesisInput getDefaultInstance()

parser

public static com.google.protobuf.Parser<SynthesisInput> parser()

getParserForType

public com.google.protobuf.Parser<SynthesisInput> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SynthesisInput getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder