Class SynthesisInput (2.45.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

Static Fields

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

getDefaultInstanceForType()

public SynthesisInput getDefaultInstanceForType()
Returns
Type Description
SynthesisInput

getInputSourceCase()

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

getParserForType()

public Parser<SynthesisInput> getParserForType()
Returns
Type Description
Parser<SynthesisInput>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException