Function: useRealtime()
function useRealtime<TContext>(agent: RealtimeAgent<TContext>, options: UseRealtimeOptions<TContext>): UseRealtimeReturn;Defined in: react/src/hooks/use-realtime.ts:100
React hook for managing a realtime voice session.
Handles connection lifecycle, status updates, and cleanup on unmount.
Type Parameters
| Type Parameter |
|---|
TContext |
Parameters
| Parameter | Type |
|---|---|
agent | RealtimeAgent<TContext> |
options | UseRealtimeOptions<TContext> |
Returns
Example
const { status, connect, disconnect } = useRealtime(agent, {
model: openai.realtime("gpt-4o-realtime"),
channel,
ctx: { setCart },
});
const start = async () => {
const { credential } = await fetch("/api/credential").then(r => r.json());
await channel.init();
connect(credential);
};