Interface UseWhistleRecorderReturn

Recording actions using the engine supplied to useWhistleRecorder.

interface UseWhistleRecorderReturn {
    error: WhistleError | undefined;
    result: WhistleTranscript | undefined;
    status: WhistleRecorderStatus;
    cancel(): void;
    start(): Promise<WhistleTranscript>;
    stop(): Promise<WhistleTranscript | undefined>;
}

Hierarchy (View Summary)

WhistleRecorderState
- UseWhistleRecorderReturn

Index

Methods

cancel start stop

Properties

error result status

Methods

cancel

cancel(): void
Discard this recording or cancel its queued/active transcription without cancelling other calls.

Returns void
- Defined in packages/react/src/types.ts:104

start

start(): Promise<WhistleTranscript>
Start capture from a user gesture after the supplied hook reports ready.

Returns Promise<WhistleTranscript>
The eventual transcript after manual/automatic stop, not merely capture readiness. Repeated starts during an operation return that operation's completion promise.

Throws
WhistleError for microphone, readiness, decoding, inference, cancellation or disposal.
- Defined in packages/react/src/types.ts:96

stop

stop(): Promise<WhistleTranscript | undefined>
Stop and transcribe; repeated calls during an operation share its completion. Releasing before permission arrives cancels and stops any late granted tracks.

Returns Promise<WhistleTranscript | undefined>
The operation's transcript, or undefined if idle. Cancellation rejects with ABORTED.
- Defined in packages/react/src/types.ts:102

Properties

`Readonly`error

error: WhistleError | undefined

Latest capture/transcription failure, including ABORTED; cleared at the next start.

`Readonly`result

result: WhistleTranscript | undefined

Last successful recorded-clip transcript, retained on cancellation.

`Readonly`status

status: WhistleRecorderStatus

Current activity. Automatic stop advances to transcribing after PCM decoding completes.