fix: onPrepared event to wait until player is ready / finished loading the source

packages/audioplayers/example/integration_test/lib_test.dart

@@ -9,7 +9,6 @@ import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:integration_test/integration_test.dart';
 
-import 'mock_html.dart' if (dart.library.html) 'dart:html' show DomException;
 import 'platform_features.dart';
 import 'source_test_data.dart';
 import 'test_utils.dart';
@@ -19,12 +18,12 @@ void main() {
 
   IntegrationTestWidgetsFlutterBinding.ensureInitialized();
 
+  final wavUrl1TestData = LibSourceTestData(
+    source: UrlSource(wavUrl1),
+    duration: const Duration(milliseconds: 451),
+  );
   final audioTestDataList = [
-    if (features.hasUrlSource)
-      LibSourceTestData(
-        source: UrlSource(wavUrl1),
-        duration: const Duration(milliseconds: 451),
-      ),
+    if (features.hasUrlSource) wavUrl1TestData,
     if (features.hasUrlSource)
       LibSourceTestData(
         source: UrlSource(wavUrl2),
@@ -73,6 +72,7 @@ void main() {
 
         // Start all players simultaneously
         final iterator = List<int>.generate(audioTestDataList.length, (i) => i);
+        await tester.pump();
         await Future.wait<void>(
           iterator.map((i) => players[i].play(audioTestDataList[i].source)),
         );
@@ -103,6 +103,7 @@ void main() {
 
       for (var i = 0; i < audioTestDataList.length; i++) {
         final td = audioTestDataList[i];
+        await tester.pump();
         await player.play(td.source);
         await tester.pumpAndSettle();
         // Sources take some time to get initialized
@@ -130,7 +131,7 @@ void main() {
         final player = AudioPlayer();
         await player.setReleaseMode(ReleaseMode.stop);
 
-        final td = audioTestDataList[0];
+        final td = wavUrl1TestData;
 
         var audioContext = AudioContextConfig(
           //ignore: avoid_redundant_argument_values
@@ -141,6 +142,7 @@ void main() {
         await AudioPlayer.global.setAudioContext(audioContext);
         await player.setAudioContext(audioContext);
 
+        await tester.pump();
         await player.play(td.source);
         await tester.pumpAndSettle();
         await tester.pump(td.duration + const Duration(seconds: 8));
@@ -173,7 +175,7 @@ void main() {
         await player.setReleaseMode(ReleaseMode.stop);
         player.setPlayerMode(PlayerMode.lowLatency);
 
-        final td = audioTestDataList[0];
+        final td = wavUrl1TestData;
 
         var audioContext = AudioContextConfig(
           //ignore: avoid_redundant_argument_values
@@ -184,6 +186,7 @@ void main() {
         await AudioPlayer.global.setAudioContext(audioContext);
         await player.setAudioContext(audioContext);
 
+        await tester.pump();
         await player.setSource(td.source);
         await player.resume();
         await tester.pumpAndSettle();
@@ -249,51 +252,37 @@ void main() {
 
   group('Errors', () {
     testWidgets(
-      'Throw PlatformException, when playing invalid file',
+      'Throw PlatformException, when loading invalid file',
       (tester) async {
         final player = AudioPlayer();
         try {
           // Throws PlatformException via MethodChannel:
+          await tester.pump();
           await player.setSource(AssetSource(invalidAsset));
-          await player.resume();
           fail('PlatformException not thrown');
           // ignore: avoid_catches_without_on_clauses
         } catch (e) {
-          if (kIsWeb) {
-            expect(e, isInstanceOf<DomException>());
-            expect((e as DomException).name, 'NotSupportedError');
-          } else {
-            expect(e, isInstanceOf<PlatformException>());
-          }
+          expect(e, isInstanceOf<PlatformException>());
         }
         await player.dispose();
       },
-      // Linux provides errors only asynchronously.
-      skip: !kIsWeb && Platform.isLinux,
     );
 
     testWidgets(
-      'Throw PlatformException, when playing non existent file',
+      'Throw PlatformException, when loading non existent file',
       (tester) async {
         final player = AudioPlayer();
         try {
           // Throws PlatformException via MethodChannel:
+          await tester.pump();
           await player.setSource(UrlSource('non_existent.txt'));
-          await player.resume();
           fail('PlatformException not thrown');
           // ignore: avoid_catches_without_on_clauses
         } catch (e) {
-          if (kIsWeb) {
-            expect(e, isInstanceOf<DomException>());
-            expect((e as DomException).name, 'NotSupportedError');
-          } else {
-            expect(e, isInstanceOf<PlatformException>());
-          }
+          expect(e, isInstanceOf<PlatformException>());
         }
         await player.dispose();
       },
-      // Linux provides errors only asynchronously.
-      skip: !kIsWeb && Platform.isLinux,
     );
   });
 
@@ -318,6 +307,42 @@ void main() {
         );
       }
     });
+
+    testWidgets('#setSource #getPosition and #getDuration', (tester) async {
+      final platform = AudioplayersPlatformInterface.instance;
+
+      const playerId = 'somePlayerId';
+      await platform.create(playerId);
+
+      final preparedCompleter = Completer<void>();
+      final eventStream = platform.getEventStream(playerId);
+      final onPreparedSub = eventStream
+          .where((event) => event.eventType == AudioEventType.prepared)
+          .map((event) => event.isPrepared!)
+          .listen(
+        (isPrepared) {
+          if (isPrepared) {
+            preparedCompleter.complete();
+          }
+        },
+        onError: preparedCompleter.completeError,
+      );
+      await tester.pump();
+      await platform.setSourceUrl(
+        playerId,
+        (wavUrl1TestData.source as UrlSource).url,
+      );
+      await preparedCompleter.future.timeout(const Duration(seconds: 30));
+
+      expect(await platform.getCurrentPosition(playerId), 0);
+      expect(
+        await platform.getDuration(playerId),
+        wavUrl1TestData.duration.inMilliseconds,
+      );
+
+      await onPreparedSub.cancel();
+      await platform.dispose(playerId);
+    });
   });
 
   group('Platform event channel', () {

packages/audioplayers/example/integration_test/tabs/stream_tab.dart

@@ -115,17 +115,19 @@ Future<void> testStreamsTab(
 }
 
 extension StreamWidgetTester on WidgetTester {
-  // Precision for duration & position:
-  // Android: two tenth of a second
+  // Precision for position & duration:
+  // Android: millisecond
   // Windows: millisecond
-  // Linux: second
-  // Web: second
+  // Linux: millisecond
+  // Web: millisecond
+  // Darwin: millisecond
 
-  // Update interval for duration & position:
-  // Android: two tenth of a second
+  // Update interval for position:
+  // Android: ~200ms
   // Windows: ~250ms
-  // Linux: second
-  // Web: second
+  // Linux: ~250ms
+  // Web: ~250ms
+  // Darwin: ?
 
   Future<void> stopStream() async {
     final st = StackTrace.current.toString();
@@ -144,7 +146,11 @@ extension StreamWidgetTester on WidgetTester {
     await waitFor(
       () async => expectWidgetHasDuration(
         const Key('onDurationText'),
-        matcher: (Duration? actual) => durationRangeMatcher(actual, duration),
+        matcher: (Duration? actual) => durationRangeMatcher(
+          actual,
+          duration,
+          deviation: const Duration(milliseconds: 500),
+        ),
       ),
       timeout: timeout,
       stackTrace: st,

packages/audioplayers/lib/src/audioplayer.dart

@@ -99,6 +99,10 @@ class AudioPlayer {
   Stream<void> get onSeekComplete => eventStream
       .where((event) => event.eventType == AudioEventType.seekComplete);
 
+  Stream<bool> get _onPrepared => eventStream
+      .where((event) => event.eventType == AudioEventType.prepared)
+      .map((event) => event.isPrepared!);
+
   /// Stream of log events.
   Stream<String> get onLog => eventStream
       .where((event) => event.eventType == AudioEventType.log)
@@ -150,8 +154,8 @@ class AudioPlayer {
             onError: _eventStreamController.addError,
           );
       creatingCompleter.complete();
-    } on Exception catch (e, st) {
-      creatingCompleter.completeError(e, st);
+    } on Exception catch (e, stackTrace) {
+      creatingCompleter.completeError(e, stackTrace);
     }
   }
 
@@ -279,8 +283,27 @@ class AudioPlayer {
   /// This will delegate to one of the specific methods below depending on
   /// the source type.
   Future<void> setSource(Source source) async {
-    await creatingCompleter.future;
-    return source.setOnPlayer(this);
+    // Implementations of setOnPlayer also call `creatingCompleter.future`
+    await source.setOnPlayer(this);
+  }
+
+  Future<void> _completePrepared(Future<void> Function() fun) async {
+    final preparedCompleter = Completer<void>();
+    final onPreparedSubscription = _onPrepared.listen(
+      (isPrepared) {
+        if (isPrepared) {
+          preparedCompleter.complete();
+        }
+      },
+      onError: (Object e, [StackTrace? stackTrace]) {
+        if (preparedCompleter.isCompleted == false) {
+          preparedCompleter.completeError(e, stackTrace);
+        }
+      },
+    );
+    await fun();
+    await preparedCompleter.future.timeout(const Duration(seconds: 30));
+    onPreparedSubscription.cancel();
   }
 
   /// Sets the URL to a remote link.
@@ -290,7 +313,9 @@ class AudioPlayer {
   Future<void> setSourceUrl(String url) async {
     _source = UrlSource(url);
     await creatingCompleter.future;
-    return _platform.setSourceUrl(playerId, url, isLocal: false);
+    await _completePrepared(
+      () => _platform.setSourceUrl(playerId, url, isLocal: false),
+    );
   }
 
   /// Sets the URL to a file in the users device.
@@ -300,7 +325,9 @@ class AudioPlayer {
   Future<void> setSourceDeviceFile(String path) async {
     _source = DeviceFileSource(path);
     await creatingCompleter.future;
-    return _platform.setSourceUrl(playerId, path, isLocal: true);
+    await _completePrepared(
+      () => _platform.setSourceUrl(playerId, path, isLocal: true),
+    );
   }
 
   /// Sets the URL to an asset in your Flutter application.
@@ -312,13 +339,17 @@ class AudioPlayer {
     _source = AssetSource(path);
     final url = await audioCache.load(path);
     await creatingCompleter.future;
-    return _platform.setSourceUrl(playerId, url.path, isLocal: true);
+    await _completePrepared(
+      () => _platform.setSourceUrl(playerId, url.path, isLocal: true),
+    );
   }
 
   Future<void> setSourceBytes(Uint8List bytes) async {
     _source = BytesSource(bytes);
     await creatingCompleter.future;
-    return _platform.setSourceBytes(playerId, bytes);
+    await _completePrepared(
+      () => _platform.setSourceBytes(playerId, bytes),
+    );
   }
 
   /// Get audio duration after setting url.

packages/audioplayers/test/fake_audioplayers_platform.dart

@@ -123,6 +123,9 @@ class FakeAudioplayersPlatform extends AudioplayersPlatformInterface {
   @override
   Future<void> setSourceBytes(String playerId, Uint8List bytes) async {
     calls.add(FakeCall(id: playerId, method: 'setSourceBytes', value: bytes));
+    eventStreamControllers[playerId]?.add(
+      const AudioEvent(eventType: AudioEventType.prepared, isPrepared: true),
+    );
   }
 
   @override
@@ -132,6 +135,9 @@ class FakeAudioplayersPlatform extends AudioplayersPlatformInterface {
     bool? isLocal,
   }) async {
     calls.add(FakeCall(id: playerId, method: 'setSourceUrl', value: url));
+    eventStreamControllers[playerId]?.add(
+      const AudioEvent(eventType: AudioEventType.prepared, isPrepared: true),
+    );
   }
 
   @override

packages/audioplayers_android/android/src/main/kotlin/xyz/luan/audioplayers/player/MediaPlayerPlayer.kt

@@ -86,7 +86,7 @@ class MediaPlayerPlayer(
     }
 
     override fun prepare() {
-        mediaPlayer.prepare()
+        mediaPlayer.prepareAsync()
     }
 
     override fun reset() {

packages/audioplayers_android/android/src/main/kotlin/xyz/luan/audioplayers/player/WrappedPlayer.kt

@@ -95,7 +95,15 @@ class WrappedPlayer internal constructor(
         }
 
     var released = true
-    var prepared = false
+
+    var prepared: Boolean = false
+        set(value) {
+            if (field != value) {
+                field = value
+                ref.handlePrepared(this, value)
+            }
+        }
+
     var playing = false
     var shouldSeekTo = -1
 

packages/audioplayers_darwin/darwin/Classes/SwiftAudioplayersDarwinPlugin.swift

@@ -186,10 +186,11 @@ public class SwiftAudioplayersDarwinPlugin: NSObject, FlutterPlugin {
             }
 
             player.setSourceUrl(url: url!, isLocal: isLocal, completer: {
-                result(1)
+                player.eventHandler.onPrepared(isPrepared: true)
             }, completerError: {
-                result(FlutterError(code: "DarwinAudioError", message: "AVPlayerItem.Status.failed on setSourceUrl", details: nil))
+                player.eventHandler.onError(code: "DarwinAudioError", message: "AVPlayerItem.Status.failed on setSourceUrl", details: nil)
             })
+            result(1)
             return
         } else if method == "setSourceBytes" {
             result(FlutterError(code: "DarwinAudioError", message: "setSourceBytes is not currently implemented on iOS", details: nil))
@@ -342,6 +343,12 @@ class AudioPlayersStreamHandler: NSObject, FlutterStreamHandler {
         }
     }
 
+    func onPrepared(isPrepared: Bool) {
+        if let eventSink = self.sink {
+            eventSink(["event": "audio.onPrepared", "value": isPrepared])
+        }
+    }
+
     func onLog(message: String) {
         if let eventSink = self.sink {
             eventSink(["event": "audio.onLog", "value": message])