synthesize() - RunAnywhere Documentation

// Get the audio back
const audio = await RunAnywhere.tts.synthesize('Hello from RunAnywhere')

// Play it
const handle = RunAnywhere.tts.speak('Hello from RunAnywhere')

Signatures

synthesize(text: string, options?: TtsOptions): Promise<Audio>
synthesizeStream(text: string, options?: TtsOptions): AsyncIterable<AudioChunk>
speak(text: string, options?: TtsOptions): SpeechHandle
stop(): Promise<void>
voices(): Promise<Voice[]>

speak is synchronous on React Native and returns the handle immediately. stop is async. The pairing is the reverse of the Web SDK.

Options

const audio = await RunAnywhere.tts.synthesize('Hello', {
  voice: 'en_US-amy-medium',
  speed: 1.1,
})

Field	Type	Default
`voice`	`string`	none, model default
`language`	`string`	proto default
`speed`	`number`	proto default
`pitch`	`number`	proto default
`format`	`AudioFormat`	proto default
`sampleRate`	`number`	proto default

Stopping

await RunAnywhere.tts.stop()

Stops whatever is speaking.

Audio session

On iOS, playing audio while another app is playing needs the right audio session category. The SDK’s playback path handles the common case, but if your app already configures an audio session, configure it before speaking rather than after.

Saving to a file

const audio = await RunAnywhere.tts.synthesize('Save me')
// audio.samples is a Uint8Array; write it with your filesystem library of choice