Class: RealtimeSession<TContext>

Defined in: packages/kernl/src/realtime/session.ts:36

A realtime session manages the connection to a realtime model.

Handles the bidirectional communication between an agent and a model, including audio I/O (via channels), tool execution, and event routing.

Extends

Emitter<RealtimeSessionEvents>

Type Parameters

Type Parameter	Default type
`TContext`	`UnknownContext`

Constructors

Constructor

new RealtimeSession<TContext>(agent: RealtimeAgent<TContext>, options: RealtimeSessionOptions<TContext>): RealtimeSession<TContext>;

Defined in: packages/kernl/src/realtime/session.ts:74

Parameters

Parameter	Type
`agent`	`RealtimeAgent`<`TContext`>
`options`	`RealtimeSessionOptions`<`TContext`>

Returns

RealtimeSession<TContext>

Overrides

Emitter<RealtimeSessionEvents>.constructor

Properties

Property	Modifier	Type	Default value	Description	Defined in
`agent`	`readonly`	`RealtimeAgent`<`TContext`>	`undefined`	The agent definition.	packages/kernl/src/realtime/session.ts:47
`channel`	`readonly`	\| `RealtimeChannel` \| `null`	`undefined`	The audio I/O channel (if any).	packages/kernl/src/realtime/session.ts:57
`context`	`readonly`	`Context`<`TContext`>	`undefined`	The session context.	packages/kernl/src/realtime/session.ts:62
`id`	`public`	`string` \| `null`	`null`	Session ID. Null until connected.	packages/kernl/src/realtime/session.ts:42
`model`	`readonly`	`RealtimeModel`	`undefined`	The realtime model.	packages/kernl/src/realtime/session.ts:52

Methods

close()

close(): void;

Defined in: packages/kernl/src/realtime/session.ts:185

Close the session and release resources.

Returns

void

commit()

commit(): void;

Defined in: packages/kernl/src/realtime/session.ts:146

Commit the audio buffer (signal end of speech).

Returns

void

connect()

connect(): Promise<void>;

Defined in: packages/kernl/src/realtime/session.ts:96

Connect to the realtime model.

Returns

Promise<void>

emit()

emit<K>(event: K, ...args: RealtimeSessionEvents[K]): boolean;

Defined in: packages/shared/dist/emitter.d.ts:28

Type Parameters

Type Parameter
`K` extends keyof `RealtimeSessionEvents`

Parameters

Parameter	Type
`event`	`K`
...`args`	`RealtimeSessionEvents`[`K`]

Returns

boolean

Inherited from

Emitter.emit

interrupt()

interrupt(): void;

Defined in: packages/kernl/src/realtime/session.ts:163

Interrupt the current response.

Returns

void

mute()

mute(): void;

Defined in: packages/kernl/src/realtime/session.ts:171

Mute audio input.

Returns

void

off()

off<K>(event: K, listener: (...args: RealtimeSessionEvents[K]) => void): this;

Defined in: packages/shared/dist/emitter.d.ts:26

Type Parameters

Type Parameter
`K` extends keyof `RealtimeSessionEvents`

Parameters

Parameter	Type
`event`	`K`
`listener`	(...`args`: `RealtimeSessionEvents`[`K`]) => `void`

Returns

this

Inherited from

Emitter.off

on()

on<K>(event: K, listener: (...args: RealtimeSessionEvents[K]) => void): this;

Defined in: packages/shared/dist/emitter.d.ts:25

Type Parameters

Type Parameter
`K` extends keyof `RealtimeSessionEvents`

Parameters

Parameter	Type
`event`	`K`
`listener`	(...`args`: `RealtimeSessionEvents`[`K`]) => `void`

Returns

this

Inherited from

Emitter.on

once()

once<K>(event: K, listener: (...args: RealtimeSessionEvents[K]) => void): this;

Defined in: packages/shared/dist/emitter.d.ts:27

Type Parameters

Type Parameter
`K` extends keyof `RealtimeSessionEvents`

Parameters

Parameter	Type
`event`	`K`
`listener`	(...`args`: `RealtimeSessionEvents`[`K`]) => `void`

Returns

this

Inherited from

Emitter.once

sendAudio()

sendAudio(audio: string): void;

Defined in: packages/kernl/src/realtime/session.ts:139

Send audio to the model.

Parameters

Parameter	Type
`audio`	`string`

Returns

void

sendMessage()

sendMessage(text: string): void;

Defined in: packages/kernl/src/realtime/session.ts:153

Send a text message to the model.

Parameters

Parameter	Type
`text`	`string`

Returns

void

unmute()

unmute(): void;

Defined in: packages/kernl/src/realtime/session.ts:178

Unmute audio input.

Returns

void

On this page