ai-elements-ui/dev.ai.elements.ui.voice/SpeechSettings

SpeechSettings

@Immutable

data class SpeechSettings(val recognizer: ComponentName? = null, val onDeviceRecognition: Boolean = false, val ttsEngine: String? = null, val voice: String? = null, val rate: Float = 1.0f, val pitch: Float = 1.0f)(source)

Which of the device's speech engines the voice elements use, and how they speak. Every field defaults to the system's choice, so an app only sets what its user picked (e.g. from recognitionServices and SpeechOutputState.engines in a settings screen).

Constructors

SpeechSettings

constructor(recognizer: ComponentName? = null, onDeviceRecognition: Boolean = false, ttsEngine: String? = null, voice: String? = null, rate: Float = 1.0f, pitch: Float = 1.0f)

Properties

onDeviceRecognition

val onDeviceRecognition: Boolean

recognise on the device, without sending audio anywhere, where the platform offers it (Android 12+, SpeechRecognizer.isOnDeviceRecognitionAvailable).

pitch

val pitch: Float

speech pitch, 1 = normal.

rate

val rate: Float

speech rate, 1 = normal.

recognizer

val recognizer: ComponentName?

a speech recognition service (android.speech.RecognitionService), e.g. the vendor's or Google's; null uses the system default.

ttsEngine

val ttsEngine: String?

a text-to-speech engine's package (TextToSpeech.EngineInfo.name); null uses the system default.

voice

val voice: String?

a voice of that engine (android.speech.tts.Voice.getName); null picks the engine's default for the language.