Class RealtimeServerEvent.OutputAudioBufferCleared
-
- All Implemented Interfaces:
public final class RealtimeServerEvent.OutputAudioBufferClearedWebRTC 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 theoutput_audio_buffer.clearevent to manually cut off the current audio response. Learn more.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRealtimeServerEvent.OutputAudioBufferCleared.BuilderA builder for OutputAudioBufferCleared.
-
Method Summary
Modifier and Type Method Description final StringeventId()The unique ID of the server event. final StringresponseId()The unique ID of the response that produced the audio. final JsonValue_type()The event type, must be output_audio_buffer.cleared.final JsonField<String>_eventId()Returns the raw JSON value of eventId. final JsonField<String>_responseId()Returns the raw JSON value of responseId. final Map<String, JsonValue>_additionalProperties()final RealtimeServerEvent.OutputAudioBufferCleared.BuildertoBuilder()final RealtimeServerEvent.OutputAudioBufferClearedvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RealtimeServerEvent.OutputAudioBufferCleared.Builderbuilder()Returns a mutable builder for constructing an instance of OutputAudioBufferCleared. -
-
Method Detail
-
responseId
final String responseId()
The unique ID of the response that produced the audio.
-
_type
final JsonValue _type()
The event type, must be
output_audio_buffer.cleared.Expected to always return the following:
JsonValue.from("output_audio_buffer.cleared")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.
-
_responseId
final JsonField<String> _responseId()
Returns the raw JSON value of responseId.
Unlike responseId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final RealtimeServerEvent.OutputAudioBufferCleared.Builder toBuilder()
-
validate
final RealtimeServerEvent.OutputAudioBufferCleared validate()
-
builder
final static RealtimeServerEvent.OutputAudioBufferCleared.Builder builder()
Returns a mutable builder for constructing an instance of OutputAudioBufferCleared.
The following fields are required:
.eventId() .responseId()
-
-
-
-