Class: WebSocketTransport
Defined in: packages/kernl/src/realtime/transport.ts:47
WebSocket transport for realtime connections.
Use this transport when you need to provide a custom WebSocket implementation, such as the 'ws' package in Node.js <22.
Example
// Node.js <22
import WebSocket from 'ws';
const session = new RealtimeSession(agent, {
transport: new WebSocketTransport({ websocket: WebSocket }),
...
});
// Browser or Node.js 22+ - no transport needed
const session = new RealtimeSession(agent, { ... });Implements
Constructors
Constructor
new WebSocketTransport(options?: WebSocketTransportOptions): WebSocketTransport;Defined in: packages/kernl/src/realtime/transport.ts:51
Parameters
| Parameter | Type |
|---|---|
options? | WebSocketTransportOptions |
Returns
WebSocketTransport
Properties
| Property | Modifier | Type | Default value | Description | Defined in |
|---|---|---|---|---|---|
handlesAudio | readonly | false | false | Whether this transport handles audio I/O internally (e.g., WebRTC). If true, cannot use a channel with this transport. | packages/kernl/src/realtime/transport.ts:48 |
Methods
connect()
connect(model: RealtimeModel, options?: RealtimeConnectOptions): Promise<RealtimeConnection>;Defined in: packages/kernl/src/realtime/transport.ts:55
Create a connection using this transport.
Parameters
| Parameter | Type |
|---|---|
model | RealtimeModel |
options? | RealtimeConnectOptions |
Returns
Promise<RealtimeConnection>