How ensaryusuf/just_audio works
Project type and purpose
• This is a Flutter “plugin” package whose sole responsibility is to play audio on Android, iOS, macOS, Windows, Linux and Web.
• It exposes a Dart API (lib/just_audio.dart) that forwards playback commands and receives playback events via Flutter’s platform channels.
• Platform‐specific native code implements the actual audio playback (ExoPlayer on Android, AVFoundation on Apple, libwinmedia on Windows/Linux, HTML5 Audio on Web).
File structure
• lib/
• just_audio.dart: Dart API surface, defines AudioPlayer, AudioSource classes.
• android/src/main/java/...
• JustAudioPlugin.java, AudioPlayer.java, BetterEventChannel.java, MainMethodCallHandler.java → plugin registration, MethodChannel handlers, ExoPlayer wrapper.
• ios/Classes, darwin/Classes, macos/Classes
• Objective-C plugin code: JustAudioPlugin.m, AudioPlayer.m, AudioSource variants → AVAudioEngine/AVPlayer wrappers.
• example/
• A Flutter app showing how to call into AudioPlayer and integrate example audio files.
• test/
• Dart unit tests for the Dart layer.
README for architectural insights
• Relies on two Flutter channel types:
• MethodChannel: synchronous commands (play, pause, setUrl, etc.)
• EventChannel: asynchronous event streams (player state, position, buffering).
• Uses composition of AudioSource types (ConcatenatingAudioSource, ClippingAudioSource, LoopingAudioSource) on both Dart and native sides.
• Maintains two orthogonal states: playing and processingState.
Main components & interactions
a. Dart layer (Flutter app code)
• UI Widgets call into → AudioPlayer API (lib/just_audio.dart)
b. Plugin bridge (Flutter engine)
• MethodChannel “just_audio_method_call” → routes commands to native registrations
• EventChannel “just_audio_event_stream” → streams events back to Dart
c. Platform‐specific implementations
– Android: ExoPlayer wrapper classes receive MethodChannel calls, post events via BetterEventChannel
– iOS/macOS: AVPlayer/AVAudioEngine wrapper classes in Objective-C
– Windows/Linux: libwinmedia C/C++ library invoked through method calls
– Web: HTML5 Audio API through platform‐channel stubs generated by flutter_web_plugins
d. External systems
• Network / File System / Asset Bundle → URI or file sources
• Operating System audio session (ducking, interruptions)
Architectural patterns & principles
• Single Responsibility Principle: plugin “just” plays audio; other concerns (background, session management) are in separate plugins.
• Adapter pattern: Dart API adapts to different native audio engines per platform.
• Strategy/composition: AudioSource types composed into playlists, loops, clip segments.
• Reactive streams: state and position exposed via EventChannel as Rx-style streams.
• Platform abstraction via method/event channels: cleanly separates Dart from platform code.