Interface: RealtimeChannel

Defined in: packages/protocol/src/realtime/types.ts:21

Base interface for audio I/O channels.

Channels bridge between audio sources (browser mic, Twilio, Discord) and the realtime session. They handle audio capture/playback and emit events that the session listens to.

Extends

• TypedEmitter<RealtimeChannelEvents>

Methods

close()

close(): void;

Defined in: packages/protocol/src/realtime/types.ts:37

Clean up resources and close the channel.

Returns

void

emit()

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

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

Type Parameters

Parameters

Returns

boolean

Inherited from

TypedEmitter.emit

interrupt()

interrupt(): void;

Defined in: packages/protocol/src/realtime/types.ts:32

Interrupt current audio playback. Called by session when response is cancelled.

Returns

void

off()

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

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

Type Parameters

Parameters

Returns

this

Inherited from

TypedEmitter.off

on()

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

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

Type Parameters

Parameters

Returns

this

Inherited from

TypedEmitter.on

once()

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

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

Type Parameters

Parameters

Returns

this

Inherited from

TypedEmitter.once

sendAudio()

sendAudio(audio: string): void;

Defined in: packages/protocol/src/realtime/types.ts:26

Send audio to be played/transmitted by the channel. Called by session when audio is received from the model.

Parameters

Returns

void