Interface: RealtimeConnectOptions
Defined in: packages/protocol/src/realtime/types.ts:40
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
abort? | AbortSignal | Abort signal for cancelling connection. | packages/protocol/src/realtime/types.ts:54 |
credential? | ClientCredential | Ephemeral credential for client-side connections. Obtained from model.authenticate() on the server. When provided, used instead of the model's API key. | packages/protocol/src/realtime/types.ts:67 |
providerOptions? | SharedProviderOptions | Provider-specific options. | packages/protocol/src/realtime/types.ts:59 |
resume? | SessionResumeConfig | Resume a previous session. | packages/protocol/src/realtime/types.ts:49 |
sessionConfig? | RealtimeSessionConfig | Initial session configuration. | packages/protocol/src/realtime/types.ts:44 |
websocket? | WebSocketConstructor | WebSocket constructor for browser/Node compatibility. Defaults to globalThis.WebSocket (available in browsers and Node 22+). For Node.js <22, provide the 'ws' package. Example import WebSocket from 'ws'; await model.connect({ websocket: WebSocket }); | packages/protocol/src/realtime/types.ts:81 |