Class CustomPronunciationParams (2.54.0)

public final class CustomPronunciationParams extends GeneratedMessageV3 implements CustomPronunciationParamsOrBuilder

Pronunciation customization for a phrase.

Protobuf type google.cloud.texttospeech.v1.CustomPronunciationParams

Static Fields

PHONETIC_ENCODING_FIELD_NUMBER

public static final int PHONETIC_ENCODING_FIELD_NUMBER
Field Value
Type Description
int

PHRASE_FIELD_NUMBER

public static final int PHRASE_FIELD_NUMBER
Field Value
Type Description
int

PRONUNCIATION_FIELD_NUMBER

public static final int PRONUNCIATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomPronunciationParams getDefaultInstance()
Returns
Type Description
CustomPronunciationParams

getDescriptor()

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

newBuilder()

public static CustomPronunciationParams.Builder newBuilder()
Returns
Type Description
CustomPronunciationParams.Builder

newBuilder(CustomPronunciationParams prototype)

public static CustomPronunciationParams.Builder newBuilder(CustomPronunciationParams prototype)
Parameter
Name Description
prototype CustomPronunciationParams
Returns
Type Description
CustomPronunciationParams.Builder

parseDelimitedFrom(InputStream input)

public static CustomPronunciationParams parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomPronunciationParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomPronunciationParams parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomPronunciationParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomPronunciationParams parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomPronunciationParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomPronunciationParams parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomPronunciationParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomPronunciationParams parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomPronunciationParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomPronunciationParams parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomPronunciationParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomPronunciationParams
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomPronunciationParams> parser()
Returns
Type Description
Parser<CustomPronunciationParams>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CustomPronunciationParams getDefaultInstanceForType()
Returns
Type Description
CustomPronunciationParams

getParserForType()

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

getPhoneticEncoding()

public CustomPronunciationParams.PhoneticEncoding getPhoneticEncoding()

The phonetic encoding of the phrase.

optional .google.cloud.texttospeech.v1.CustomPronunciationParams.PhoneticEncoding phonetic_encoding = 2;

Returns
Type Description
CustomPronunciationParams.PhoneticEncoding

The phoneticEncoding.

getPhoneticEncodingValue()

public int getPhoneticEncodingValue()

The phonetic encoding of the phrase.

optional .google.cloud.texttospeech.v1.CustomPronunciationParams.PhoneticEncoding phonetic_encoding = 2;

Returns
Type Description
int

The enum numeric value on the wire for phoneticEncoding.

getPhrase()

public String getPhrase()

The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.

optional string phrase = 1;

Returns
Type Description
String

The phrase.

getPhraseBytes()

public ByteString getPhraseBytes()

The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.

optional string phrase = 1;

Returns
Type Description
ByteString

The bytes for phrase.

getPronunciation()

public String getPronunciation()

The pronunciation of the phrase. This must be in the phonetic encoding specified above.

optional string pronunciation = 3;

Returns
Type Description
String

The pronunciation.

getPronunciationBytes()

public ByteString getPronunciationBytes()

The pronunciation of the phrase. This must be in the phonetic encoding specified above.

optional string pronunciation = 3;

Returns
Type Description
ByteString

The bytes for pronunciation.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasPhoneticEncoding()

public boolean hasPhoneticEncoding()

The phonetic encoding of the phrase.

optional .google.cloud.texttospeech.v1.CustomPronunciationParams.PhoneticEncoding phonetic_encoding = 2;

Returns
Type Description
boolean

Whether the phoneticEncoding field is set.

hasPhrase()

public boolean hasPhrase()

The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.

optional string phrase = 1;

Returns
Type Description
boolean

Whether the phrase field is set.

hasPronunciation()

public boolean hasPronunciation()

The pronunciation of the phrase. This must be in the phonetic encoding specified above.

optional string pronunciation = 3;

Returns
Type Description
boolean

Whether the pronunciation 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 CustomPronunciationParams.Builder newBuilderForType()
Returns
Type Description
CustomPronunciationParams.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomPronunciationParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomPronunciationParams.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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