@heumes-it/expo-mapbox-navigation - v0.1.0
    Preparing search index...

    Interface ConfigureTtsOptions

    TTS configuration. All fields are optional; unset fields preserve the current value. Calling configureTts before a session is started stores the config and it is applied on the next startActiveGuidance.

    interface ConfigureTtsOptions {
        enabled?: boolean;
        engine?: TtsEngine;
        speechRate?: number;
        voiceIdentifier?: string;
        volume?: number;
    }
    Index

    Properties

    enabled? engine? speechRate? voiceIdentifier? volume?

    Properties

    enabled?: boolean

    Default true. When false, JS still receives onVoiceInstruction events but the native speaker is muted.

    engine?: TtsEngine

    Default 'platform'. Selects the TTS playback engine.

    speechRate?: number

    0.5–2.0. Playback rate multiplier.

    voiceIdentifier?: string

    Preferred voice identifier. Platform-specific:

    • iOS: an AVSpeechSynthesisVoice language/identifier (e.g., "en-US").
    • Android: a TextToSpeech Locale tag (e.g., "en_US"). Unset = device default. Ignored when engine is 'mapbox'.
    volume?: number

    0.0–1.0. Maps to AVAudioSession on iOS and the Android audio stream volume.

    Settings

    Member Visibility

    On This Page

    Properties