Function useRealtimeChat

packages/ai-react/src/use-realtime-chat.ts:57–296

(
  options: UseRealtimeChatOptions,
)

 * ```
 */
export function useRealtimeChat(
  options: UseRealtimeChatOptions,
): UseRealtimeChatReturn {
  // State
  const [status, setStatus] = useState<RealtimeStatus>('idle')
  const [mode, setMode] = useState<RealtimeMode>('idle')
  const [messages, setMessages] = useState<Array<RealtimeMessage>>([])
  const [pendingUserTranscript, setPendingUserTranscript] = useState<
    string | null
  >(null)
  const [pendingAssistantTranscript, setPendingAssistantTranscript] = useState<
    string | null
  >(null)
  const [error, setError] = useState<Error | null>(null)
  const [inputLevel, setInputLevel] = useState(0)
  const [outputLevel, setOutputLevel] = useState(0)
  const [vadMode, setVADModeState] = useState<'server' | 'semantic' | 'manual'>(
    options.vadMode ?? 'server',
  )

  // Refs
  const clientRef = useRef<RealtimeClient | null>(null)
  const optionsRef = useRef(options)
  optionsRef.current = options
  const animationFrameRef = useRef<number | null>(null)

  // Create client instance - use ref to ensure we reuse the same instance
  // This handles React StrictMode double-rendering
  if (!clientRef.current) {
    // Each optional source field is spread conditionally because the
    // `RealtimeClientOptions` target declares strict optionals
    // (`field?: T`) and `exactOptionalPropertyTypes` rejects passing
    // `undefined` for absent values.
    const initial = optionsRef.current
    clientRef.current = new RealtimeClient({
      getToken: initial.getToken,
      adapter: initial.adapter,
      ...(initial.tools !== undefined && { tools: initial.tools }),
      ...(initial.instructions !== undefined && {
        instructions: initial.instructions,
      }),
      ...(initial.voice !== undefined && { voice: initial.voice }),
      ...(initial.autoPlayback !== undefined && {
        autoPlayback: initial.autoPlayback,
      }),
      ...(initial.autoCapture !== undefined && {
        autoCapture: initial.autoCapture,
      }),
      ...(initial.vadMode !== undefined && { vadMode: initial.vadMode }),
      ...(initial.outputModalities !== undefined && {
        outputModalities: initial.outputModalities,
      }),
      ...(initial.temperature !== undefined && {
        temperature: initial.temperature,
      }),
      ...(initial.maxOutputTokens !== undefined && {
        maxOutputTokens: initial.maxOutputTokens,
      }),