Remy Reference/interface/VoiceSessionState

VoiceSessionState

Type

The lifecycle of a live session, from connecting to ended.

The five states a live session moves through, published by the agent and delivered on the stateChange event: connecting while the session is minted, listening when the mic is live and waiting, thinking while the agent works (tool calls included), speaking while it talks, and ended when the call is over. Drive the session's on-screen visual from these, and always pair the visual with a text label.

VoiceSessionState.ts

type VoiceSessionState =
  | 'connecting'
  | 'listening'
  | 'thinking'
  | 'speaking'
  | 'ended'

Drive the on-screen visual

session.on('stateChange', (state: VoiceSessionState) => setOrbState(state));