Package com.google.cloud.texttospeech.v1

Enum CustomPronunciationParams.PhoneticEncoding

java.lang.Object
java.lang.Enum<CustomPronunciationParams.PhoneticEncoding>
com.google.cloud.texttospeech.v1.CustomPronunciationParams.PhoneticEncoding
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<CustomPronunciationParams.PhoneticEncoding>
Enclosing class:
CustomPronunciationParams
public static enum CustomPronunciationParams.PhoneticEncoding extends Enum<CustomPronunciationParams.PhoneticEncoding> implements com.google.protobuf.ProtocolMessageEnum
 The phonetic encoding of the phrase.
Protobuf enum google.cloud.texttospeech.v1.CustomPronunciationParams.PhoneticEncoding

  • Enum Constant Details

    • PHONETIC_ENCODING_UNSPECIFIED

      public static final CustomPronunciationParams.PhoneticEncoding PHONETIC_ENCODING_UNSPECIFIED
       Not specified.
      PHONETIC_ENCODING_UNSPECIFIED = 0;

    • PHONETIC_ENCODING_IPA

      public static final CustomPronunciationParams.PhoneticEncoding PHONETIC_ENCODING_IPA
       IPA, such as apple -> ˈæpəl.
 https://en.wikipedia.org/wiki/International_Phonetic_Alphabet
      PHONETIC_ENCODING_IPA = 1;

    • PHONETIC_ENCODING_X_SAMPA

      public static final CustomPronunciationParams.PhoneticEncoding PHONETIC_ENCODING_X_SAMPA
       X-SAMPA, such as apple -> "{p@l".
 https://en.wikipedia.org/wiki/X-SAMPA
      PHONETIC_ENCODING_X_SAMPA = 2;

    • PHONETIC_ENCODING_JAPANESE_YOMIGANA

      public static final CustomPronunciationParams.PhoneticEncoding PHONETIC_ENCODING_JAPANESE_YOMIGANA
       For reading-to-pron conversion to work well, the `pronunciation` field
 should only contain Kanji, Hiragana, and Katakana.

 The pronunciation can also contain pitch accents.
 The start of a pitch phrase is specified with `^` and the down-pitch
 position is specified with `!`, for example:

 phrase:端  pronunciation:^はし
 phrase:箸  pronunciation:^は!し
 phrase:橋  pronunciation:^はし!

 We currently only support the Tokyo dialect, which allows at most one
 down-pitch per phrase (i.e. at most one `!` between `^`).
      PHONETIC_ENCODING_JAPANESE_YOMIGANA = 3;

    • PHONETIC_ENCODING_PINYIN

      public static final CustomPronunciationParams.PhoneticEncoding PHONETIC_ENCODING_PINYIN
       Used to specify pronunciations for Mandarin words. See
 https://en.wikipedia.org/wiki/Pinyin.

 For example: 朝阳, the pronunciation is "chao2 yang2". The number
 represents the tone, and there is a space between syllables. Neutral
 tones are represented by 5, for example 孩子 "hai2 zi5".
      PHONETIC_ENCODING_PINYIN = 4;

    • UNRECOGNIZED

      public static final CustomPronunciationParams.PhoneticEncoding UNRECOGNIZED

  • Field Details

    • PHONETIC_ENCODING_UNSPECIFIED_VALUE

      public static final int PHONETIC_ENCODING_UNSPECIFIED_VALUE
       Not specified.
      PHONETIC_ENCODING_UNSPECIFIED = 0;
      See Also:

    • PHONETIC_ENCODING_IPA_VALUE

      public static final int PHONETIC_ENCODING_IPA_VALUE
       IPA, such as apple -> ˈæpəl.
 https://en.wikipedia.org/wiki/International_Phonetic_Alphabet
      PHONETIC_ENCODING_IPA = 1;
      See Also:

    • PHONETIC_ENCODING_X_SAMPA_VALUE

      public static final int PHONETIC_ENCODING_X_SAMPA_VALUE
       X-SAMPA, such as apple -> "{p@l".
 https://en.wikipedia.org/wiki/X-SAMPA
      PHONETIC_ENCODING_X_SAMPA = 2;
      See Also:

    • PHONETIC_ENCODING_JAPANESE_YOMIGANA_VALUE

      public static final int PHONETIC_ENCODING_JAPANESE_YOMIGANA_VALUE
       For reading-to-pron conversion to work well, the `pronunciation` field
 should only contain Kanji, Hiragana, and Katakana.

 The pronunciation can also contain pitch accents.
 The start of a pitch phrase is specified with `^` and the down-pitch
 position is specified with `!`, for example:

 phrase:端  pronunciation:^はし
 phrase:箸  pronunciation:^は!し
 phrase:橋  pronunciation:^はし!

 We currently only support the Tokyo dialect, which allows at most one
 down-pitch per phrase (i.e. at most one `!` between `^`).
      PHONETIC_ENCODING_JAPANESE_YOMIGANA = 3;
      See Also:

    • PHONETIC_ENCODING_PINYIN_VALUE

      public static final int PHONETIC_ENCODING_PINYIN_VALUE
       Used to specify pronunciations for Mandarin words. See
 https://en.wikipedia.org/wiki/Pinyin.

 For example: 朝阳, the pronunciation is "chao2 yang2". The number
 represents the tone, and there is a space between syllables. Neutral
 tones are represented by 5, for example 孩子 "hai2 zi5".
      PHONETIC_ENCODING_PINYIN = 4;
      See Also:

  • Method Details

    • values

      public static CustomPronunciationParams.PhoneticEncoding[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static CustomPronunciationParams.PhoneticEncoding 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 com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static CustomPronunciationParams.PhoneticEncoding valueOf(int value)
      Deprecated.
      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:
      value - 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

    • forNumber

      public static CustomPronunciationParams.PhoneticEncoding 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 com.google.protobuf.Internal.EnumLiteMap<CustomPronunciationParams.PhoneticEncoding> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static CustomPronunciationParams.PhoneticEncoding valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      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:
      desc - 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