From 4ac4ab1b45bdece2146adc1f08432e775d40ec78 Mon Sep 17 00:00:00 2001
From: Ryan Heise <ryan@ryanheise.com>
Date: Sat, 1 Feb 2025 19:18:14 +1100
Subject: [PATCH] Futureproof sinkId, add missing implementations, tests, bump
 versions, CHANGELOGs.

---
 just_audio/CHANGELOG.md                       |  4 ++
 just_audio/lib/just_audio.dart                | 39 ++++++++++++++-----
 just_audio/pubspec.yaml                       |  6 +--
 just_audio/test/just_audio_test.dart          | 10 +++++
 just_audio_background/CHANGELOG.md            |  4 ++
 just_audio_background/example/pubspec.yaml    |  2 +-
 .../lib/just_audio_background.dart            | 11 ++++++
 just_audio_background/pubspec.yaml            |  4 +-
 just_audio_platform_interface/CHANGELOG.md    |  4 ++
 .../lib/just_audio_platform_interface.dart    | 18 ++++++---
 just_audio_platform_interface/pubspec.yaml    |  2 +-
 just_audio_web/CHANGELOG.md                   |  4 ++
 just_audio_web/lib/just_audio_web.dart        | 12 +++---
 just_audio_web/pubspec.yaml                   |  6 +--
 14 files changed, 97 insertions(+), 29 deletions(-)

diff --git a/just_audio/CHANGELOG.md b/just_audio/CHANGELOG.md
index 7148d9727..0572b63f6 100644
--- a/just_audio/CHANGELOG.md
+++ b/just_audio/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.9.45
+
+* Add setWebSinkId for web (@dganzella).
+
 ## 0.9.44
 
 * Add support for SwiftPM.
