Interface: RealtimeSessionOptions<TContext>
Defined in: packages/kernl/src/realtime/types.ts:46
Options for creating a realtime session.
Type Parameters
| Type Parameter | Default type |
|---|---|
TContext | UnknownContext |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
channel? | RealtimeChannel | Audio I/O channel (e.g., BrowserChannel, TwilioChannel). Not used with WebRTC transport. | packages/kernl/src/realtime/types.ts:56 |
connectOptions? | RealtimeConnectOptions | Options passed to model.connect() or transport.connect(). | packages/kernl/src/realtime/types.ts:80 |
context? | Context<TContext> | Context for this session. | packages/kernl/src/realtime/types.ts:67 |
credential? | ClientCredential | Ephemeral credential for client-side connections. Obtained from model.authenticate() on the server. Shorthand for connectOptions.credential. | packages/kernl/src/realtime/types.ts:75 |
model? | RealtimeModel | Override the agent's default model for this session. | packages/kernl/src/realtime/types.ts:50 |
transport? | RealtimeTransport | Custom transport (e.g., WebRTCTransport). If not provided, model.connect() creates the default transport. | packages/kernl/src/realtime/types.ts:62 |