How canardoux/flutter_sound works
Project Type and Purpose
• This is a cross-platform Flutter plugin (“library package”) called Flutter Sound. Its purpose is to expose audio playback and recording capabilities to Flutter apps on iOS, Android, Web (and desktop via examples). It provides:
• A Dart API layer (playback, recording, utilities)
• Native implementations on Android (Java), iOS (Objective-C/Swift)
• A web shim (Javascript via tau_web.js)
File Structure Analysis
• Top-level directories:
• lib/ ← Dart API & public interfaces
• android/ ← Android plugin code (Java, Gradle)
• ios/ ← iOS plugin code (Objective-C/Swift, CocoaPods)
• assets/js/ ← Web support scripts (tau_web.js, async_processor.js)
• example/ ← Demo Flutter app showcasing plugin usage (multi-platform)
• doc/api/ ← Generated API documentation
• Key config/build files: pubspec.yaml, android/build.gradle, ios/flutter_sound.podspec
• Patterns: Flutter plugin pattern using MethodChannel for mobile, JS interop for web.
README Highlights
• Purpose: play/record audio from buffers, files, streams, remote URLs
• Platforms: iOS ≥10, Android API 21+, Web (Chrome/Firefox/Safari)
• Core features: codec support, live streams, resource management
a. Main Components
• Flutter App (UI)
• Flutter Sound Dart Package
– Public API layer (lib/public/*.dart)
– Core logic (lib/src/tau.dart)
• Platform Channel Layer
– MethodChannel (mobile)
– JS Interop (web)
• Native Modules
– Android: FlutterSoundManager, PlayerManager, RecorderManager, session, etc.
– iOS: FlutterSoundManager, FlutterSoundPlayerManager, FlutterSoundRecorderManager
– Web: async_processor.js, tau_web.js
• OS Audio Services
– Android AudioTrack/MediaRecorder APIs
– iOS AVFoundation
– Browser Web Audio API
b. Interactions
• Flutter App calls public Dart API → invokes MethodChannel.invokeMethod()
• MethodChannel marshals requests → native code on Android/iOS
• Native module executes audio operations → returns results/events via MethodChannel
• Dart side propagates events to Flutter UI (playback state, progress, errors)
• On Web: Dart API calls JS functions in async_processor.js / tau_web.js → Browser Web Audio
c. Architectural Patterns
• Plugin architecture using platform channels (MethodChannel & EventChannel)
• Layered separation: UI ←→ Dart API ←→ Platform channel ←→ Native implementation
• Modular managers for player/recorder sessions
• Streams support: audio data flows as Dart Streams to/from native layers
d. Key Technologies
• Flutter/Dart (Flutter plugin framework)
• Android: Java, Gradle, Android SDK Audio APIs
• iOS: Objective-C/Swift, CocoaPods, AVFoundation
• Web: JavaScript, W3C Web Audio API (via tau_web.js)
• API docs via dartdoc