AudioClient.md

foundry-local-sdk / AudioClient

Class: AudioClient

Client for performing audio operations (transcription, translation) with a loaded model. Follows the OpenAI Audio API structure.

Properties

settings

settings: AudioClientSettings;

Configuration settings for audio operations.

Methods

transcribe()

transcribe(audioFilePath): Promise<any>;

Transcribes audio into the input language.

Parameters

Parameter	Type	Description
audioFilePath	string	Path to the audio file to transcribe.

Returns

Promise<any>

The transcription result.

Throws

Error - If audioFilePath is invalid or transcription fails.

---

transcribeStreaming()

transcribeStreaming(audioFilePath): AsyncIterable<any>;

Transcribes audio into the input language using streaming, returning an async iterable of chunks.

Parameters

Parameter	Type	Description
audioFilePath	string	Path to the audio file to transcribe.

Returns

AsyncIterable<any>

An async iterable that yields parsed streaming transcription chunks.

Throws

Error - If audioFilePath is invalid, or streaming fails.

Example

for await (const chunk of audioClient.transcribeStreaming('recording.wav')) {
    process.stdout.write(chunk.text);
}