Class Voice (2.34.0)

public final class Voice extends GeneratedMessageV3 implements VoiceOrBuilder

Description of a voice supported by the TTS service.

Protobuf type google.cloud.texttospeech.v1.Voice

Implements

VoiceOrBuilder

Static Fields

LANGUAGE_CODES_FIELD_NUMBER

public static final int LANGUAGE_CODES_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NATURAL_SAMPLE_RATE_HERTZ_FIELD_NUMBER

public static final int NATURAL_SAMPLE_RATE_HERTZ_FIELD_NUMBER
Field Value
TypeDescription
int

SSML_GENDER_FIELD_NUMBER

public static final int SSML_GENDER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Voice getDefaultInstance()
Returns
TypeDescription
Voice

getDescriptor()

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

newBuilder()

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

newBuilder(Voice prototype)

public static Voice.Builder newBuilder(Voice prototype)
Parameter
NameDescription
prototypeVoice
Returns
TypeDescription
Voice.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Voice getDefaultInstanceForType()
Returns
TypeDescription
Voice

getLanguageCodes(int index)

public String getLanguageCodes(int index)

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The languageCodes at the given index.

getLanguageCodesBytes(int index)

public ByteString getLanguageCodesBytes(int index)

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the languageCodes at the given index.

getLanguageCodesCount()

public int getLanguageCodesCount()

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Returns
TypeDescription
int

The count of languageCodes.

getLanguageCodesList()

public ProtocolStringList getLanguageCodesList()

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Returns
TypeDescription
ProtocolStringList

A list containing the languageCodes.

getName()

public String getName()

The name of this voice. Each distinct voice has a unique name.

string name = 2;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of this voice. Each distinct voice has a unique name.

string name = 2;

Returns
TypeDescription
ByteString

The bytes for name.

getNaturalSampleRateHertz()

public int getNaturalSampleRateHertz()

The natural sample rate (in hertz) for this voice.

int32 natural_sample_rate_hertz = 4;

Returns
TypeDescription
int

The naturalSampleRateHertz.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSsmlGender()

public SsmlVoiceGender getSsmlGender()

The gender of this voice.

.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;

Returns
TypeDescription
SsmlVoiceGender

The ssmlGender.

getSsmlGenderValue()

public int getSsmlGenderValue()

The gender of this voice.

.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;

Returns
TypeDescription
int

The enum numeric value on the wire for ssmlGender.

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 Voice.Builder newBuilderForType()
Returns
TypeDescription
Voice.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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