Interface: UseRealtimeReturn
Defined in: react/src/hooks/use-realtime.ts:43
Return value from the useRealtime hook.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
connect | (credential: CredentialInput) => Promise<void> | Connect to the realtime model with the given credential. | react/src/hooks/use-realtime.ts:52 |
disconnect | () => void | Disconnect from the realtime model. | react/src/hooks/use-realtime.ts:57 |
mute | () => void | Mute audio input. | react/src/hooks/use-realtime.ts:67 |
muted | boolean | Whether audio input is muted. | react/src/hooks/use-realtime.ts:62 |
sendMessage | (text: string) => void | Send a text message to the model. | react/src/hooks/use-realtime.ts:77 |
status | TransportStatus | Current connection status. | react/src/hooks/use-realtime.ts:47 |
unmute | () => void | Unmute audio input. | react/src/hooks/use-realtime.ts:72 |