RealtimeTranportEventTypes
type RealtimeTranportEventTypes = object;Indexable
Section titled “Indexable”[key: string]: any[]Properties
Section titled “Properties”*
*: [TransportEvent];A raw event from the transport layer. Allows a user to tap directly into the events of the transport layer.
audio: [TransportLayerAudio];Triggered when there is new audio data available. Might not be triggered if the transport layer handles the audio internally (WebRTC).
audio_done
Section titled “audio_done”audio_done: [];Triggered when the audio generation is done.
audio_interrupted
Section titled “audio_interrupted”audio_interrupted: [];Triggered when the model detected that it was interrupted. This can be used by the client to stop audio playback.
audio_transcript_delta
Section titled “audio_transcript_delta”audio_transcript_delta: [TransportLayerTranscriptDelta];Triggered when there is a new text delta of the transcript available.
connection_change
Section titled “connection_change”connection_change: [ConnectionStatus];Triggered whenever the connection status of the transport changes. Emits the new status after the change.
error: [TransportError];Triggered if the model / transport layer encountered an error
function_call
Section titled “function_call”function_call: [TransportToolCallEvent];Triggered when the model is trying to call a function.
item_deleted
Section titled “item_deleted”item_deleted: [RealtimeBaseItem];Triggered when an item is deleted.
item_update
Section titled “item_update”item_update: [RealtimeItem];Triggered when the history is added or updated.
turn_done
Section titled “turn_done”turn_done: [TransportLayerResponseCompleted];Triggered when the model is done generating a response for a turn.
turn_started
Section titled “turn_started”turn_started: [TransportLayerResponseStarted];Triggered when the model starts generating a response for a turn.
usage_update
Section titled “usage_update”usage_update: [Usage];Triggered when the usage update is available.