SpeechPlayer

interface SpeechPlayer

Defines a contract for speech players used in NavigationView.

Functions

isMuted
Link copied to clipboard
abstract fun isMuted(): Boolean
true if currently muted, false if not
onDestroy
Link copied to clipboard
abstract fun onDestroy()
Used to stop and release the media (if needed).
onOffRoute
Link copied to clipboard
abstract fun onOffRoute()
Used in off-route scenarios to stop currentannouncement (if playing) and voice a rerouting cue.
play
Link copied to clipboard
abstract fun play(speechAnnouncement: VoiceInstructions)
Will play the given string speechAnnouncement.
setMuted
Link copied to clipboard
abstract fun setMuted(isMuted: Boolean)
Will determine if voice announcements will be played or not.

Inheritors

MapboxSpeechPlayer
Link copied to clipboard
AndroidSpeechPlayer
Link copied to clipboard
NavigationSpeechPlayer
Link copied to clipboard