Skip to main content

WhisperModule

aac-voice-api


Interface: WhisperModule

Defined in: whisper/libstream.d.ts:3

Methods

free()

free(index): void

Defined in: whisper/libstream.d.ts:16

Free resources associated with a specific index.

Parameters

ParameterTypeDescription
indexnumberResource index

Returns

void


FS_createDataFile()

FS_createDataFile(parent, name, data, canRead, canWrite, canOwn?): void

Defined in: whisper/libstream.d.ts:44

Parameters

ParameterType
parentstring
namestring
dataArrayBuffer | Uint8Array<ArrayBufferLike>
canReadboolean
canWriteboolean
canOwn?boolean

Returns

void


FS_createPath()

FS_createPath(parent, path, canRead?, canWrite?): string

Defined in: whisper/libstream.d.ts:58

Parameters

ParameterType
parentstring
pathstring
canRead?boolean
canWrite?boolean

Returns

string


FS_preloadFile()

FS_preloadFile(localPath, url, onload?, onerror?): void

Defined in: whisper/libstream.d.ts:53

Parameters

ParameterType
localPathstring
urlstring
onload?() => void
onerror?() => void

Returns

void


FS_unlink(path): void

Defined in: whisper/libstream.d.ts:55

Parameters

ParameterType
pathstring

Returns

void


get_status()

get_status(): string

Defined in: whisper/libstream.d.ts:36

Get the current module status.

Returns

string

Status string ("loading" | "ready" | "error")


get_transcribed()

get_transcribed(): string

Defined in: whisper/libstream.d.ts:30

Get the latest transcribed string from the module.

Returns

string

Transcribed text


init()

init(urlToPath, langCode): number

Defined in: whisper/libstream.d.ts:10

Initialize the module with a model path and language code.

Parameters

ParameterTypeDescription
urlToPathstringPath or URL to the model binary
langCodestringLanguage code (e.g., "en", "fr")

Returns

number

number (usually success/error code)


set_audio()

set_audio(index, audio): number

Defined in: whisper/libstream.d.ts:24

Set audio data for a specific index.

Parameters

ParameterTypeDescription
indexnumberResource index
audionumber[] | Float32Array<ArrayBufferLike>JavaScript array of audio samples (Float32Array, number[])

Returns

number

number (success/error code)


set_status()

set_status(status): void

Defined in: whisper/libstream.d.ts:42

Update the module status.

Parameters

ParameterTypeDescription
statusstringStatus string ("loading"

Returns

void