MapboxVoiceInstructionsPlayer

@UiThread()
class MapboxVoiceInstructionsPlayer @JvmOverloads() constructor(context: Context, accessToken: String, language: String, options: VoiceInstructionsPlayerOptions, audioFocusDelegate: AudioFocusDelegate)
Content copied to clipboard

Hybrid implementation of MapboxVoiceInstructionsPlayer combining VoiceInstructionsTextPlayer and VoiceInstructionsFilePlayer speech players.

Constructors

MapboxVoiceInstructionsPlayer
Link copied to clipboard
@JvmOverloads()
fun MapboxVoiceInstructionsPlayer(context: Context, accessToken: String, language: String, options: VoiceInstructionsPlayerOptions = VoiceInstructionsPlayerOptions.Builder() .build(), audioFocusDelegate: AudioFocusDelegate = buildAndroidAudioFocus(context, options))
Content copied to clipboard

Functions

clear
Link copied to clipboard
fun clear()
Content copied to clipboard
Clears any announcements queued.
equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
Content copied to clipboard
hashCode
Link copied to clipboard
open fun hashCode(): Int
Content copied to clipboard
play
Link copied to clipboard
fun play(announcement: SpeechAnnouncement, consumer: MapboxNavigationConsumer<SpeechAnnouncement>)
Content copied to clipboard
Given SpeechAnnouncement the method will play the voice instruction.
shutdown
Link copied to clipboard
fun shutdown()
Content copied to clipboard
Releases the resources used by the speech player.
toString
Link copied to clipboard
open fun toString(): String
Content copied to clipboard
volume
Link copied to clipboard
fun volume(state: SpeechVolume)
Content copied to clipboard
The method will set the volume to the specified level from SpeechVolume.