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

MapboxAudioGuidanceState

class MapboxAudioGuidanceState

Represents the state of MapboxAudioGuidance.

Functions

equals

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

Regenerate whenever a change is made

hashCode

open override fun hashCode(): Int

Regenerate whenever a change is made

toString

open override fun toString(): String

Regenerate whenever a change is made

Properties

isFirst

val isFirst: Boolean = false

Whether the voiceInstructions is the first one for this route. You can set different behaviour based on this information. For example, you can skip the starter instruction or always wait until it is downloaded instead of using onboard fallback.

isMuted

val isMuted: Boolean = false

Controlled by the MapboxAudioGuidance service. When MapboxAudioGuidance.mute is called this will be changed to true.

isPlayable

val isPlayable: Boolean = false

When the trip session has started, and there is an active route.

speechAnnouncement

val speechAnnouncement: SpeechAnnouncement? = null

After a voiceInstructions has been announced, this value will be emitted. This will always be null when isMuted is true.

voiceInstructions

val voiceInstructions: VoiceInstructions? = null

Once a voice instruction becomes available this will not be null. When the state isPlayable and this is null, it means there are no voice instructions on the route at this time.