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

@ -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]