Class SynthesizeSpeechRequest (2.42.0)

public final class SynthesizeSpeechRequest extends GeneratedMessageV3 implements SynthesizeSpeechRequestOrBuilder

The top-level message sent by the client for the SynthesizeSpeech method.

Protobuf type google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest

Static Fields

AUDIO_CONFIG_FIELD_NUMBER

public static final int AUDIO_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_TIME_POINTING_FIELD_NUMBER

public static final int ENABLE_TIME_POINTING_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_FIELD_NUMBER

public static final int INPUT_FIELD_NUMBER
Field Value
TypeDescription
int

VOICE_FIELD_NUMBER

public static final int VOICE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SynthesizeSpeechRequest getDefaultInstance()
Returns
TypeDescription
SynthesizeSpeechRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SynthesizeSpeechRequest.Builder newBuilder()
Returns
TypeDescription
SynthesizeSpeechRequest.Builder

newBuilder(SynthesizeSpeechRequest prototype)

public static SynthesizeSpeechRequest.Builder newBuilder(SynthesizeSpeechRequest prototype)
Parameter
NameDescription
prototypeSynthesizeSpeechRequest
Returns
TypeDescription
SynthesizeSpeechRequest.Builder

parseDelimitedFrom(InputStream input)

public static SynthesizeSpeechRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SynthesizeSpeechRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SynthesizeSpeechRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SynthesizeSpeechRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SynthesizeSpeechRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SynthesizeSpeechRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SynthesizeSpeechRequest> parser()
Returns
TypeDescription
Parser<SynthesizeSpeechRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAudioConfig()

public AudioConfig getAudioConfig()

Required. The configuration of the synthesized audio.

.google.cloud.texttospeech.v1beta1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AudioConfig

The audioConfig.

getAudioConfigOrBuilder()

public AudioConfigOrBuilder getAudioConfigOrBuilder()

Required. The configuration of the synthesized audio.

.google.cloud.texttospeech.v1beta1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AudioConfigOrBuilder

getDefaultInstanceForType()

public SynthesizeSpeechRequest getDefaultInstanceForType()
Returns
TypeDescription
SynthesizeSpeechRequest

getEnableTimePointing(int index)

public SynthesizeSpeechRequest.TimepointType getEnableTimePointing(int index)

Whether and what timepoints are returned in the response.

repeated .google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest.TimepointType enable_time_pointing = 4;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
SynthesizeSpeechRequest.TimepointType

The enableTimePointing at the given index.

getEnableTimePointingCount()

public int getEnableTimePointingCount()

Whether and what timepoints are returned in the response.

repeated .google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest.TimepointType enable_time_pointing = 4;

Returns
TypeDescription
int

The count of enableTimePointing.

getEnableTimePointingList()

public List<SynthesizeSpeechRequest.TimepointType> getEnableTimePointingList()

Whether and what timepoints are returned in the response.

repeated .google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest.TimepointType enable_time_pointing = 4;

Returns
TypeDescription
List<TimepointType>

A list containing the enableTimePointing.

getEnableTimePointingValue(int index)

public int getEnableTimePointingValue(int index)

Whether and what timepoints are returned in the response.

repeated .google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest.TimepointType enable_time_pointing = 4;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
int

The enum numeric value on the wire of enableTimePointing at the given index.

getEnableTimePointingValueList()

public List<Integer> getEnableTimePointingValueList()

Whether and what timepoints are returned in the response.

repeated .google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest.TimepointType enable_time_pointing = 4;

Returns
TypeDescription
List<Integer>

A list containing the enum numeric values on the wire for enableTimePointing.

getInput()

public SynthesisInput getInput()

Required. The Synthesizer requires either plain text or SSML as input.

.google.cloud.texttospeech.v1beta1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SynthesisInput

The input.

getInputOrBuilder()

public SynthesisInputOrBuilder getInputOrBuilder()

Required. The Synthesizer requires either plain text or SSML as input.

.google.cloud.texttospeech.v1beta1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SynthesisInputOrBuilder

getParserForType()

public Parser<SynthesizeSpeechRequest> getParserForType()
Returns
TypeDescription
Parser<SynthesizeSpeechRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getVoice()

public VoiceSelectionParams getVoice()

Required. The desired voice of the synthesized audio.

.google.cloud.texttospeech.v1beta1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
VoiceSelectionParams

The voice.

getVoiceOrBuilder()

public VoiceSelectionParamsOrBuilder getVoiceOrBuilder()

Required. The desired voice of the synthesized audio.

.google.cloud.texttospeech.v1beta1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
VoiceSelectionParamsOrBuilder

hasAudioConfig()

public boolean hasAudioConfig()

Required. The configuration of the synthesized audio.

.google.cloud.texttospeech.v1beta1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the audioConfig field is set.

hasInput()

public boolean hasInput()

Required. The Synthesizer requires either plain text or SSML as input.

.google.cloud.texttospeech.v1beta1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the input field is set.

hasVoice()

public boolean hasVoice()

Required. The desired voice of the synthesized audio.

.google.cloud.texttospeech.v1beta1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the voice field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SynthesizeSpeechRequest.Builder newBuilderForType()
Returns
TypeDescription
SynthesizeSpeechRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SynthesizeSpeechRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SynthesizeSpeechRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SynthesizeSpeechRequest.Builder toBuilder()
Returns
TypeDescription
SynthesizeSpeechRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException