Class OutputAudioBufferClearEvent
-
- All Implemented Interfaces:
public final class OutputAudioBufferClearEventWebRTC/SIP Only: Emit to cut off the current audio response. This will trigger the server to stop generating audio and emit a
output_audio_buffer.clearedevent. This event should be preceded by aresponse.cancelclient event to stop the generation of the current response. Learn more.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classOutputAudioBufferClearEvent.BuilderA builder for OutputAudioBufferClearEvent.
-
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 OutputAudioBufferClearEvent.BuildertoBuilder()final OutputAudioBufferClearEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static OutputAudioBufferClearEvent.Builderbuilder()Returns a mutable builder for constructing an instance of OutputAudioBufferClearEvent. -
-
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 OutputAudioBufferClearEvent.Builder toBuilder()
-
validate
final OutputAudioBufferClearEvent validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static OutputAudioBufferClearEvent.Builder builder()
Returns a mutable builder for constructing an instance of OutputAudioBufferClearEvent.
-
-
-
-