just_audio/README.md

59 lines
1.8 KiB
Markdown
Raw Normal View History

2019-11-28 06:55:32 +00:00
# just_audio
2019-11-25 14:50:21 +00:00
2020-01-01 13:49:21 +00:00
A Flutter plugin to play audio from URLs, files, assets and DASH/HLS streams. This plugin can be used with [audio_service](https://pub.dev/packages/audio_service) to play audio in the background and control playback from the lock screen, Android notifications, the iOS Control Center, and headset buttons.
2019-11-25 14:50:21 +00:00
2019-11-28 05:16:54 +00:00
## Features
2019-11-25 14:50:21 +00:00
2020-01-01 13:49:21 +00:00
| Feature | Android | iOS |
| ------- | :-------: | :-----: |
| read from URL | ✅ | ✅ |
| read from file | ✅ | (untested) |
| read from asset | ✅ | (untested) |
| DASH | ✅ | (untested) |
| HLS | ✅ | (untested) |
| play/pause/stop/seek | ✅ | ✅ |
| set volume | ✅ | (untested) |
| set speed | ✅ | (untested) |
| custom actions | ✅ | (untested) |
| clip audio | ✅ | |
| dispose | ✅ | ✅ |
2019-11-25 14:50:21 +00:00
2019-11-30 15:52:54 +00:00
This plugin has been tested on Android, and is being made available for testing on iOS. Please consider reporting any bugs you encounter [here](https://github.com/ryanheise/just_audio/issues) or submitting pull requests [here](https://github.com/ryanheise/just_audio/pulls).
2019-11-28 06:59:38 +00:00
## Example
2020-01-01 13:49:21 +00:00
Initialisation:
2019-11-28 06:59:38 +00:00
```dart
final player = AudioPlayer();
2020-01-01 13:49:21 +00:00
var duration = await player.setUrl('https://foo.com/bar.mp3');
```
Standard controls:
```dart
2019-12-31 09:38:46 +00:00
player.play();
2020-01-01 13:49:21 +00:00
await player.seek(Duration(seconds: 10));
await player.pause();
2019-12-31 09:38:46 +00:00
await player.stop();
2020-01-01 13:49:21 +00:00
```
Clipping audio:
```dart
2019-12-31 09:38:46 +00:00
await player.setClip(start: Duration(seconds: 10), end: Duration(seconds: 20));
2020-01-01 13:49:21 +00:00
await player.play(); // Waits for playback to finish
```
Release resources:
```dart
2019-11-28 06:59:38 +00:00
await player.dispose();
```
2020-01-01 13:49:21 +00:00
## Todo
* FLAC support
* Web support
* Gapless playback