From 9b5a82fd1606443bd33beffec0d3d66d88191f4e Mon Sep 17 00:00:00 2001 From: Ryan Heise Date: Sat, 17 Oct 2020 01:36:25 +1100 Subject: [PATCH] Clarify documentation of setSpeed. --- just_audio/lib/just_audio.dart | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/just_audio/lib/just_audio.dart b/just_audio/lib/just_audio.dart index f175cb6..2184f91 100644 --- a/just_audio/lib/just_audio.dart +++ b/just_audio/lib/just_audio.dart @@ -590,7 +590,12 @@ class AudioPlayer { await (await _platform).setVolume(SetVolumeRequest(volume: volume)); } - /// Sets the playback speed of this player, where 1.0 is normal speed. + /// Sets the playback speed of this player, where 1.0 is normal speed. Note + /// that on iOS, calls to [setSpeed] may ignored if the underlying media + /// doesn't support speed changes (e.g. live streams). On Android, values in + /// excess of 1.0 may result in stalls if the playback speed is faster than + /// the player is able to downloaded the audio (this should not happen with + /// locally-stored audio files). Future setSpeed(final double speed) async { if (_disposed) return; _playbackEvent = _playbackEvent.copyWith(