Class RealtimeTranslationServerEvent
-
- All Implemented Interfaces:
public final class RealtimeTranslationServerEventA Realtime translation server event.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceRealtimeTranslationServerEvent.VisitorAn interface that defines how to map each variant of RealtimeTranslationServerEvent to a value of type T.
-
Method Summary
Modifier and Type Method Description final Optional<RealtimeErrorEvent>error()Returned when an error occurs, which could be a client problem or a server problem. final Optional<RealtimeTranslationSessionCreatedEvent>sessionCreated()Returned when a translation session is created. final Optional<RealtimeTranslationSessionUpdatedEvent>sessionUpdated()Returned when a translation session is updated with a session.updateevent, unless there is an error.final Optional<RealtimeTranslationSessionClosedEvent>sessionClosed()Returned when a realtime translation session is closed. final Optional<RealtimeTranslationInputTranscriptDeltaEvent>sessionInputTranscriptDelta()Returned when optional source-language transcript text is available. final Optional<RealtimeTranslationOutputTranscriptDeltaEvent>sessionOutputTranscriptDelta()Returned when translated transcript text is available. final Optional<RealtimeTranslationOutputAudioDeltaEvent>sessionOutputAudioDelta()Returned when translated output audio is available. final BooleanisError()final BooleanisSessionCreated()final BooleanisSessionUpdated()final BooleanisSessionClosed()final BooleanisSessionInputTranscriptDelta()final BooleanisSessionOutputTranscriptDelta()final BooleanisSessionOutputAudioDelta()final RealtimeErrorEventasError()Returned when an error occurs, which could be a client problem or a server problem. final RealtimeTranslationSessionCreatedEventasSessionCreated()Returned when a translation session is created. final RealtimeTranslationSessionUpdatedEventasSessionUpdated()Returned when a translation session is updated with a session.updateevent, unless there is an error.final RealtimeTranslationSessionClosedEventasSessionClosed()Returned when a realtime translation session is closed. final RealtimeTranslationInputTranscriptDeltaEventasSessionInputTranscriptDelta()Returned when optional source-language transcript text is available. final RealtimeTranslationOutputTranscriptDeltaEventasSessionOutputTranscriptDelta()Returned when translated transcript text is available. final RealtimeTranslationOutputAudioDeltaEventasSessionOutputAudioDelta()Returned when translated output audio is available. final Optional<JsonValue>_json()final <T extends Any> Taccept(RealtimeTranslationServerEvent.Visitor<T> visitor)Maps this instance's current variant to a value of type T using the given visitor. final RealtimeTranslationServerEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RealtimeTranslationServerEventofError(RealtimeErrorEvent error)Returned when an error occurs, which could be a client problem or a server problem. final static RealtimeTranslationServerEventofSessionCreated(RealtimeTranslationSessionCreatedEvent sessionCreated)Returned when a translation session is created. final static RealtimeTranslationServerEventofSessionUpdated(RealtimeTranslationSessionUpdatedEvent sessionUpdated)Returned when a translation session is updated with a session.updateevent, unless there is an error.final static RealtimeTranslationServerEventofSessionClosed(RealtimeTranslationSessionClosedEvent sessionClosed)Returned when a realtime translation session is closed. final static RealtimeTranslationServerEventofSessionInputTranscriptDelta(RealtimeTranslationInputTranscriptDeltaEvent sessionInputTranscriptDelta)Returned when optional source-language transcript text is available. final static RealtimeTranslationServerEventofSessionOutputTranscriptDelta(RealtimeTranslationOutputTranscriptDeltaEvent sessionOutputTranscriptDelta)Returned when translated transcript text is available. final static RealtimeTranslationServerEventofSessionOutputAudioDelta(RealtimeTranslationOutputAudioDeltaEvent sessionOutputAudioDelta)Returned when translated output audio is available. -
-
Method Detail
-
error
final Optional<RealtimeErrorEvent> error()
Returned when an error occurs, which could be a client problem or a server problem. Most errors are recoverable and the session will stay open, we recommend to implementors to monitor and log error messages by default.
-
sessionCreated
final Optional<RealtimeTranslationSessionCreatedEvent> sessionCreated()
Returned when a translation session is created. Emitted automatically when a new connection is established as the first server event. This event contains the default translation session configuration.
-
sessionUpdated
final Optional<RealtimeTranslationSessionUpdatedEvent> sessionUpdated()
Returned when a translation session is updated with a
session.updateevent, unless there is an error.
-
sessionClosed
final Optional<RealtimeTranslationSessionClosedEvent> sessionClosed()
Returned when a realtime translation session is closed.
-
sessionInputTranscriptDelta
final Optional<RealtimeTranslationInputTranscriptDeltaEvent> sessionInputTranscriptDelta()
Returned when optional source-language transcript text is available. This event is emitted only when
audio.input.transcriptionis configured.Transcript deltas are append-only text fragments. Clients should not insert unconditional spaces between deltas.
-
sessionOutputTranscriptDelta
final Optional<RealtimeTranslationOutputTranscriptDeltaEvent> sessionOutputTranscriptDelta()
Returned when translated transcript text is available.
Transcript deltas are append-only text fragments. Clients should not insert unconditional spaces between deltas.
-
sessionOutputAudioDelta
final Optional<RealtimeTranslationOutputAudioDeltaEvent> sessionOutputAudioDelta()
Returned when translated output audio is available. Output audio deltas are 200 ms frames of PCM16 audio.
-
isSessionCreated
final Boolean isSessionCreated()
-
isSessionUpdated
final Boolean isSessionUpdated()
-
isSessionClosed
final Boolean isSessionClosed()
-
isSessionInputTranscriptDelta
final Boolean isSessionInputTranscriptDelta()
-
isSessionOutputTranscriptDelta
final Boolean isSessionOutputTranscriptDelta()
-
isSessionOutputAudioDelta
final Boolean isSessionOutputAudioDelta()
-
asError
final RealtimeErrorEvent asError()
Returned when an error occurs, which could be a client problem or a server problem. Most errors are recoverable and the session will stay open, we recommend to implementors to monitor and log error messages by default.
-
asSessionCreated
final RealtimeTranslationSessionCreatedEvent asSessionCreated()
Returned when a translation session is created. Emitted automatically when a new connection is established as the first server event. This event contains the default translation session configuration.
-
asSessionUpdated
final RealtimeTranslationSessionUpdatedEvent asSessionUpdated()
Returned when a translation session is updated with a
session.updateevent, unless there is an error.
-
asSessionClosed
final RealtimeTranslationSessionClosedEvent asSessionClosed()
Returned when a realtime translation session is closed.
-
asSessionInputTranscriptDelta
final RealtimeTranslationInputTranscriptDeltaEvent asSessionInputTranscriptDelta()
Returned when optional source-language transcript text is available. This event is emitted only when
audio.input.transcriptionis configured.Transcript deltas are append-only text fragments. Clients should not insert unconditional spaces between deltas.
-
asSessionOutputTranscriptDelta
final RealtimeTranslationOutputTranscriptDeltaEvent asSessionOutputTranscriptDelta()
Returned when translated transcript text is available.
Transcript deltas are append-only text fragments. Clients should not insert unconditional spaces between deltas.
-
asSessionOutputAudioDelta
final RealtimeTranslationOutputAudioDeltaEvent asSessionOutputAudioDelta()
Returned when translated output audio is available. Output audio deltas are 200 ms frames of PCM16 audio.
-
accept
final <T extends Any> T accept(RealtimeTranslationServerEvent.Visitor<T> visitor)
Maps this instance's current variant to a value of type T using the given visitor.
Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:
import com.openai.core.JsonValue; import java.util.Optional; Optional<String> result = realtimeTranslationServerEvent.accept(new RealtimeTranslationServerEvent.Visitor<Optional<String>>() { @Override public Optional<String> visitError(RealtimeErrorEvent error) { return Optional.of(error.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
-
validate
final RealtimeTranslationServerEvent 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.
-
ofError
final static RealtimeTranslationServerEvent ofError(RealtimeErrorEvent error)
Returned when an error occurs, which could be a client problem or a server problem. Most errors are recoverable and the session will stay open, we recommend to implementors to monitor and log error messages by default.
-
ofSessionCreated
final static RealtimeTranslationServerEvent ofSessionCreated(RealtimeTranslationSessionCreatedEvent sessionCreated)
Returned when a translation session is created. Emitted automatically when a new connection is established as the first server event. This event contains the default translation session configuration.
-
ofSessionUpdated
final static RealtimeTranslationServerEvent ofSessionUpdated(RealtimeTranslationSessionUpdatedEvent sessionUpdated)
Returned when a translation session is updated with a
session.updateevent, unless there is an error.
-
ofSessionClosed
final static RealtimeTranslationServerEvent ofSessionClosed(RealtimeTranslationSessionClosedEvent sessionClosed)
Returned when a realtime translation session is closed.
-
ofSessionInputTranscriptDelta
final static RealtimeTranslationServerEvent ofSessionInputTranscriptDelta(RealtimeTranslationInputTranscriptDeltaEvent sessionInputTranscriptDelta)
Returned when optional source-language transcript text is available. This event is emitted only when
audio.input.transcriptionis configured.Transcript deltas are append-only text fragments. Clients should not insert unconditional spaces between deltas.
-
ofSessionOutputTranscriptDelta
final static RealtimeTranslationServerEvent ofSessionOutputTranscriptDelta(RealtimeTranslationOutputTranscriptDeltaEvent sessionOutputTranscriptDelta)
Returned when translated transcript text is available.
Transcript deltas are append-only text fragments. Clients should not insert unconditional spaces between deltas.
-
ofSessionOutputAudioDelta
final static RealtimeTranslationServerEvent ofSessionOutputAudioDelta(RealtimeTranslationOutputAudioDeltaEvent sessionOutputAudioDelta)
Returned when translated output audio is available. Output audio deltas are 200 ms frames of PCM16 audio.
-
-
-
-