Interface: RealtimeConnection

Defined in: packages/protocol/src/realtime/model.ts:67

An active bidirectional connection to a realtime model.

One connection per session. Providers implement this interface.

Extends

TypedEmitter<RealtimeConnectionEvents>

Properties

Property	Modifier	Type	Description	Defined in
`muted`	`readonly`	`boolean` \| `null`	Whether input audio is muted. null if muting is not handled by the connection.	packages/protocol/src/realtime/model.ts:78
`providerMetadata?`	`readonly`	`SharedProviderMetadata`	Provider-specific metadata.	packages/protocol/src/realtime/model.ts:88
`sessionId`	`readonly`	`string` \| `null`	Session ID once connected.	packages/protocol/src/realtime/model.ts:83
`status`	`readonly`	`TransportStatus`	Current connection status.	packages/protocol/src/realtime/model.ts:72

Methods

close()

close(): void;

Defined in: packages/protocol/src/realtime/model.ts:98

Close the connection.

Returns

void

emit()

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

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

Type Parameters

Type Parameter
`K` extends keyof `RealtimeConnectionEvents`

Parameters

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

Returns

boolean

Inherited from

TypedEmitter.emit

interrupt()

interrupt(): void;

Defined in: packages/protocol/src/realtime/model.ts:114

Interrupt the current response. Convenience for sending response.cancel event.

Returns

void

mute()

mute(): void;

Defined in: packages/protocol/src/realtime/model.ts:103

Mute input audio.

Returns

void

off()

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

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

Type Parameters

Type Parameter
`K` extends keyof `RealtimeConnectionEvents`

Parameters

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

Returns

this

Inherited from

TypedEmitter.off

on()

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

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

Type Parameters

Type Parameter
`K` extends keyof `RealtimeConnectionEvents`

Parameters

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

Returns

this

Inherited from

TypedEmitter.on

once()

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

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

Type Parameters

Type Parameter
`K` extends keyof `RealtimeConnectionEvents`

Parameters

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

Returns

this

Inherited from

TypedEmitter.once

send()

send(event: RealtimeClientEvent): void;

Defined in: packages/protocol/src/realtime/model.ts:93

Send a client event to the model.

Parameters

Parameter	Type
`event`	`RealtimeClientEvent`

Returns

void

unmute()

unmute(): void;

Defined in: packages/protocol/src/realtime/model.ts:108

Unmute input audio.

Returns

void

On this page