Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class SynthesisInput (2.77.0)

public final class SynthesisInput extends 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. The input size is limited to 5000 bytes.

Protobuf type google.cloud.texttospeech.v1beta1.SynthesisInput

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SynthesisInput

Implements

SynthesisInputOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CUSTOM_PRONUNCIATIONS_FIELD_NUMBER

public static final int CUSTOM_PRONUNCIATIONS_FIELD_NUMBER

Field Value
Type	Description
`int`

MARKUP_FIELD_NUMBER

public static final int MARKUP_FIELD_NUMBER

Field Value
Type	Description
`int`

MULTI_SPEAKER_MARKUP_FIELD_NUMBER

public static final int MULTI_SPEAKER_MARKUP_FIELD_NUMBER

Field Value
Type	Description
`int`

PROMPT_FIELD_NUMBER

public static final int PROMPT_FIELD_NUMBER

Field Value
Type	Description
`int`

SSML_FIELD_NUMBER

public static final int SSML_FIELD_NUMBER

Field Value
Type	Description
`int`

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static SynthesisInput getDefaultInstance()

Returns
Type	Description
`SynthesisInput`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static SynthesisInput.Builder newBuilder()

Returns
Type	Description
`SynthesisInput.Builder`

newBuilder(SynthesisInput prototype)

public static SynthesisInput.Builder newBuilder(SynthesisInput prototype)

Parameter
Name	Description
`prototype`	`SynthesisInput`

Returns
Type	Description
`SynthesisInput.Builder`

parseDelimitedFrom(InputStream input)

public static SynthesisInput parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesisInput parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static SynthesisInput parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SynthesisInput parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static SynthesisInput parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SynthesisInput parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static SynthesisInput parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesisInput parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static SynthesisInput parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesisInput parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static SynthesisInput parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SynthesisInput parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SynthesisInput`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<SynthesisInput> parser()

Returns
Type	Description
`Parser<SynthesisInput>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getCustomPronunciations()

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

Returns
Type	Description
`CustomPronunciations`	The customPronunciations.

getCustomPronunciationsOrBuilder()

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

Returns
Type	Description
`CustomPronunciationsOrBuilder`

getDefaultInstanceForType()

public SynthesisInput getDefaultInstanceForType()

Returns
Type	Description
`SynthesisInput`

getInputSourceCase()

public SynthesisInput.InputSourceCase getInputSourceCase()

Returns
Type	Description
`SynthesisInput.InputSourceCase`

getMarkup()

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

getParserForType()

public Parser<SynthesisInput> getParserForType()

Returns
Type	Description
`Parser<SynthesisInput>`

Overrides

GeneratedMessageV3.getParserForType()

getPrompt()

public String getPrompt()

This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.

optional string prompt = 6;

Returns
Type	Description
`String`	The prompt.

getPromptBytes()

public ByteString getPromptBytes()

optional string prompt = 6;

Returns
Type	Description
`ByteString`	The bytes for prompt.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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. For more information, see SSML.

string ssml = 2;

Returns
Type	Description
`String`	The ssml.

getSsmlBytes()

public 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 String getText()

The raw text to be synthesized.

string text = 1;

Returns
Type	Description
`String`	The text.

getTextBytes()

public ByteString getTextBytes()

The raw text to be synthesized.

string text = 1;

Returns
Type	Description
`ByteString`	The bytes for text.

hasCustomPronunciations()

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

Returns
Type	Description
`boolean`	Whether the customPronunciations field is set.

hasMarkup()

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

hasPrompt()

public boolean hasPrompt()

optional string prompt = 6;

Returns
Type	Description
`boolean`	Whether the prompt field is set.

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. For more information, see SSML.

string ssml = 2;

Returns
Type	Description
`boolean`	Whether the ssml field is set.

hasText()

public boolean hasText()

The raw text to be synthesized.

string text = 1;

Returns
Type	Description
`boolean`	Whether the text field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SynthesisInput.Builder newBuilderForType()

Returns
Type	Description
`SynthesisInput.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SynthesisInput.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`SynthesisInput.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SynthesisInput.Builder toBuilder()

Returns
Type	Description
`SynthesisInput.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`