Class RealtimeVoiceController

Reuses the shipped realtime client stack for the widget's voice modality.

Implements

IVoiceController

Index

Constructors

Accessors

Methods

Constructors

constructor

new RealtimeVoiceController(
    mint: VoiceMintFn,
    limits?: VoiceAbuseLimits,
    enabledChannels?: readonly string[],
    relayTool?: RelayToolFn,
): RealtimeVoiceController
Parameters
- mint: VoiceMintFn
- Optionallimits: VoiceAbuseLimits
- enabledChannels: readonly string[] = []
  Interactive channels (by name) the widget may attach this session (from the minted session).
- OptionalrelayTool: RelayToolFn
  Live relay for non-channel tool calls; omitted when no channels are enabled (no OnToolCall wiring).
Returns RealtimeVoiceController
- Defined in packages/Web/RealtimeWidget/src/voice/realtime-voice-controller.ts:60

Accessors

IsActive

get IsActive(): boolean
Whether a voice session is currently active.

Returns boolean
Implementation of IVoiceController.IsActive
- Defined in packages/Web/RealtimeWidget/src/voice/realtime-voice-controller.ts:69

Methods

Start

Start(callbacks: VoiceControllerCallbacks): Promise<void>
Begins a voice session (mints, connects, acquires mic, enforces ceilings).
Parameters
- callbacks: VoiceControllerCallbacks
Returns Promise<void>
Implementation of IVoiceController.Start
- Defined in packages/Web/RealtimeWidget/src/voice/realtime-voice-controller.ts:73

Stop

Stop(): Promise<void>
Ends the active voice session.

Returns Promise<void>
Implementation of IVoiceController.Stop
- Defined in packages/Web/RealtimeWidget/src/voice/realtime-voice-controller.ts:107