fix: Wait for seek to complete (#1712)

# Description Wait for seek to finish by listening to the `AudioEventType.seekComplete` event.
bluefireteam · Nov 30, 2023 · fd33b1d · fd33b1d
1 parent 577a3ff
commit fd33b1d
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 19 deletions.
diff --git a/packages/audioplayers/example/example.md b/packages/audioplayers/example/example.md
@@ -217,10 +217,6 @@ class _PlayerWidgetState extends State<PlayerWidget> {
   }
 
   Future<void> _play() async {
-    final position = _position;
-    if (position != null && position.inMilliseconds > 0) {
-      await player.seek(position);
-    }
     await player.resume();
     setState(() => _playerState = PlayerState.playing);
   }

diff --git a/packages/audioplayers/example/lib/components/player_widget.dart b/packages/audioplayers/example/lib/components/player_widget.dart
@@ -159,10 +159,6 @@ class _PlayerWidgetState extends State<PlayerWidget> {
   }
 
   Future<void> _play() async {
-    final position = _position;
-    if (position != null && position.inMilliseconds > 0) {
-      await player.seek(position);
-    }
     await player.resume();
     setState(() => _playerState = PlayerState.playing);
   }

diff --git a/packages/audioplayers/lib/src/audioplayer.dart b/packages/audioplayers/lib/src/audioplayer.dart
@@ -85,8 +85,6 @@ class AudioPlayer {
 
   late final StreamSubscription _onPlayerCompleteStreamSubscription;
 
-  late final StreamSubscription _onSeekCompleteStreamSubscription;
-
   late final StreamSubscription _onLogStreamSubscription;
 
   /// Stream controller to be able to get a stream on initialization, before the
@@ -164,9 +162,6 @@ class AudioPlayer {
         /* Errors are already handled via log stream */
       },
     );
-    _onSeekCompleteStreamSubscription = onSeekComplete.listen((event) async {
-      await _positionUpdater?.update();
-    });
     _create();
     positionUpdater = FramePositionUpdater(
       getPosition: getCurrentPosition,
@@ -290,7 +285,24 @@ class AudioPlayer {
   /// Moves the cursor to the desired position.
   Future<void> seek(Duration position) async {
     await creatingCompleter.future;
-    return _platform.seek(playerId, position);
+
+    final seekCompleter = Completer<void>();
+    late StreamSubscription<void> onSeekCompleteSubscription;
+    onSeekCompleteSubscription = onSeekComplete.listen(
+      (_) async {
+        seekCompleter.complete();
+        await onSeekCompleteSubscription.cancel();
+      },
+      onError: (Object e, [StackTrace? stackTrace]) async {
+        if (!seekCompleter.isCompleted) {
+          seekCompleter.completeError(e, stackTrace);
+          await onSeekCompleteSubscription.cancel();
+        }
+      },
+    );
+    await _platform.seek(playerId, position);
+    await seekCompleter.future.timeout(const Duration(seconds: 30));
+    await _positionUpdater?.update();
   }
 
   /// Sets the stereo balance.
@@ -461,7 +473,6 @@ class AudioPlayer {
       if (_positionUpdater != null) _positionUpdater!.dispose(),
       if (!_playerStateController.isClosed) _playerStateController.close(),
       _onPlayerCompleteStreamSubscription.cancel(),
-      _onSeekCompleteStreamSubscription.cancel(),
       _onLogStreamSubscription.cancel(),
       _eventStreamSubscription.cancel(),
       _eventStreamController.close(),

diff --git a/packages/audioplayers_linux/linux/audio_player.cc b/packages/audioplayers_linux/linux/audio_player.cc
@@ -256,8 +256,7 @@ void AudioPlayer::OnPlaybackEnded() {
   if (GetLooping()) {
     Play();
   } else {
-    Pause();
-    SetPosition(0);
+    Stop();
   }
 }
 
@@ -412,6 +411,21 @@ void AudioPlayer::Pause() {
   }
 }
 
+void AudioPlayer::Stop() {
+  Pause();
+  if (!_isInitialized) {
+    return;
+  }
+  SetPosition(0);
+  // Block thread to wait for state, as it is not expected to be waited to
+  // "seek complete" event on the dart side.
+  GstStateChangeReturn ret =
+      gst_element_get_state(playbin, NULL, NULL, GST_CLOCK_TIME_NONE);
+  if (ret == GST_STATE_CHANGE_FAILURE) {
+    throw "Unable to seek playback to '0' while stopping the player.";
+  }
+}
+
 void AudioPlayer::Resume() {
   if (!_isPlaying) {
     _isPlaying = true;

diff --git a/packages/audioplayers_linux/linux/audio_player.h b/packages/audioplayers_linux/linux/audio_player.h
@@ -36,6 +36,8 @@ class AudioPlayer {
 
   void Pause();
 
+  void Stop();
+
   void Resume();
 
   void Dispose();

diff --git a/packages/audioplayers_linux/linux/audioplayers_linux_plugin.cc b/packages/audioplayers_linux/linux/audioplayers_linux_plugin.cc
@@ -137,8 +137,7 @@ static void audioplayers_linux_plugin_handle_method_call(
     } else if (strcmp(method, "resume") == 0) {
       player->Resume();
     } else if (strcmp(method, "stop") == 0) {
-      player->Pause();
-      player->SetPosition(0);
+      player->Stop();
     } else if (strcmp(method, "release") == 0) {
       player->ReleaseMediaSource();
     } else if (strcmp(method, "seek") == 0) {