NotificationFormatOption (API Reference)
Enum Class NotificationFormatOption
- All Implemented Interfaces:
Serializable,Comparable<NotificationFormatOption>,Constable
Indicates the formatting option of phoneme included in the notification.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionNo phoneme is used for this option as plain orthographic form is included in the notification.Phoneme in SSML format is included in the notification, only ifManeuverNotificationOptions.enablePhonemeoption is set totrue. -
Method Summary
Modifier and TypeMethodDescriptionstatic NotificationFormatOptionReturns the enum constant of this class with the specified name.static NotificationFormatOption[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
PLAIN
No phoneme is used for this option as plain orthographic form is included in the notification. Example: 'After 300 meters turn right onto Wall Street.'.
-
SSML
Phoneme in SSML format is included in the notification, only if
ManeuverNotificationOptions.enablePhonemeoption is set totrue. Example: 'After 300 meters turn right onto '. This format is compatible with and supported by native android.speech.tts.TextToSpeech for Android. Other 3rd party TTS engines may also support it. Please check https://www.w3.org/TR/speech-synthesis11/ for detailed information about the SSML format.<lang xml:lang="ENG"> <phoneme alphabet="nts" ph=""wɔːl"striːt" orthmode="ignorepunct">Wall Street</phoneme></lang>.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException- if the argument is null
-