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.v1.SynthesisInput
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SynthesisInput.Builder newBuilder()
newBuilder(SynthesisInput prototype)
public static SynthesisInput.Builder newBuilder(SynthesisInput prototype)
parseDelimitedFrom(InputStream input)
public static SynthesisInput parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SynthesisInput parseFrom(byte[] data)
| Parameter |
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SynthesisInput parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static SynthesisInput parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static SynthesisInput parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SynthesisInput parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SynthesisInput> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name | Description |
obj | Object
|
Overrides 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.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];
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.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public SynthesisInput getDefaultInstanceForType()
getInputSourceCase()
public SynthesisInput.InputSourceCase getInputSourceCase()
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.v1.MultiSpeakerMarkup multi_speaker_markup = 4;
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;
getParserForType()
public Parser<SynthesisInput> getParserForType()
Overrides 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()
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 |
ByteString | The bytes for prompt. |
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type | Description |
int | |
Overrides 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()
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.v1.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.v1.MultiSpeakerMarkup multi_speaker_markup = 4;
| Returns |
| Type | Description |
boolean | Whether the multiSpeakerMarkup field is set. |
hasPrompt()
public boolean hasPrompt()
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 |
boolean | Whether the prompt field is set. |
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()
The raw text to be synthesized.
string text = 1;
| Returns |
| Type | Description |
boolean | Whether the text field is set. |
hashCode()
| Returns |
| Type | Description |
int | |
Overrides internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides isInitialized()
public final boolean isInitialized()
Overrides newBuilderForType()
public SynthesisInput.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SynthesisInput.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type | Description |
Object | |
Overrides toBuilder()
public SynthesisInput.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides 