Class SynthesisInput.Builder (2.55.0)

public static final class SynthesisInput.Builder extends GeneratedMessageV3.Builder<SynthesisInput.Builder> 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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SynthesisInput.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SynthesisInput.Builder
Overrides

build()

public SynthesisInput build()
Returns
Type Description
SynthesisInput

buildPartial()

public SynthesisInput buildPartial()
Returns
Type Description
SynthesisInput

clear()

public SynthesisInput.Builder clear()
Returns
Type Description
SynthesisInput.Builder
Overrides

clearCustomPronunciations()

public SynthesisInput.Builder clearCustomPronunciations()

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
SynthesisInput.Builder

clearField(Descriptors.FieldDescriptor field)

public SynthesisInput.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SynthesisInput.Builder
Overrides

clearInputSource()

public SynthesisInput.Builder clearInputSource()
Returns
Type Description
SynthesisInput.Builder

clearMultiSpeakerMarkup()

public SynthesisInput.Builder clearMultiSpeakerMarkup()

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
SynthesisInput.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SynthesisInput.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SynthesisInput.Builder
Overrides

clearSsml()

public SynthesisInput.Builder clearSsml()

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
SynthesisInput.Builder

This builder for chaining.

clearText()

public SynthesisInput.Builder clearText()

The raw text to be synthesized.

string text = 1;

Returns
Type Description
SynthesisInput.Builder

This builder for chaining.

clone()

public SynthesisInput.Builder clone()
Returns
Type Description
SynthesisInput.Builder
Overrides

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

Returns
Type Description
CustomPronunciations

The customPronunciations.

getCustomPronunciationsBuilder()

public CustomPronunciations.Builder getCustomPronunciationsBuilder()

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

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

Returns
Type Description
CustomPronunciationsOrBuilder

getDefaultInstanceForType()

public SynthesisInput getDefaultInstanceForType()
Returns
Type Description
SynthesisInput

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInputSourceCase()

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

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.

getMultiSpeakerMarkupBuilder()

public MultiSpeakerMarkup.Builder getMultiSpeakerMarkupBuilder()

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

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCustomPronunciations(CustomPronunciations value)

public SynthesisInput.Builder mergeCustomPronunciations(CustomPronunciations value)

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

Parameter
Name Description
value CustomPronunciations
Returns
Type Description
SynthesisInput.Builder

mergeFrom(SynthesisInput other)

public SynthesisInput.Builder mergeFrom(SynthesisInput other)
Parameter
Name Description
other SynthesisInput
Returns
Type Description
SynthesisInput.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SynthesisInput.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SynthesisInput.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SynthesisInput.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SynthesisInput.Builder
Overrides

mergeMultiSpeakerMarkup(MultiSpeakerMarkup value)

public SynthesisInput.Builder mergeMultiSpeakerMarkup(MultiSpeakerMarkup value)

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

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

Parameter
Name Description
value MultiSpeakerMarkup
Returns
Type Description
SynthesisInput.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SynthesisInput.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SynthesisInput.Builder
Overrides

setCustomPronunciations(CustomPronunciations value)

public SynthesisInput.Builder setCustomPronunciations(CustomPronunciations value)

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

Parameter
Name Description
value CustomPronunciations
Returns
Type Description
SynthesisInput.Builder

setCustomPronunciations(CustomPronunciations.Builder builderForValue)

public SynthesisInput.Builder setCustomPronunciations(CustomPronunciations.Builder builderForValue)

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

Parameter
Name Description
builderForValue CustomPronunciations.Builder
Returns
Type Description
SynthesisInput.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SynthesisInput.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SynthesisInput.Builder
Overrides

setMultiSpeakerMarkup(MultiSpeakerMarkup value)

public SynthesisInput.Builder setMultiSpeakerMarkup(MultiSpeakerMarkup value)

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

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

Parameter
Name Description
value MultiSpeakerMarkup
Returns
Type Description
SynthesisInput.Builder

setMultiSpeakerMarkup(MultiSpeakerMarkup.Builder builderForValue)

public SynthesisInput.Builder setMultiSpeakerMarkup(MultiSpeakerMarkup.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue MultiSpeakerMarkup.Builder
Returns
Type Description
SynthesisInput.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SynthesisInput.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SynthesisInput.Builder
Overrides

setSsml(String value)

public SynthesisInput.Builder setSsml(String value)

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;

Parameter
Name Description
value String

The ssml to set.

Returns
Type Description
SynthesisInput.Builder

This builder for chaining.

setSsmlBytes(ByteString value)

public SynthesisInput.Builder setSsmlBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for ssml to set.

Returns
Type Description
SynthesisInput.Builder

This builder for chaining.

setText(String value)

public SynthesisInput.Builder setText(String value)

The raw text to be synthesized.

string text = 1;

Parameter
Name Description
value String

The text to set.

Returns
Type Description
SynthesisInput.Builder

This builder for chaining.

setTextBytes(ByteString value)

public SynthesisInput.Builder setTextBytes(ByteString value)

The raw text to be synthesized.

string text = 1;

Parameter
Name Description
value ByteString

The bytes for text to set.

Returns
Type Description
SynthesisInput.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SynthesisInput.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SynthesisInput.Builder
Overrides