Class: OpenAI::Models::Realtime::RealtimeServerEvent::OutputAudioBufferCleared

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/realtime_server_event.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(event_id: , response_id: , type: :"output_audio_buffer.cleared") ⇒ Object

**WebRTC 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](platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).

Parameters:

  • event_id (String) (defaults to: ) —

    The unique ID of the server event.

  • response_id (String) (defaults to: ) —

    The unique ID of the response that produced the audio.

  • type (Symbol, :"output_audio_buffer.cleared") (defaults to: :"output_audio_buffer.cleared") —

    The event type, must be ‘output_audio_buffer.cleared`.




# File 'lib/openai/models/realtime/realtime_server_event.rb', line 370

Instance Attribute Details

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


356
 
# File 'lib/openai/models/realtime/realtime_server_event.rb', line 356

required :event_id, String

#response_id ⇒ String

The unique ID of the response that produced the audio.

Returns:

  • (String) 


362
 
# File 'lib/openai/models/realtime/realtime_server_event.rb', line 362

required :response_id, String

#type ⇒ Symbol, :"output_audio_buffer.cleared"

The event type, must be ‘output_audio_buffer.cleared`.

Returns:

  • (Symbol, :"output_audio_buffer.cleared") 


368
 
# File 'lib/openai/models/realtime/realtime_server_event.rb', line 368

required :type, const: :"output_audio_buffer.cleared"