ClientRealtimeEvent

sealed interface ClientRealtimeEvent

Events the client sends into a realtime session.

The gateway is responsible for translating these into the provider's wire format (e.g. OpenAI's session.update, input_audio_buffer.append, etc.). Consumers never construct OpenAI-shaped JSON directly.

Inheritors

Types

Link copied to clipboard
data class FunctionCallOutput(val callId: String, val output: String) : ClientRealtimeEvent

Submit a tool result for a previously-emitted function call.

Link copied to clipboard

Append a PCM frame to the server-side input audio buffer.

Link copied to clipboard

Clear any pending audio in the input buffer.

Link copied to clipboard

End the current user turn (only meaningful when VadConfig.Manual).

Link copied to clipboard

Cancel an in-flight response (used for interruption / barge-in).

Link copied to clipboard

Ask the model to produce the next response.

Link copied to clipboard

Set / replace the session config.

Link copied to clipboard
data class UserText(val text: String) : ClientRealtimeEvent

Insert a text user message into the conversation.