TextToSpeechOptions interface

Options to configure the MediaPipe Text-to-Speech Task.

Signature:

export declare interface TextToSpeechOptions extends TaskRunnerOptions 

Extends: TaskRunnerOptions

Properties

Property Type Description
cacheDirectory string | undefined Optional directory path for caching compiled XNNPACK / WebGPU weights in the WASM virtual filesystem. Defaults to '/tmp'.
defaultLocale string | undefined Default BCP-47 locale tag (for example, 'en-US'). Defaults to 'en-US'.
defaultVoiceId string | undefined Default voice identifier to use when not overridden in SynthesisOptions.
modelAssetSize number | undefined Total byte size of the model asset when streaming via ReadableStreamDefaultReader.
speakingRate number | undefined Speaking rate multiplier (for example, 1.0 for normal speed). Defaults to 1.0.
targetBucket number | undefined Optional bucket size in tokens for acoustic model execution.

TextToSpeechOptions.cacheDirectory

Optional directory path for caching compiled XNNPACK / WebGPU weights in the WASM virtual filesystem. Defaults to '/tmp'.

Signature:

cacheDirectory?: string;

TextToSpeechOptions.defaultLocale

Default BCP-47 locale tag (for example, 'en-US'). Defaults to 'en-US'.

Signature:

defaultLocale?: string;

TextToSpeechOptions.defaultVoiceId

Default voice identifier to use when not overridden in SynthesisOptions.

Signature:

defaultVoiceId?: string;

TextToSpeechOptions.modelAssetSize

Total byte size of the model asset when streaming via ReadableStreamDefaultReader.

Signature:

modelAssetSize?: number;

TextToSpeechOptions.speakingRate

Speaking rate multiplier (for example, 1.0 for normal speed). Defaults to 1.0.

Signature:

speakingRate?: number;

TextToSpeechOptions.targetBucket

Optional bucket size in tokens for acoustic model execution.

Signature:

targetBucket?: number;