just_audio/README.md

29 lines
1.4 KiB
Markdown
Raw Normal View History

2019-11-28 06:55:32 +00:00
# just_audio
2019-11-25 14:50:21 +00:00
2019-11-28 06:59:38 +00:00
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.
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
2019-11-28 05:16:54 +00:00
* Plays audio from streams, files and assets.
* Broadcasts state changes helpful in streaming apps such as `buffering` and `connecting` in addition to the typical `playing`, `paused` and `stopped` states.
2019-12-26 16:02:47 +00:00
* Control audio playback via standard operations: play, pause, stop, setVolume, setSpeed, seek.
2019-11-28 05:16:54 +00:00
* 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.
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
```dart
final player = AudioPlayer();
await player.setUrl('https://foo.com/bar.mp3');
2019-11-30 15:52:54 +00:00
player.play();
2019-11-28 06:59:38 +00:00
await player.pause();
await player.play(untilPosition: Duration(minutes: 1));
await player.stop()
await player.setUrl('https://foo.com/baz.mp3');
await player.seek(Duration(minutes: 5));
2019-11-30 15:52:54 +00:00
player.play();
2019-11-28 06:59:38 +00:00
await player.stop();
await player.dispose();
```