Voice Sessions

Create and control realtime assistant-ui voice sessions, state, controls, and helpers.

API Reference

createVoiceSession

options : { abortSignal?: AbortSignal; }

abortSignal ?: AbortSignal

aborted : boolean
onabort : ((this:AbortSignal,ev:Event)=>any)|null
reason : any
throwIfAborted : () => void
addEventListener : { <K>(type: K, listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }
removeEventListener : { <K>(type: K, listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }
dispatchEvent : (event: Event) => boolean: The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent(). MDN Reference

setup : (helpers: VoiceSessionHelpers) => Promise<VoiceSessionControls>

RealtimeVoiceAdapter

connect : (options: { abortSignal?: AbortSignal; }) => RealtimeVoiceAdapter.Session

const useVoiceControls: () => { connect: () => void; disconnect: () => void; mute: () => void; unmute: () => void; };

const useVoiceState: () => VoiceSessionState;

const useVoiceVolume: () => number;

VoiceSessionControls

VoiceSessionHelpers

setStatus : (status: RealtimeVoiceAdapter.Status) => void
end : (reason: "finished" | "cancelled" | "error", error?: unknown) => void
emitTranscript : (item: RealtimeVoiceAdapter.TranscriptItem) => void
emitMode : (mode: RealtimeVoiceAdapter.Mode) => void
emitVolume : (volume: number) => void
isDisposed : () => boolean

VoiceSessionState

status : RealtimeVoiceAdapter.Status

isMuted : boolean

mode : RealtimeVoiceAdapter.Mode