Locale topic

The Locale module exposes the SDK language and voice models used across map labels, routing text, and TTS. They are used in other modules to configure language and voice preferences.

  • Language: Represents a language configuration with human-readable name, ISO language and region codes, script code and rendering variant, and a flag for text direction. Use it to express SDK API or TTS language preference and to obtain the best language match from SDK settings.
  • Voice: Describes a voice asset (human or computer) including display name, associated Language, absolute voice file path, type, and internal identifier. Use Voice instances to inspect available voices and to apply a selected voice for navigation and TTS playback.

Classes

Language Locale
Complete language specification used throughout the SDK.
Voice Locale
Voice information object.

Enums

ScriptVariant Locale
Script variant types.
VoiceType Locale
Enumerates available voice types for TTS and voice playback.