TtsLocalizationService - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > TtsLocalizationService

TtsLocalizationService class

Text-to-speech localization service to retrieve localized strings for voice synthesis.

This class provides methods to get localized strings based on string IDs. The returned strings are localized according to the current SdkSettings.voice setting.

These strings are intended for text-to-speech output and may differ from UI strings where a voice-specific variant exists.

Localization Service

Signature:

export declare abstract class TtsLocalizationService

Methods

Method	Modifiers	Description
getLanguageNativeName(language)	`static`	Retrieves the native name of the given language for TTS. The native name is the language's name in that language itself and can be used to present language choices to users in their own language.
getString(stringId, useDefaultString)	`static`	Retrieves a localized TTS string for the given string ID. If useDefaultString is true and the string ID is not found for the currently selected TTS voice/language, the default string (English) will be returned instead of an empty string. If the string ID does not exist, an empty string is returned.
getStrings(stringIds, useDefaultString)	`static`	Retrieves multiple localized TTS strings for the given list of string IDs. If useDefaultString is true and a string ID is not available for the currently selected TTS voice/language, the default string (English) will be returned instead of an empty string. If a string ID does not exist, an empty string is returned for that ID.

Method

Modifiers

Description

getLanguageNativeName(language)

static

Retrieves the native name of the given language for TTS.

The native name is the language's name in that language itself and can be used to present language choices to users in their own language.

getString(stringId, useDefaultString)

static

Retrieves a localized TTS string for the given string ID.

If useDefaultString is true and the string ID is not found for the currently selected TTS voice/language, the default string (English) will be returned instead of an empty string. If the string ID does not exist, an empty string is returned.

getStrings(stringIds, useDefaultString)

static

Retrieves multiple localized TTS strings for the given list of string IDs.

If useDefaultString is true and a string ID is not available for the currently selected TTS voice/language, the default string (English) will be returned instead of an empty string. If a string ID does not exist, an empty string is returned for that ID.