AudioOutputProvider

Audio output provider interface for the 'output' pipeline role.

Defined in: src/core/types/providers.ts:1367

Audio output provider interface for the 'output' pipeline role.

Remarks

An AudioOutputProvider receives synthesized audio from the TTS stage and plays it through a destination (e.g. speakers, file, null sink). It is the last stage of the 5-role pipeline:

[AudioInputProvider] -> InputQueue -> [STT] -> [LLM] -> [TTS] -> OutputQueue -> [AudioOutputProvider]
                                                                                 ^^^^^^^^^^^^^^^^^^^

Providers implementing this interface must set roles to include 'output'. Multi-role providers (e.g. NativeTTS) may also include 'tts' when the underlying API handles both synthesis and playback internally.

Lifecycle: initialize() -> configure(metadata) -> enqueue(chunk) (repeated) -> flush() -> stop() -> dispose()

Example

import type { AudioOutputProvider, AudioChunk, AudioMetadata } from 'composite-voice';

class MySpeakerOutput implements AudioOutputProvider {
  readonly type = 'websocket';
  readonly roles = ['output'] as const;

  async initialize() { /* set up AudioContext */ }
  async dispose() { /* close AudioContext */ }
  isReady() { return true; }

  configure(metadata: AudioMetadata) { /* configure playback format */ }
  enqueue(chunk: AudioChunk) { /* buffer chunk for playback */ }
  async flush() { /* wait for all queued audio to finish playing */ }
  stop() { /* stop playback immediately */ }
  pause() { /* pause playback */ }
  resume() { /* resume playback */ }
  isPlaying() { return false; }

  onPlaybackStart(callback: () => void) { /* ... */ }
  onPlaybackEnd(callback: () => void) { /* ... */ }
  onPlaybackError(callback: (error: Error) => void) { /* ... */ }
}

See

BaseProvider for lifecycle methods
AudioChunk for the audio data type
AudioMetadata for the metadata type
AudioInputProvider for the corresponding input role

Extends

BaseProvider

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`roles`	`readonly`	readonly `ProviderRole`[]	`[]`	Pipeline roles this provider covers. Remarks Each provider declares which stages of the 5-role audio pipeline it can fulfil. Single-role providers list one role (e.g. `['stt']`); multi-role providers list every role they handle (e.g. `['input', 'stt']` for NativeSTT, which manages its own microphone access). The provider resolution algorithm reads this property to assign providers to pipeline slots. Base provider classes set sensible defaults: - BaseSTTProvider: `['stt']` - BaseLLMProvider: `['llm']` - BaseTTSProvider: `['tts']` See - ProviderRole for the possible role values - ResolvedPipeline for the resolved pipeline slots	`BaseProvider`.`roles`	src/core/types/providers.ts:166
`type`	`readonly`	`ProviderType`	`undefined`	The communication type this provider uses. See ProviderType	`BaseProvider`.`type`	src/core/types/providers.ts:144

Methods

configure()

configure(metadata): void;

Defined in: src/core/types/providers.ts:1380

Configure the output with the audio format metadata from the TTS provider.

Parameters

Parameter	Type	Description
`metadata`	`AudioMetadata`	Format description for the incoming audio

Returns

void

Remarks

Called when the TTS provider emits metadata describing the format of incoming audio chunks. The output provider uses this to configure its playback pipeline (e.g. AudioContext sample rate).