4a5c885d6e | ||
---|---|---|
.github/ISSUE_TEMPLATE | ||
android | ||
darwin/Classes | ||
example | ||
ios | ||
lib | ||
macos | ||
test | ||
.gitignore | ||
.metadata | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
pubspec.lock | ||
pubspec.yaml |
README.md
just_audio
A Flutter plugin to play audio from URLs, files, assets and DASH/HLS streams. This plugin can be used with audio_service to play audio in the background and control playback from the lock screen, Android notifications, the iOS Control Center, and headset buttons.
Features
Feature | Android | iOS | MacOS | Web |
---|---|---|---|---|
read from URL | ✅ | ✅ | ✅ | ✅ |
read from file | ✅ | ✅ | ✅ | |
read from asset | ✅ | ✅ | ✅ | |
DASH | ✅ | (untested) | (untested) | (untested) |
HLS | ✅ | (untested) | (untested) | (untested) |
play/pause/stop/seek | ✅ | ✅ | ✅ | ✅ |
set volume | ✅ | (untested) | (untested) | (untested) |
set speed | ✅ | (untested) | (untested) | ✅ |
clip audio | ✅ | ✅ | ||
dispose | ✅ | ✅ | ✅ | ✅ |
catch player errors | ✅ |
This plugin has been tested on Android and Web, and is being made available for testing on iOS. Please consider reporting any bugs you encounter here or submitting pull requests here.
Example
Initialisation:
final player = AudioPlayer();
var duration = await player.setUrl('https://foo.com/bar.mp3');
Standard controls:
player.play();
await player.seek(Duration(seconds: 10));
await player.pause();
await player.stop();
Clipping audio:
await player.setClip(start: Duration(seconds: 10), end: Duration(seconds: 20));
await player.play(); // Waits for playback to finish
Release resources:
await player.dispose();
Catch player error:
player.setUrl("https://s3.amazonaws.com/404-file.mp3").catchError((error) {
// catch audio error ex: 404 url, wrong url ...
print(error);
});
Platform specific configuration
Android
If you wish to connect to non-HTTPS URLS, add the following attribute to the application
element of your AndroidManifest.xml
file:
<application ... android:usesCleartextTraffic="true">
iOS
If you wish to connect to non-HTTPS URLS, add the following to your Info.plist
file:
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
<key>NSAllowsArbitraryLoadsForMedia</key>
<true/>
</dict>
MacOS
To allow your MacOS application to access audio files on the Internet, add the following to your DebugProfile.entitlements
and Release.entitlements
files:
<key>com.apple.security.network.client</key>
<true/>
If you wish to connect to non-HTTPS URLS, add the following to your Info.plist
file:
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
<key>NSAllowsArbitraryLoadsForMedia</key>
<true/>
</dict>
Todo
- FLAC support
- Gapless playback