MapboxAudioGuidance

interface MapboxAudioGuidance : MapboxNavigationObserver

Service interface accessible through MapboxCarApp.carAppServices

It will start monitoring audio guidance once the class is referenced because it is lazy loaded. Use the controllable functions mute, unmute, toggle to change the voice guidance. The selection is saved to shared preferences and will become the default setting.

Subscribing onto the stateFlow does not change the internal state.

Types

State

androidJvm

interface State

Accessed through stateFlow.

Functions

equals

androidJvm

open operator fun equals(other: Any?): Boolean

hashCode

androidJvm

open fun hashCode(): Int

mute

androidJvm

abstract fun mute()

Continue to monitor voice instructions, but stop the audio voice.

onAttached

androidJvm

abstract fun onAttached(mapboxNavigation: MapboxNavigation)

onDetached

androidJvm

abstract fun onDetached(mapboxNavigation: MapboxNavigation)

stateFlow

androidJvm

abstract fun stateFlow(): StateFlow<MapboxAudioGuidance.State>

Monitor the voice instructions state.

toggle

androidJvm

abstract fun toggle()

Toggle the state between mute and unmute.

toString

androidJvm

open fun toString(): String

unmute

androidJvm

abstract fun unmute()

Turn on the audio voice.

Inheritors

MapboxAudioGuidanceImpl