View Source ExOpenAI.Components.RealtimeServerEventOutputAudioBufferCleared (ex_openai.ex v2.0.0-beta2)

WebRTC/SIP Only: Emitted when the output audio buffer is cleared. This happens either in VAD mode when the user has interrupted (input_audio_buffer.speech_started), or when the client has emitted the output_audio_buffer.clear event to manually cut off the current audio response. Learn more.

Fields

  • :event_id - required - String.t()
    The unique ID of the server event.

  • :response_id - required - String.t()
    The unique ID of the response that produced the audio.

  • :type - required - :"output_audio_buffer.cleared"
    The event type, must be output_audio_buffer.cleared.
    Allowed values: "output_audio_buffer.cleared"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.RealtimeServerEventOutputAudioBufferCleared{
  event_id: String.t(),
  response_id: String.t(),
  type: :"output_audio_buffer.cleared"
}