openai_dart_realtime library
Realtime API for OpenAI.
Provides real-time conversations via WebSocket (audio streaming) and WebRTC (HTTP-based SDP signaling with call management).
Import with prefix to avoid naming conflicts with Responses API:
import 'package:openai_dart/openai_dart.dart';
import 'package:openai_dart/openai_dart_realtime.dart' as realtime;
// Responses API event
final event = ResponseCreatedEvent(...);
// Realtime API event
final rtEvent = realtime.ResponseCreatedEvent(...);
Classes
- AudioInputNoiseReduction
- Noise reduction configuration for the input audio buffer.
- AudioPcm
- 24 kHz signed 16-bit PCM audio format.
- AudioPcma
- G.711 A-law audio format.
- AudioPcmu
- G.711 μ-law audio format.
- ConversationCreatedEvent
- Conversation created event.
- ConversationItemAddedEvent
- Conversation item added event.
- ConversationItemCreatedEvent
- Conversation item created event.
- ConversationItemDeletedEvent
- Conversation item deleted event.
- ConversationItemTruncatedEvent
- Conversation item truncated event.
- ErrorEvent
- An error event.
- ExpiresAfter
- Configuration for when a client secret expires.
- InputAudioBufferClearedEvent
- Input audio buffer cleared event.
- InputAudioBufferCommittedEvent
- Input audio buffer committed event.
- InputAudioBufferSpeechStartedEvent
- Input audio buffer speech started event.
- InputAudioBufferSpeechStoppedEvent
- Input audio buffer speech stopped event.
- InputAudioTranscription
- Configuration for input audio transcription.
- InputAudioTranscriptionCompletedEvent
- Input audio transcription completed event.
- InputAudioTranscriptionDeltaEvent
- Input audio transcription delta event.
- InputAudioTranscriptionFailedEvent
- Input audio transcription failed event.
- InputAudioTranscriptionSegmentEvent
- Input audio transcription segment event.
- RateLimit
- A rate limit.
- RateLimitsUpdatedEvent
- Rate limits updated event.
- RealtimeAudioConfig
- Audio configuration for a Realtime session.
- RealtimeAudioConfigInput
- Input audio configuration for a Realtime session.
- RealtimeAudioConfigOutput
- Output audio configuration for a Realtime session.
- RealtimeAudioFormats
- Audio format for Realtime sessions.
- RealtimeAudioInputTurnDetection
- Turn detection configuration for Realtime sessions.
- RealtimeCallCreateRequest
- Request for creating a WebRTC call.
- RealtimeCallReferRequest
- Request for referring (transferring) a call.
- RealtimeCallRejectRequest
- Request for rejecting an incoming call.
- RealtimeClientSecretCreateRequest
- Request for creating a client secret with session configuration.
- RealtimeClientSecretCreateResponse
- Response from creating a client secret.
- RealtimeError
- A realtime error.
- RealtimeEvent
- Base class for all realtime events.
- RealtimeReasoning
-
Configuration for reasoning-capable Realtime models such as
gpt-realtime-2. - RealtimeSession
- Configuration for a Realtime session.
- RealtimeSessionCreateRequest
- Realtime session configuration.
- RealtimeSessionCreateResponse
- Response from creating a Realtime session via HTTP.
- RealtimeTool
- A tool for realtime sessions.
- RealtimeToolChoice
- Tool choice for realtime sessions.
- RealtimeToolChoiceAuto
- Auto tool choice - let the model decide.
- RealtimeToolChoiceFunction
- Function tool choice - require a specific function.
- RealtimeToolChoiceNone
- None tool choice - disable tool use.
- RealtimeToolChoiceRequired
- Required tool choice - force tool use.
- RealtimeTracingConfig
- Tracing configuration for Realtime sessions.
- RealtimeTranscriptionClientSecretCreateRequest
- Request for creating a client secret for a transcription session.
- RealtimeTranscriptionSessionAudio
- Audio configuration block for a transcription session.
- RealtimeTranscriptionSessionCreateRequest
- Request for creating a Realtime transcription session via HTTP.
- RealtimeTranscriptionSessionCreateResponse
- Response from creating a Realtime transcription session.
- RealtimeTranslationClientEvent
- A client → server event for a Realtime translation session.
- RealtimeTranslationClientSecretCreateRequest
- Request for creating a translation client secret.
- RealtimeTranslationClientSecretCreateResponse
- Response from creating a translation client secret.
- RealtimeTranslationError
-
The
errorpayload nested inside RealtimeTranslationErrorEvent. - RealtimeTranslationErrorEvent
- Returned when an error occurs in a translation session.
- RealtimeTranslationInputAudioBufferAppendEvent
- Append base64-encoded audio bytes to the translation input buffer.
- RealtimeTranslationInputTranscriptDeltaEvent
- Source-language transcript delta.
- RealtimeTranslationInputTranscription
- Optional source-language transcription for a translation session.
- RealtimeTranslationNoiseReduction
- Noise reduction configuration for a translation session.
- RealtimeTranslationOutputAudioDeltaEvent
- Translated output-audio delta (200 ms PCM16 frames).
- RealtimeTranslationOutputTranscriptDeltaEvent
- Translated transcript delta.
- RealtimeTranslationServerEvent
- A server → client event for a Realtime translation session.
- RealtimeTranslationSession
- A Realtime translation session.
- RealtimeTranslationSessionAudio
- Audio configuration block for a translation session.
- RealtimeTranslationSessionAudioInput
- Input audio configuration for a translation session.
- RealtimeTranslationSessionAudioOutput
- Output audio configuration for a translation session.
- RealtimeTranslationSessionClosedEvent
- Returned when a translation session is closed.
- RealtimeTranslationSessionCloseEvent
- Gracefully close a translation session.
- RealtimeTranslationSessionCreatedEvent
- Returned when a translation session is created.
- RealtimeTranslationSessionCreateRequest
- Request payload for creating a translation session.
- RealtimeTranslationSessionUpdatedEvent
- Returned when a translation session is updated.
- RealtimeTranslationSessionUpdateEvent
- Send to update the translation session configuration.
- RealtimeTranslationSessionUpdateRequest
-
Update payload for a translation session (
session.updateevent). - RealtimeTruncation
- Truncation strategy for Realtime sessions.
- ResponseAudioDeltaEvent
- Response audio delta event.
- ResponseAudioDoneEvent
- Response audio done event.
- ResponseAudioTranscriptDeltaEvent
- Response audio transcript delta event.
- ResponseAudioTranscriptDoneEvent
- Response audio transcript done event.
- ResponseContentPartAddedEvent
- Response content part added event.
- ResponseContentPartDoneEvent
- Response content part done event.
- ResponseCreatedEvent
- Response created event.
- ResponseDoneEvent
- Response done event.
- ResponseFunctionCallArgumentsDeltaEvent
- Response function call arguments delta event.
- ResponseFunctionCallArgumentsDoneEvent
- Response function call arguments done event.
- ResponseOutputItemAddedEvent
- Response output item added event.
- ResponseOutputItemDoneEvent
- Response output item done event.
- ResponseTextDeltaEvent
- Response text delta event.
- ResponseTextDoneEvent
- Response text done event.
- SemanticVad
- Semantic VAD turn detection.
- ServerVad
- Server-side voice activity detection.
- SessionCreatedEvent
- Session created event.
- SessionUpdatedEvent
- Session updated event.
- TracingAuto
-
autotracing strategy. - TracingConfiguration
- Granular tracing configuration.
- TruncationAuto
-
autotruncation strategy. - TruncationDisabled
-
disabledtruncation strategy. - TruncationRetentionRatio
- Retention-ratio truncation strategy.
- UnknownRealtimeAudioFormats
- Forward-compatible fallback for unknown RealtimeAudioFormats discriminators.
- UnknownRealtimeAudioInputTurnDetection
- Forward-compatible fallback for unknown turn-detection variants.
- UnknownRealtimeEvent
- Forward-compatible fallback for RealtimeEvent discriminators that this client doesn't model individually.
- UnknownRealtimeTracingConfig
- Forward-compatible fallback for unknown RealtimeTracingConfig payloads.
- UnknownRealtimeTranslationClientEvent
- Forward-compatible fallback for unknown translation client events.
- UnknownRealtimeTranslationServerEvent
- Forward-compatible fallback for unknown translation server events.
- UnknownRealtimeTruncation
- Forward-compatible fallback for unknown RealtimeTruncation payloads.
Enums
- AudioTranscriptionDelay
- Transcription latency-vs-accuracy delay knob.
- NoiseReductionType
- Noise reduction profile for the input audio buffer.
- RealtimeReasoningEffort
- Reasoning effort levels for reasoning-capable Realtime models.
- SemanticVadEagerness
-
Eagerness levels for
semantic_vadturn detection.