Class: RealtimeConversation

Manages the state and events of a realtime conversation. Handles conversation items, audio queuing, and event processing.

RealtimeConversation

Constructors

Constructor

new RealtimeConversation(): RealtimeConversation

Creates a new RealtimeConversation instance. Initializes empty conversation state.

Returns

RealtimeConversation

Properties

defaultFrequency

readonly defaultFrequency: number = 24000

Default audio sampling frequency in Hz

Methods

clear()

clear(): boolean

Clears the conversation history and resets to default

Returns

boolean

Always returns true

getItem()

getItem(id): null | ItemType

Retrieves a item by id

Parameters

id

string

Item ID

Returns

null | ItemType

The item or null if not found

getItems()

getItems(): ItemType[]

Gets all items in the conversation.

Returns

ItemType[]

Array of all conversation items

processEvent()

processEvent(event, …args): object

Process an event from the WebSocket server and compose items

Parameters

event

any

The event to process

args

…any[]

Additional arguments

Returns

object

Processed item and delta

delta

delta: null | ItemContentDelta

item

item: null | ItemType

queueInputAudio()

queueInputAudio(audio): Int16Array

Queues audio data for processing.

Parameters

audio

Int16Array

Audio data to queue

Returns

Int16Array

The queued audio data