exttex
/
just_audio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation

This commit is contained in:
Ryan Heise 2020-01-02 00:49:21 +11:00
parent af679100ea
commit 836d823179
1 changed files with 41 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,30 +1,58 @@
# just_audio # just_audio
A Flutter plugin to play audio from streams, files and assets. This plugin can be used with [audio_service](https://pub.dev/packages/audio_service) to play audio in the background for music players and podcast apps. 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.
## Features ## Features
* Plays audio from streams, files and assets. | Feature | Android | iOS |
* Broadcasts state changes helpful in streaming apps such as `buffering` and `connecting` in addition to the typical `playing`, `paused` and `stopped` states. | ------- | :-------: | :-----: |
* Control audio playback via standard operations: play, pause, stop, setVolume, setSpeed, seek. | read from URL | ✅ | ✅ |
* Compatible with [audio_service](https://pub.dev/packages/audio_service) to support full background playback, queue management, and controlling playback from the lock screen, notifications and headset buttons. | 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 | ✅ | ✅ |
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). 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).
## Example ## Example
Initialisation:
```dart ```dart
final player = AudioPlayer(); final player = AudioPlayer();
await player.setUrl('https://foo.com/bar.mp3'); var duration = await player.setUrl('https://foo.com/bar.mp3');
player.play(); ```
player.pause();
Standard controls:
```dart
player.play(); player.play();
await player.seek(Duration(seconds: 10));
await player.pause();
await player.stop(); await player.stop();
```
Clipping audio:
```dart
await player.setClip(start: Duration(seconds: 10), end: Duration(seconds: 20)); await player.setClip(start: Duration(seconds: 10), end: Duration(seconds: 20));
await player.play(); await player.play(); // Waits for playback to finish
await player.setUrl('https://foo.com/baz.mp3'); ```
await player.seek(Duration(minutes: 5));
player.play(); Release resources:
await player.stop();
```dart
await player.dispose(); await player.dispose();
``` ```
## Todo
* FLAC support
* Web support
* Gapless playback