AnnounceFormat
enum AnnounceFormat : Enum<AnnounceFormat> Defines the format used for direction announcements during turn-by-turn navigation.
When the SDK announces an upcoming turn or direction change, this enum controls how the direction is communicated to the user. Different formats suit different accessibility needs and user preferences. For example, visually impaired users may prefer CLOCK format for its precision, while RELATIVE is the most universally understood.
See also
| RoutingStatusRepository |
DEFAULT_ANNOUNCE_FORMAT |
Entries
RELATIVE | RELATIVERelative direction format using left/right terminology (e.g., “turn left”, “turn right”, “continue straight”). |
CARDINAL | CARDINALCardinal direction format using compass points (e.g., “head north”, “turn south-east”). |
CLOCK | CLOCKClock-face direction format using hour positions (e.g., “turn at 3 o’clock”, “continue at 12 o’clock”). Particularly useful for accessibility. |
Properties
entries
val entries: EnumEntries<AnnounceFormat>Returns a representation of an immutable list of all enum entries, in the order they’re declared.
name
val name: Stringordinal
val ordinal: IntFunctions
valueOf
fun valueOf(value: String): AnnounceFormatReturns 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.)
values
fun values(): Array<AnnounceFormat>Returns an array containing the constants of this enum type, in the order they’re declared.