Struct RealtimeClient 

pub struct RealtimeClient { /* private fields */ }

The main client for interacting with the OpenAI Realtime API.

Thread safety: RealtimeClient is Send but not Sync because the underlying WebSocket stream is not Sync.

Implementations

impl RealtimeClient

pub async fn connect( api_key: &str, model: Option<&str>, call_id: Option<&str>, ) -> Result<Self>

Connect to the OpenAI Realtime API.

Errors

Returns an error if the connection fails or if the URL is invalid.

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

Send a client event to the server.

Errors

Returns an error if serialization fails or if the WebSocket send fails.

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

Receive the next server event.

Errors

Returns an error if deserialization fails or if the WebSocket fails.

pub fn split(self) -> (RealtimeSender, RealtimeReceiver)

Split the client into a sender and a receiver for concurrent usage.

pub fn unsplit( sender: RealtimeSender, receiver: RealtimeReceiver, ) -> Result<Self>

Re-unify a split client.

Errors

Returns an error if the split halves don’t match or cannot be reunited.