Documentation

This commit is contained in:
Ryan Heise 2020-04-30 23:47:29 +10:00
parent 54721ad7b1
commit b6e4a01113
2 changed files with 12 additions and 4 deletions

View File

@ -10,13 +10,13 @@ A Flutter plugin to play audio from URLs, files, assets and DASH/HLS streams. Th
| read from file | ✅ | ✅ | ✅ | |
| read from asset | ✅ | ✅ | ✅ | |
| DASH | ✅ | (untested) | (untested) | (untested) |
| HLS | ✅ | (untested) | (untested) | (untested) |
| HLS | ✅ | | (untested) | (untested) |
| play/pause/stop/seek | ✅ | ✅ | ✅ | ✅ |
| set volume | ✅ | (untested) | (untested) | (untested) |
| set speed | ✅ | (untested) | (untested) | ✅ |
| set speed | ✅ | ✅ | ✅ | ✅ |
| clip audio | ✅ | | | ✅ |
| dispose | ✅ | ✅ | ✅ | ✅ |
| catch player errors | ✅ | | | |
| catch 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).

View File

@ -204,13 +204,21 @@ class AudioPlayer {
/// The current speed of the player.
double get speed => _speed;
/// Whether the player should automatically delay playback in order to minimize stalling. (iOS 10.0 or later only)
/// Whether the player should automatically delay playback in order to
/// minimize stalling. (iOS 10.0 or later only)
bool get automaticallyWaitsToMinimizeStalling =>
_automaticallyWaitsToMinimizeStalling;
/// Loads audio media from a URL and completes with the duration of that
/// audio, or null if this call was interrupted by another call so [setUrl],
/// [setFilePath] or [setAsset].
///
/// On Android, DASH and HLS streams are detected only when the URL's path
/// has an "mpd" or "m3u8" extension. If the URL does not have such an
/// extension and you have no control over the server, and you also know the
/// type of the stream in advance, you may as a workaround supply the
/// extension as a URL fragment. e.g.
/// https://somewhere.com/somestream?x=etc#.m3u8
Future<Duration> setUrl(final String url) async {
try {
_durationFuture = _invokeMethod('setUrl', [url])