Struct RealtimeServerEventInputAudioBufferSpeechStarted

pub struct RealtimeServerEventInputAudioBufferSpeechStarted {
    pub event_id: String,
    pub audio_start_ms: i64,
    pub item_id: String,
}

Sent by the server when in server_vad mode to indicate that speech has been detected in the audio buffer. This can happen any time audio is added to the buffer (unless speech is already detected). The client may want to use this event to interrupt audio playback or provide visual feedback to the user.

The client should expect to receive a input_audio_buffer.speech_stopped event when speech stops. The item_id property is the ID of the user message item that will be created when speech stops and will also be included in the input_audio_buffer.speech_stopped event (unless the client manually commits the audio buffer during VAD activation).

Fields

event_id: String

The unique ID of the server event.

audio_start_ms: i64

Milliseconds from the start of all audio written to the buffer during the session when speech was first detected. This will correspond to the beginning of audio sent to the model, and thus includes the prefix_padding_ms configured in the Session.

item_id: String

The ID of the user message item that will be created when speech stops.

Implementations

impl RealtimeServerEventInputAudioBufferSpeechStarted

pub fn builder() -> RealtimeServerEventInputAudioBufferSpeechStartedBuilder<((), (), ())>

Create a builder for building RealtimeServerEventInputAudioBufferSpeechStarted. On the builder, call .event_id(...), .audio_start_ms(...), .item_id(...) to set the values of the fields. Finally, call .build() to create the instance of RealtimeServerEventInputAudioBufferSpeechStarted.

Trait Implementations

impl Clone for RealtimeServerEventInputAudioBufferSpeechStarted

fn clone(&self) -> RealtimeServerEventInputAudioBufferSpeechStarted

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RealtimeServerEventInputAudioBufferSpeechStarted

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealtimeServerEventInputAudioBufferSpeechStarted

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeServerEventInputAudioBufferSpeechStarted

fn eq(&self, other: &RealtimeServerEventInputAudioBufferSpeechStarted) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RealtimeServerEventInputAudioBufferSpeechStarted

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RealtimeServerEventInputAudioBufferSpeechStarted