Skip to main content

RealtimeSession

Struct RealtimeSession 

Source
pub struct RealtimeSession { /* private fields */ }
Expand description

An active realtime session.

Cheap to share indirectly via the channels it owns; call RealtimeSession::close to terminate the background task.

Implementations§

Source§

impl RealtimeSession

Source

pub async fn send_audio(&self, pcm: Bytes) -> ZaiResult<()>

Send raw 16-bit LE mono PCM (16 kHz) audio; it is wrapped in a WAV header, base64-encoded, and uploaded via input_audio_buffer.append.

Source

pub async fn commit_audio(&self) -> ZaiResult<()>

Commit buffered audio for inference (client-VAD). Server-VAD commits automatically; calling this is harmless.

Source

pub async fn send_text(&self, text: impl Into<String>) -> ZaiResult<()>

Inject a user text message into the conversation history.

Source

pub async fn send_function_output( &self, call_name: impl Into<String>, output: impl Into<String>, ) -> ZaiResult<()>

Feed back a function-call result.

Source

pub async fn create_response(&self) -> ZaiResult<()>

Trigger model inference (response.create).

Source

pub async fn cancel(&self) -> ZaiResult<()>

Cancel the in-flight response (response.cancel), e.g. on interruption.

Source

pub fn events(&self) -> Pin<Box<dyn Stream<Item = ServerEvent> + Send + '_>>

Stream of all server events (transcripts, response lifecycle, errors, heartbeats). Late subscribers miss events broadcast before they joined; subscribe before driving commands when ordering matters. Transient Lagged gaps (slow consumer) are dropped rather than erroring.

Source

pub fn audio_stream(&self) -> Pin<Box<dyn Stream<Item = Bytes> + Send + '_>>

Stream of decoded audio output chunks (PCM/MP3 bytes, per output_audio_format).

Source

pub fn model_name(&self) -> &str

The model id this session was opened for (metadata; the protocol does not transmit it on the wire).

Source

pub async fn close(self) -> ZaiResult<()>

Close the session and wait for the event loop to finish.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more