flutter_openai_realtime_api 0.1.2
flutter_openai_realtime_api: ^0.1.2 copied to clipboard
Flutter client for the OpenAI Realtime GA API. WebRTC and WebSocket transports for low-latency voice and text conversations.
Changelog #
0.1.2 - 2026-05-12 #
- Breaking-ish default change:
RealtimeConfig.modelnow defaults toRealtimeModel.gptRealtime2(gpt-realtime-2) instead of thegpt-realtimerolling alias. New sessions created without an explicitmodelwill use the May 2026 reasoning model. Pin the previous behaviour withmodel: RealtimeModel.gptRealtime. - README and example app updated to reference
gpt-realtime-2.
0.1.1 - 2026-05-12 #
- Added the May 2026 Realtime API model lineup to
RealtimeModel:gpt-realtime-2(reasoning S2S),gpt-realtime-1.5(low-latency S2S),gpt-realtime-mini-2025-12-15,gpt-realtime-mini-2025-10-06,gpt-realtime-translate(live S2S translation), andgpt-realtime-whisper(streaming STT). README and theRealtimeModelenum test were updated to match.
0.0.1 - 2026-04-30 #
Initial public release. Targets the OpenAI Realtime GA API.
- WebRTC transport (low-latency voice) and WebSocket transport
(server-side and text-only) behind a single
RealtimeClient. - Ephemeral-token auth via
EphemeralTokenProviderandCachingEphemeralTokenProvider.OpenAIClientSecretMinterships for server-side Dart backends; do not use it from a Flutter app shipped to users. - Typed event hierarchy:
session.*,conversation.*,response.*,input_audio_buffer.*,output_audio_buffer.*,rate_limits.updated,error, plus locally-synthesisedConnectionConnected/ConnectionDisconnected/ConnectionFailedlifecycle events. Forward-compatibleUnknownRealtimeEventkeeps unrecognised types visible. - Typed
RealtimeUsageparsing forresponse.done. Pre-GAresponse.text.*/response.audio.*aliases recognised alongside GA names. - WebRTC barge-in support:
cancelResponse,clearOutputAudioBuffer,truncateConversation. MuteStrategy.standard/aggressive/autofor handling assistant echo on platforms with imperfect AEC.ConnectionStateandisMutedexposed asValueListenableforValueListenableBuilder.RealtimeClient.callIdexposes the WebRTCLocationheader for log correlation with OpenAI billing.- Example app scaffolded for Android, iOS, and macOS with the required mic + network entitlements.
- GitHub Actions CI (analyze + test on Ubuntu and macOS).
- Dartdoc on the public API.