NavigationSpeechPlayer

open class NavigationSpeechPlayer : SpeechPlayer
Content copied to clipboard

Used to play VoiceInstructionss.

Takes a SpeechPlayerProvider which will provide either a MapboxSpeechPlayer or AndroidSpeechPlayer based on the given language - if it is supported by our Voice API.

MapboxSpeechPlayer requires Internet connectivity. In cases where a connection is not available, the provider will fall back to the AndroidSpeechPlayer.

See also

com.mapbox.navigation.core.MapboxNavigation

MapboxNavigation#registerVoiceInstructionsObserver(VoiceInstructionsObserver)

Constructors

NavigationSpeechPlayer
Link copied to clipboard
open fun NavigationSpeechPlayer(speechPlayerProvider: SpeechPlayerProvider)
Content copied to clipboard

Functions

onDestroy
Link copied to clipboard
open fun onDestroy()
Content copied to clipboard
Required method to implement in onDestroy or onDestroy.
onOffRoute
Link copied to clipboard
open fun onOffRoute()
Content copied to clipboard
Optional method to implement in an OffRouteObserver.
play
Link copied to clipboard
open fun play(voiceInstructions: VoiceInstructions)
Content copied to clipboard
Plays the given VoiceInstructions.
abstract fun play(speechAnnouncement: VoiceInstructions)
Content copied to clipboard
Will play the given string speechAnnouncement.
setMuted
Link copied to clipboard
open fun setMuted(isMuted: Boolean)
Content copied to clipboard
Mutes or un-mutes the SpeechPlayer.

Properties

isMuted
Link copied to clipboard
private open val isMuted: Boolean
Content copied to clipboard