Struct RealtimeSession 

pub struct RealtimeSession { /* private fields */ }

An active Realtime API session.

Provides methods for sending events and receiving responses.

Implementations

impl RealtimeSession

pub async fn send(&mut self, event: ClientEvent) -> Result<()>

Send a client event to the server.

pub async fn recv(&mut self) -> Result<Option<ServerEvent>>

Receive the next server event.

Returns None if the connection is closed.

pub async fn update_session(&mut self, config: SessionConfig) -> Result<()>

Update the session configuration.

pub async fn append_audio(&mut self, audio_base64: &str) -> Result<()>

Append base64-encoded audio to the input buffer.

pub async fn append_audio_bytes(&mut self, audio: &[u8]) -> Result<()>

Append raw audio bytes to the input buffer.

The bytes will be base64 encoded automatically.

pub async fn commit_audio(&mut self) -> Result<()>

Commit the input audio buffer.

Creates a user message item from the buffered audio.

pub async fn clear_audio(&mut self) -> Result<()>

Clear the input audio buffer.

pub async fn create_item(&mut self, item: ConversationItem) -> Result<()>

Create a conversation item.

pub async fn send_text(&mut self, text: &str) -> Result<()>

Send a text message.

pub async fn create_response( &mut self, config: Option<ResponseCreateConfig>, ) -> Result<()>

Create a response from the model.

pub async fn cancel_response(&mut self) -> Result<()>

Cancel the current response.

pub async fn submit_function_output( &mut self, call_id: &str, output: &str, ) -> Result<()>

Submit the output of a function call.

pub async fn delete_item(&mut self, item_id: &str) -> Result<()>

Delete a conversation item.

pub async fn truncate_item( &mut self, item_id: &str, content_index: u32, audio_end_ms: u32, ) -> Result<()>

Truncate a conversation item’s audio.

pub async fn close(&mut self) -> Result<()>

Close the session.