Audio/com.mapbox.navigation.audio.text

Package-level declarations

Types

AndroidTextToSpeechVoice

class AndroidTextToSpeechVoice(val voice: Voice) : Voice

Represents a voice used by the Android Text-to-Speech (TTS) engine.

Announcement

sealed class Announcement : AudioMixer.Clip

Construct that defines the text to be played using the voice injected.

AudioMixer

interface AudioMixer

AudioMixer manages audio clips in prioritized tracks, ensuring that clips are played in the order of insertion while allowing higher-priority clips to interrupt lower-priority clips.

LanguageRepository

interface LanguageRepository

Interface representing a repository for managing languages and voices.

LanguageRepositoryImpl

class LanguageRepositoryImpl(val initialVoice: Voice = DefaultVoice, val initialLanguage: Locale = Locale.getDefault()) : LanguageRepository

Implementation of LanguageRepository, providing state management for languages and voices.

LocalTtsPlayer

interface LocalTtsPlayer

Interface for a local Text-to-Speech (TTS) player.

NotificationAlert

sealed class NotificationAlert : AudioMixer.Clip

Represents a notification alert that plays a sound when triggered.

PersonaVoice

data class PersonaVoice(val personaVoiceId: String, val personaName: String) : Voice

Describes the voice to be used with the default Player instance.

PlatformAudioPlayerFactory

class PlatformAudioPlayerFactory(context: Context, languageRepository: LanguageRepository, sharedReachability: SharedReachability, voicePlayerOptionsProvider: VoicePlayerOptionsProvider, playerOptions: PlayerOptions = PlayerOptions.Builder().build(), ttsEngine: String? = null)

Factory for instantiating the services required for the playing voice announcements.

Player

interface Player

An API that allows you to interact with the speech player.

PlayerCallback

interface PlayerCallback

The PlayerCallback interface defines the callbacks that are triggered during the playback of an announcement by a VoicePlayer.

PlayerOptions

class PlayerOptions

PlayerOptions.

PlayerState

sealed class PlayerState

Exposes current state of the Player.

RemoteTtsApiClient

interface RemoteTtsApiClient

Defines a remote Text-to-Speech (TTS) API client.

RemoteTtsPlayer

interface RemoteTtsPlayer

Interface representing a remote text-to-speech (TTS) player.

RemoteTtsPlayerSwitcher

class RemoteTtsPlayerSwitcher : CoroutineMiddleware<MiddlewareContext> , RemoteTtsPlayer

Manages switching between different remote TTS players dynamically.

Sound

sealed class Sound

Represents different types of sounds that can be played.

SoundPlayer

interface SoundPlayer

Interface representing a sound player for handling various sound effects.

SpeechFileManager

interface SpeechFileManager

Manages the lifecycle of speech files for Text-To-Speech operations, including their creation, caching, and deletion. Links announcements with speech file progress, allowing observation of file creation status through Announcement.mediaCacheId and SpeechFileProgress.mediaCacheId matching.

SpeechFilePlayer

interface SpeechFilePlayer

Interface for playing speech files.

SpeechFileProgress

data class SpeechFileProgress(val mediaCacheId: String, val text: String, val filePath: String, val bytesRead: Long, val isDone: Boolean)

Tracks creation progress and state of speech files. It facilitates cache management by enabling the eviction of obsolete files and the cleanup of files interrupted during creation. This mechanism ensures efficient cache use and aids in maintaining a clean file storage by removing incomplete or unused speech files upon the next app start.

SpeechPlayerPerformance

object SpeechPlayerPerformance

Manages performance measurements related to speech playback.

StableVoicePlayerOptionsProvider

class StableVoicePlayerOptionsProvider(stableVoicePlayerOptions: VoicePlayerOptions) : VoicePlayerOptionsProvider

Simple VoicePlayerOptionsProvider implementation with one stable option

TtsApiException

class TtsApiException(message: String, cause: Throwable? = null) : RuntimeException

Represents an exception that occurs in the TTS API.

Voice

interface Voice

Describes the voice to be used with player.

VoiceAnnouncement

sealed class VoiceAnnouncement

Represents a voice announcement, which can be either local or remote.

VoicePlayer

interface VoicePlayer

The VoicePlayer interface defines the contract for a voice playback system. Implementations may use Text-to-Speech (TTS) engines to play back announcements.

VoicePlayerMiddlewareContext

class VoicePlayerMiddlewareContext(val context: Context, val language: StateFlow<Locale>, val voice: StateFlow<Voice?>, val audioFocusManager: AudioFocusManager, val soundPlayer: SoundPlayer) : MiddlewareContext

Provides context needed for the middleware to operate.

VoicePlayerOptions

data class VoicePlayerOptions(val apiHost: String, val accessToken: String, val voices: Set<PersonaVoice>)

Options used to initialize the default VoicePlayer instance.

VoicePlayerOptionsProvider

interface VoicePlayerOptionsProvider

Options provider used to initialize a VoicePlayer instance.

VoiceProgress

interface VoiceProgress

Represents the progress of a voice announcement.

Properties

TTS_PROVIDER_CORE

const val TTS_PROVIDER_CORE: String

The identifier for the core TTS provider.

Functions

measureDownload

fun Announcement.measureDownload(): Measure

Starts measuring the TTS download time for this Announcement.