com.google.cloud.texttospeech.v1

Enum SsmlVoiceGender

java.lang.Object

java.lang.Enum<SsmlVoiceGender>

com.google.cloud.texttospeech.v1.SsmlVoiceGender

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, Serializable, Comparable<SsmlVoiceGender>

public enum SsmlVoiceGender
extends Enum<SsmlVoiceGender>
implements ProtocolMessageEnum

 Gender of the voice as described in
 [SSML voice element](https://www.w3.org/TR/speech-synthesis11/#edef_voice).
 

Protobuf enum google.cloud.texttospeech.v1.SsmlVoiceGender

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEMALE A female voice.
MALE A male voice.
NEUTRAL A gender-neutral voice.
SSML_VOICE_GENDER_UNSPECIFIED An unspecified gender.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	FEMALE_VALUE A female voice.
static int	MALE_VALUE A male voice.
static int	NEUTRAL_VALUE A gender-neutral voice.
static int	SSML_VOICE_GENDER_UNSPECIFIED_VALUE An unspecified gender.

Method Summary

Modifier and Type	Method and Description
static SsmlVoiceGender	forNumber(int value)
static Descriptors.EnumDescriptor	getDescriptor()
Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
Descriptors.EnumValueDescriptor	getValueDescriptor()
static Internal.EnumLiteMap<SsmlVoiceGender>	internalGetValueMap()
static SsmlVoiceGender	valueOf(Descriptors.EnumValueDescriptor desc)
static SsmlVoiceGender	valueOf(int value) Deprecated. Use forNumber(int) instead.
static SsmlVoiceGender	valueOf(String name) Returns the enum constant of this type with the specified name.
static SsmlVoiceGender[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SSML_VOICE_GENDER_UNSPECIFIED

public static final SsmlVoiceGender SSML_VOICE_GENDER_UNSPECIFIED

 An unspecified gender.
 In VoiceSelectionParams, this means that the client doesn't care which
 gender the selected voice will have. In the Voice field of
 ListVoicesResponse, this may mean that the voice doesn't fit any of the
 other categories in this enum, or that the gender of the voice isn't known.
 

SSML_VOICE_GENDER_UNSPECIFIED = 0;

MALE

public static final SsmlVoiceGender MALE

 A male voice.
 

MALE = 1;

FEMALE

public static final SsmlVoiceGender FEMALE

 A female voice.
 

FEMALE = 2;

NEUTRAL

public static final SsmlVoiceGender NEUTRAL

 A gender-neutral voice. This voice is not yet supported.
 

NEUTRAL = 3;

UNRECOGNIZED

public static final SsmlVoiceGender UNRECOGNIZED

Field Detail

SSML_VOICE_GENDER_UNSPECIFIED_VALUE

public static final int SSML_VOICE_GENDER_UNSPECIFIED_VALUE

 An unspecified gender.
 In VoiceSelectionParams, this means that the client doesn't care which
 gender the selected voice will have. In the Voice field of
 ListVoicesResponse, this may mean that the voice doesn't fit any of the
 other categories in this enum, or that the gender of the voice isn't known.
 

SSML_VOICE_GENDER_UNSPECIFIED = 0;

See Also:

Constant Field Values

MALE_VALUE

public static final int MALE_VALUE

 A male voice.
 

MALE = 1;

See Also:

Constant Field Values

FEMALE_VALUE

public static final int FEMALE_VALUE

 A female voice.
 

FEMALE = 2;

See Also:

Constant Field Values

NEUTRAL_VALUE

public static final int NEUTRAL_VALUE

 A gender-neutral voice. This voice is not yet supported.
 

NEUTRAL = 3;

See Also:

Constant Field Values

Method Detail

values

public static SsmlVoiceGender[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SsmlVoiceGender c : SsmlVoiceGender.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SsmlVoiceGender valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface Internal.EnumLite

Specified by:

getNumber in interface ProtocolMessageEnum

valueOf

@Deprecated
public static SsmlVoiceGender valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static SsmlVoiceGender forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static Internal.EnumLiteMap<SsmlVoiceGender> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static SsmlVoiceGender valueOf(Descriptors.EnumValueDescriptor desc)