Package com.openai.models.beta.realtime
Class RealtimeClientEvent.OutputAudioBufferClear
-
- All Implemented Interfaces:
public final class RealtimeClientEvent.OutputAudioBufferClear
WebRTC Only: Emit to cut off the current audio response. This will trigger the server to stop generating audio and emit a
output_audio_buffer.cleared
event. This event should be preceded by aresponse.cancel
client event to stop the generation of the current response. Learn more.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
RealtimeClientEvent.OutputAudioBufferClear.Builder
A builder for OutputAudioBufferClear.
-
Method Summary
Modifier and Type Method Description final JsonValue
_type()
The event type, must be output_audio_buffer.clear
.final Optional<String>
eventId()
The unique ID of the client event used for error handling. final JsonField<String>
_eventId()
Returns the raw JSON value of eventId. final Map<String, JsonValue>
_additionalProperties()
final RealtimeClientEvent.OutputAudioBufferClear.Builder
toBuilder()
final RealtimeClientEvent.OutputAudioBufferClear
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static RealtimeClientEvent.OutputAudioBufferClear.Builder
builder()
Returns a mutable builder for constructing an instance of OutputAudioBufferClear. -
-
Method Detail
-
_type
final JsonValue _type()
The event type, must be
output_audio_buffer.clear
.Expected to always return the following:
JsonValue.from("output_audio_buffer.clear")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_eventId
final JsonField<String> _eventId()
Returns the raw JSON value of eventId.
Unlike eventId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final RealtimeClientEvent.OutputAudioBufferClear.Builder toBuilder()
-
validate
final RealtimeClientEvent.OutputAudioBufferClear validate()
-
builder
final static RealtimeClientEvent.OutputAudioBufferClear.Builder builder()
Returns a mutable builder for constructing an instance of OutputAudioBufferClear.
-
-
-
-