tts/nl.marc_apps.tts/TextToSpeechInstanceWithJsPromises

TextToSpeechInstanceWithJsPromises

interface TextToSpeechInstanceWithJsPromises : TextToSpeechInstance(source)

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)

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

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.

sayJsPromise

abstract fun sayJsPromise(text: String, clearQueue: Boolean = false, resumeOnStatus: TextToSpeechInstance.Status = TextToSpeechInstance.Status.FINISHED): Promise<Unit>

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.

isSynthesizing

abstract val isSynthesizing: StateFlow<Boolean>

isWarmingUp

abstract val isWarmingUp: StateFlow<Boolean>

Value indicating if the engine is warming up. Is true after enqueue or say has been called the first time, but before isSynthesizing is true. Is false otherwise.

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.