Documentation

This commit is contained in:
Ryan Heise 2019-12-27 03:02:47 +11:00
parent e77694ade1
commit 535fea2ec6
2 changed files with 5 additions and 3 deletions

View File

@ -6,7 +6,7 @@ A Flutter plugin to play audio from streams, files and assets. This plugin can b
* 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.
* Control audio playback via standard operations: play, pause, stop, setVolume, seek.
* Control audio playback via standard operations: play, pause, stop, setVolume, setSpeed, seek.
* 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.
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).

View File

@ -155,8 +155,10 @@ class AudioPlayer {
Future<File> get _cacheFile async => File(p.join(
(await getTemporaryDirectory()).path, 'just_audio_asset_cache', '$_id'));
/// Plays the currently loaded media from the current position. It is legal
/// to invoke this method only from one of the following states:
/// Plays the currently loaded media from the current position, until the
/// given position if specified. The [Future] returned by this method
/// completes when playback completes or is paused or stopped. It is legal to
/// invoke this method only from one of the following states:
///
/// * [AudioPlaybackState.stopped]
/// * [AudioPlaybackState.paused]