From 165790851ef6c331e4e13dbf35143720a780c2f0 Mon Sep 17 00:00:00 2001 From: Ryan Heise Date: Wed, 29 Jul 2020 19:42:41 +1000 Subject: [PATCH] Reformat documentation on streams. --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 841037b..a3e08bc 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ A Flutter plugin to play audio from URLs, files, assets, DASH/HLS streams and pl | gapless playback | ✅ | ✅ | (untested) | | | report 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](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 Web, and is being made available for testing on iOS and MacOS. 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 @@ -121,20 +121,6 @@ try { Listening to state changes: -- AudioPlayer.playbackStateStream -- AudioPlayer.durationStream -- AudioPlayer.bufferingStream -- AudioPlayer.icyMetadataStream -- AudioPlayer.bufferedPositionStream -- AudioPlayer.fullPlaybackStateStream -- AudioPlayer.playbackEventStream -- AudioPlayer.currentIndexStream -- AudioPlayer.loopModeStream -- AudioPlayer.shuffleModeEnabledStream -- AudioPlayer.durationStream - -e.g. - ```dart player.playbackStateStream.listen((state) { switch (state) { @@ -146,6 +132,18 @@ player.playbackStateStream.listen((state) { case AudioPlaybackState.completed: ... } }); + +// See also: +// - durationStream +// - bufferingStream +// - icyMetadataStream +// - bufferedPositionStream +// - fullPlaybackStateStream +// - playbackEventStream +// - currentIndexStream +// - loopModeStream +// - shuffleModeEnabledStream +// - durationStream ``` ## Platform specific configuration