Class: TextToSpeechModule

Defined in: packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:16

Module for Text to Speech (TTS) functionalities.

Constructors

Constructor

new TextToSpeechModule(): TextToSpeechModule

Returns

TextToSpeechModule

Properties

nativeModule

nativeModule: any = null

Defined in: packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:20

Native module instance

Methods

delete()

delete(): void

Defined in: packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:172

Unloads the model from memory.

Returns

void

---

forward()

forward(text, speed): Promise<Float32Array<ArrayBufferLike>>

Defined in: packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:99

Synthesizes the provided text into speech. Returns a promise that resolves to the full audio waveform as a Float32Array.

Parameters

text

string

The input text to be synthesized.

speed

number = 1.0

Optional speed multiplier for the speech synthesis (default is 1.0).

Returns

Promise<Float32Array<ArrayBufferLike>>

A promise resolving to the synthesized audio waveform.

---

load()

load(config, onDownloadProgressCallback): Promise<void>

Defined in: packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:29

Loads the model and voice assets specified by the config object. onDownloadProgressCallback allows you to monitor the current progress.

Parameters

config

TextToSpeechConfig

Configuration object containing model source and voice.

onDownloadProgressCallback

(progress) => void

Optional callback to monitor download progress.

Returns

Promise<void>

---

stream()

stream(input): AsyncGenerator<Float32Array<ArrayBufferLike>>

Defined in: packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:117

Starts a streaming synthesis session. Yields audio chunks as they are generated.

Parameters

input

TextToSpeechStreamingInput

Input object containing text and optional speed.

Returns

AsyncGenerator<Float32Array<ArrayBufferLike>>

An async generator yielding Float32Array audio chunks.

---

streamStop()

streamStop(): void

Defined in: packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:165

Stops the streaming process if there is any ongoing.

Returns

void