diff --git a/just_audio/lib/just_audio.dart b/just_audio/lib/just_audio.dart
index 84eccc3bc..84688a2b9 100644
--- a/just_audio/lib/just_audio.dart
+++ b/just_audio/lib/just_audio.dart
@@ -144,6 +144,7 @@ class AudioPlayer {
   bool _platformLoading = false;
   AndroidAudioAttributes? _androidAudioAttributes;
   WebCrossOrigin? _webCrossOrigin;
+  String _webSinkId = '';
   final bool _androidApplyAudioAttributes;
   final bool _handleAudioSessionActivation;
 
@@ -580,6 +581,9 @@ class AudioPlayer {
   /// instance on web.
   WebCrossOrigin? get webCrossOrigin => _webCrossOrigin;
 
+  /// The current sink ID of the `<audio>` element backing this instance on web.
+  String get webSinkId => _webSinkId;
+
   /// The current position of the player.
   Duration get position => _getPositionFor(_playbackEvent);
 
@@ -1234,6 +1238,16 @@ class AudioPlayer {
     _webCrossOrigin = webCrossOrigin;
   }
 
+  /// Sets a specific device output id on Web.
+  Future<void> setWebSinkId(String webSinkId) async {
+    if (_disposed) return;
+    if (!kIsWeb && !_isUnitTest()) return;
+
+    await (await _platform)
+        .setWebSinkId(SetWebSinkIdRequest(sinkId: webSinkId));
+    _webSinkId = webSinkId;
+  }
+
   /// Release all resources associated with this player. You must invoke this
   /// after you are done with the player.
   Future<void> dispose() async {
@@ -1487,10 +1501,17 @@ class AudioPlayer {
                 ? ShuffleModeMessage.all
                 : ShuffleModeMessage.none));
         if (checkInterruption()) return platform;
-        if (kIsWeb && _webCrossOrigin != null) {
-          await platform.setWebCrossOrigin(SetWebCrossOriginRequest(
-            crossOrigin: WebCrossOriginMessage.values[_webCrossOrigin!.index],
-          ));
+        if (kIsWeb) {
+          if (_webCrossOrigin != null) {
+            await platform.setWebCrossOrigin(SetWebCrossOriginRequest(
+              crossOrigin: WebCrossOriginMessage.values[_webCrossOrigin!.index],
+            ));
+          }
+          if (_webSinkId != '') {
+            await platform.setWebSinkId(SetWebSinkIdRequest(
+              sinkId: _webSinkId,
+            ));
+          }
         }
         for (var audioEffect in _audioPipeline._audioEffects) {
           await audioEffect._activate(platform);
@@ -1528,11 +1549,6 @@ class AudioPlayer {
     return durationCompleter.future;
   }
 
-  /// Sets a specific device output id, null for default
-  Future<void> setWebSinkId(String? sinkId) async {
-    await (await _platform).setWebSinkId(sinkId);
-  }
-
   /// Dispose of the given platform.
   Future<void> _disposePlatform(AudioPlayerPlatform platform) async {
     if (platform is _IdleAudioPlayer) {
@@ -3652,6 +3668,11 @@ class _IdleAudioPlayer extends AudioPlayerPlatform {
     return SetWebCrossOriginResponse();
   }
 
+  @override
+  Future<SetWebSinkIdResponse> setWebSinkId(SetWebSinkIdRequest request) async {
+    return SetWebSinkIdResponse();
+  }
+
   @override
   Future<SetAutomaticallyWaitsToMinimizeStallingResponse>
       setAutomaticallyWaitsToMinimizeStalling(
diff --git a/just_audio/pubspec.yaml b/just_audio/pubspec.yaml
index e1c6e0ce5..a4dbb66a4 100644
--- a/just_audio/pubspec.yaml
+++ b/just_audio/pubspec.yaml
@@ -1,6 +1,6 @@
 name: just_audio
 description: A feature-rich audio player for Flutter. Loop, clip and concatenate any sound from any source (asset/file/URL/stream) in a variety of audio formats with gapless playback.
-version: 0.9.44
+version: 0.9.45
 repository: https://github.com/ryanheise/just_audio/tree/minor/just_audio
 issue_tracker: https://github.com/ryanheise/just_audio/issues
 topics:
@@ -14,10 +14,10 @@ environment:
   flutter: ">=3.10.0"
 
 dependencies:
-  just_audio_platform_interface: ^4.3.0
+  just_audio_platform_interface: ^4.4.0
   # just_audio_platform_interface:
   #   path: ../just_audio_platform_interface
-  just_audio_web: ^0.4.11
+  just_audio_web: ^0.4.14
   # just_audio_web:
   #   path: ../just_audio_web
   audio_session: ^0.1.24
diff --git a/just_audio/test/just_audio_test.dart b/just_audio/test/just_audio_test.dart
index fc166d7f4..1067d50c7 100644
--- a/just_audio/test/just_audio_test.dart
+++ b/just_audio/test/just_audio_test.dart
@@ -346,6 +346,16 @@ void runTests() {
     await player.dispose();
   });
 
+  test('setWebSinkId', () async {
+    final player = AudioPlayer();
+    expect(player.webSinkId, equals(''));
+    await player.setWebSinkId('foo');
+    expect(player.webSinkId, equals('foo'));
+    await player.setWebSinkId('');
+    expect(player.webSinkId, equals(''));
+    await player.dispose();
+  });
+
   test('setAndroidAudioAttributes', () async {
     final player = AudioPlayer();
     await player.setAndroidAudioAttributes(const AndroidAudioAttributes());
diff --git a/just_audio_background/CHANGELOG.md b/just_audio_background/CHANGELOG.md
index ac0472ff8..ffa9da6fc 100644
--- a/just_audio_background/CHANGELOG.md
+++ b/just_audio_background/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.0.1-beta.15
+
+* Add setWebSinkId for web.
+
 ## 0.0.1-beta.14
 
 * Fix shuffleOrder when mutating ConcatenatingAudioSource (@jonmarkhall).
diff --git a/just_audio_background/example/pubspec.yaml b/just_audio_background/example/pubspec.yaml
index 168b1f8ae..a92c00620 100644
--- a/just_audio_background/example/pubspec.yaml
+++ b/just_audio_background/example/pubspec.yaml
@@ -8,7 +8,7 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  audio_session: ^0.1.23
+  audio_session: ^0.1.24
   rxdart: ^0.27.2
   just_audio:
     path: ../../just_audio
diff --git a/just_audio_background/lib/just_audio_background.dart b/just_audio_background/lib/just_audio_background.dart
index 4be09ce05..4927721bd 100644
--- a/just_audio_background/lib/just_audio_background.dart
+++ b/just_audio_background/lib/just_audio_background.dart
@@ -298,6 +298,12 @@ class _JustAudioPlayer extends AudioPlayerPlatform {
     return SetWebCrossOriginResponse();
   }
 
+  @override
+  Future<SetWebSinkIdResponse> setWebSinkId(SetWebSinkIdRequest request) {
+    _playerAudioHandler.customSetWebSinkId(request);
+    throw SetWebSinkIdResponse();
+  }
+
   @override
   Future<SeekResponse> seek(SeekRequest request) =>
       _playerAudioHandler.customPlayerSeek(request);
@@ -519,6 +525,11 @@ class _PlayerAudioHandler extends BaseAudioHandler
     return await (await _player).setWebCrossOrigin(request);
   }
 
+  Future<SetWebSinkIdResponse> customSetWebSinkId(
+      SetWebSinkIdRequest request) async {
+    return await (await _player).setWebSinkId(request);
+  }
+
   Future<ConcatenatingInsertAllResponse> customConcatenatingInsertAll(
       ConcatenatingInsertAllRequest request) async {
     final cat = _source!.findCat(request.id)!;
diff --git a/just_audio_background/pubspec.yaml b/just_audio_background/pubspec.yaml
index 969fdf441..cda7e1365 100644
--- a/just_audio_background/pubspec.yaml
+++ b/just_audio_background/pubspec.yaml
@@ -1,7 +1,7 @@
 name: just_audio_background
 description: An add-on for just_audio that supports background playback and media notifications.
 homepage: https://github.com/ryanheise/just_audio/tree/master/just_audio_background
-version: 0.0.1-beta.14
+version: 0.0.1-beta.15
 topics:
   - audio
   - sound
@@ -9,7 +9,7 @@ topics:
   - background
 
 dependencies:
-  just_audio_platform_interface: ^4.3.0
+  just_audio_platform_interface: ^4.4.0
   # just_audio_platform_interface:
   #   path: ../just_audio_platform_interface
   audio_service: ^0.18.14
diff --git a/just_audio_platform_interface/CHANGELOG.md b/just_audio_platform_interface/CHANGELOG.md
index c73ea3d9c..d7c8c7170 100644
--- a/just_audio_platform_interface/CHANGELOG.md
+++ b/just_audio_platform_interface/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 4.4.0
+
+* Add setWebSinkId for web (@dganzella).
+
 ## 4.3.0
 
 * Add setWebCrossOrigin for CORS on web (@danielwinkler).
diff --git a/just_audio_platform_interface/lib/just_audio_platform_interface.dart b/just_audio_platform_interface/lib/just_audio_platform_interface.dart
index 9b6270d5a..71e31753b 100644
--- a/just_audio_platform_interface/lib/just_audio_platform_interface.dart
+++ b/just_audio_platform_interface/lib/just_audio_platform_interface.dart
@@ -76,11 +76,6 @@ abstract class AudioPlayerPlatform {
   Stream<PlayerDataMessage> get playerDataMessageStream =>
       const Stream<PlayerDataMessage>.empty();
 
-  /// Sets a specific device output id, null for default
-  Future<void> setWebSinkId(String? sinkId) {
-    throw UnimplementedError("setWebSinkId() has not been implemented.");
-  }
-
   /// Loads an audio source.
   Future<LoadResponse> load(LoadRequest request) {
     throw UnimplementedError("load() has not been implemented.");
@@ -241,6 +236,11 @@ abstract class AudioPlayerPlatform {
       SetWebCrossOriginRequest request) {
     throw UnimplementedError("setWebCrossOrigin() has not been implemented.");
   }
+
+  /// Sets a specific device output id on the web audio element.
+  Future<SetWebSinkIdResponse> setWebSinkId(SetWebSinkIdRequest request) {
+    throw UnimplementedError("setWebSinkId() has not been implemented.");
+  }
 }
 
 /// A data update communicated from the platform implementation to the Flutter
@@ -1506,3 +1506,11 @@ class SetWebCrossOriginRequest {
 class SetWebCrossOriginResponse {}
 
 enum WebCrossOriginMessage { anonymous, useCredentials }
+
+class SetWebSinkIdRequest {
+  final String sinkId;
+
+  SetWebSinkIdRequest({required this.sinkId});
+}
+
+class SetWebSinkIdResponse {}
diff --git a/just_audio_platform_interface/pubspec.yaml b/just_audio_platform_interface/pubspec.yaml
index 20a01d546..5f8a628cb 100644
--- a/just_audio_platform_interface/pubspec.yaml
+++ b/just_audio_platform_interface/pubspec.yaml
@@ -3,7 +3,7 @@ description: A common platform interface for the just_audio plugin. Different pl
 homepage: https://github.com/ryanheise/just_audio/tree/master/just_audio_platform_interface
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 4.3.0
+version: 4.4.0
 
 dependencies:
   flutter:
diff --git a/just_audio_web/CHANGELOG.md b/just_audio_web/CHANGELOG.md
index 107896286..a2915419d 100644
--- a/just_audio_web/CHANGELOG.md
+++ b/just_audio_web/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.4.14
+
+* Add setWebSinkId (@dganzella).
+
 ## 0.4.13
 
 * Fix `dart2js`/`dart2wasm` compile error with Flutter 3.26.0 (@SleepySquash).
diff --git a/just_audio_web/lib/just_audio_web.dart b/just_audio_web/lib/just_audio_web.dart
index 13bdc1adb..01e0807a6 100644
--- a/just_audio_web/lib/just_audio_web.dart
+++ b/just_audio_web/lib/just_audio_web.dart
@@ -179,11 +179,6 @@ class Html5AudioPlayer extends JustAudioPlayer {
     return orderInv;
   }
 
-  /// Sets a specific device output id, null for default
-  Future<void> setWebSinkId(String? sinkId) async {
-    await _audioElement.setSinkId(sinkId ?? '').toDart;
-  }
-
   /// Called when playback reaches the end of an item.
   Future<void> onEnded() async {
     if (_loopMode == LoopModeMessage.one) {
@@ -364,6 +359,13 @@ class Html5AudioPlayer extends JustAudioPlayer {
     return SetWebCrossOriginResponse();
   }
 
+  /// Sets a specific device output id, null for default
+  @override
+  Future<SetWebSinkIdResponse> setWebSinkId(SetWebSinkIdRequest request) async {
+    await _audioElement.setSinkId(request.sinkId).toDart;
+    return SetWebSinkIdResponse();
+  }
+
   @override
   Future<SeekResponse> seek(SeekRequest request) async {
     await _seek(request.position?.inMilliseconds ?? 0, request.index);
diff --git a/just_audio_web/pubspec.yaml b/just_audio_web/pubspec.yaml
index 269db1b19..b561e0789 100644
--- a/just_audio_web/pubspec.yaml
+++ b/just_audio_web/pubspec.yaml
@@ -1,7 +1,7 @@
 name: just_audio_web
 description: Web platform implementation of just_audio. This implementation is endorsed and therefore doesn't require a direct dependency.
 homepage: https://github.com/ryanheise/just_audio/tree/master/just_audio_web
-version: 0.4.13
+version: 0.4.14
 
 flutter:
   plugin:
@@ -11,14 +11,14 @@ flutter:
         fileName: just_audio_web.dart
 
 dependencies:
-  just_audio_platform_interface: ^4.3.0
+  just_audio_platform_interface: ^4.4.0
   # just_audio_platform_interface:
   #   path: ../just_audio_platform_interface
   flutter:
     sdk: flutter
   flutter_web_plugins:
     sdk: flutter
-  web: '>=0.5.1 <2.0.0'
+  web: ^1.0.0
 
 dev_dependencies:
   flutter_lints: ^2.0.1