UI Voice/com.mapbox.navigation.ui.voice.api/MapboxAudioGuidance

MapboxAudioGuidance

class MapboxAudioGuidance : MapboxNavigationObserver

Implementation of MapboxAudioGuidance. See interface for details.

Types

object Companion

Functions

getCurrentVoiceInstructionsPlayer

fun getCurrentVoiceInstructionsPlayer(): MapboxVoiceInstructionsPlayer?

Current instance of a VoiceInstructionsPlayer.

fun mute()

Explicit call to mute the audio guidance state.

open override fun onAttached(mapboxNavigation: MapboxNavigation)

open override fun onDetached(mapboxNavigation: MapboxNavigation)

fun stateFlow(): StateFlow<MapboxAudioGuidanceState>

This flow gives you access to the state of mapbox audio guidance without effecting state.

fun toggle()

Toggle the muted state. E.g., if audio is muted, make it unmuted.

fun unmute()

Explicit call to unmute the audio guidance state.

updateSpeechApiOptions

fun updateSpeechApiOptions(options: MapboxSpeechApiOptions)

Updates MapboxSpeechApiOptions that was provided during MapboxAudioGuidance creation.