tts/nl.marc_apps.tts/TextToSpeechInstance

TextToSpeechInstance

interface TextToSpeechInstance : Closeable

A TTS instance. Should be closed when no longer in use.

Types

Companion

object Companion

Status

enum Status : Enum<TextToSpeechInstance.Status>

Functions

abstract override fun close()

Clears the internal queue and closes used resources (if possible)

enqueue

abstract fun enqueue(text: String, clearQueue: Boolean = false)

Adds the given text to the internal queue, unless isMuted is true or volume equals 0.

plusAssign

abstract operator fun plusAssign(text: String)

Adds the given text to the internal queue, unless isMuted is true or volume equals 0.

say

abstract fun say(text: String, clearQueue: Boolean = false, callback: (Result<TextToSpeechInstance.Status>) -> Unit)

abstract suspend fun say(text: String, clearQueue: Boolean = false, resumeOnStatus: TextToSpeechInstance.Status = Status.FINISHED)

Adds the given text to the internal queue, unless isMuted is true or volume equals 0.

stop

abstract fun stop()

Clears the internal queue, but doesn't close used resources.

Properties

isMuted

abstract var isMuted: Boolean

Alternative to setting volume to zero. Setting this to true (and back to false) doesn't change the value of volume. Changes only affect new calls to the say method.

language

abstract val language: String

Returns a BCP 47 language tag of the selected voice on supported platforms. May return the language code as ISO 639 on older platforms.

pitch

abstract var pitch: Float

rate

abstract var rate: Float

volume

abstract var volume: Int

The output volume, which is an integer between 0 and 100, set to 100(%) by default. Changes only affect new calls to the say method.

Inheritors

TextToSpeechInstanceWithJsPromises

Sources

common source