VoicesScreenViewModel

State holder for the Voices screen.

Exposes reactive voice data and action methods for the UI layer. The default implementation is DefaultVoicesScreenViewModel.

This can be used standalone (without NavigationControlsState) to build a custom voices UI.

Properties

Distinct languages available across all compatible voices.

abstract val selectedLanguage: StateFlow<String?>

Currently selected language filter, or null for all languages.

abstract val voices: StateFlow<List<VoiceUiModel>>

All compatible voices, filtered by selectedLanguage when set.

abstract fun install(voiceName: String)

Start downloading a voice package.

abstract fun onCleared()

Release resources. Must be called when the screen is destroyed.

abstract fun playWelcome(voiceName: String)

Play the welcome/demo audio for a voice.

abstract fun selectLanguage(language: String?)

Filter voices by language. Pass null to show all languages.

abstract fun selectVoice(voiceName: String)

Select a voice for navigation by name. Persists the choice.

abstract fun uninstall(voiceName: String)

Remove a downloaded voice package.