MapboxSpeechApi

class MapboxSpeechApi @JvmOverloads() constructor(context: Context, accessToken: String, language: String, options: MapboxSpeechApiOptions)

Mapbox Speech Api that allows you to generate an announcement based on VoiceInstructions

Constructors

MapboxSpeechApi

androidJvm

@JvmOverloads()

fun MapboxSpeechApi(context: Context, accessToken: String, language: String, options: MapboxSpeechApiOptions = MapboxSpeechApiOptions.Builder().build())

Functions

cancel

androidJvm

fun cancel()

The method stops the process of retrieving the file voice instruction SpeechAnnouncement and destroys any related callbacks.

clean

androidJvm

fun clean(announcement: SpeechAnnouncement)

Given the SpeechAnnouncement the method may cleanup any associated files previously generated.

equals

androidJvm

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

generate

androidJvm

fun generate(voiceInstruction: VoiceInstructions, consumer: MapboxNavigationConsumer<Expected<SpeechError, SpeechValue>>)

Given VoiceInstructions the method will try to generate the voice instruction SpeechAnnouncement including the synthesized speech mp3 file from Mapbox's API Voice.

hashCode

androidJvm

open fun hashCode(): Int

toString

androidJvm

open fun toString(): String