Polishing crossorigin API and docs.

just_audio/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.9.38
+
+* Migrate to package:web.
+* Add AudioPlayer.setWebCrossOrigin for CORS on web (@danielwinkler).
+
 ## 0.9.37
 
 * Support useLazyPreparation on iOS/macOS.

just_audio/README.md

@@ -436,7 +436,7 @@ Please also consider pressing the thumbs up button at the top of [this page](htt
 | read from file                 | ✅      | ✅  | ✅    | ✅  | ✅      | ✅    |
 | read from asset                | ✅      | ✅  | ✅    | ✅  | ✅      | ✅    |
 | read from byte stream          | ✅      | ✅  | ✅    | ✅  | ✅      | ✅    |
-| request headers                | ✅      | ✅  | ✅    | [^1] | ✅     | ✅    |
+| request headers                | ✅      | ✅  | ✅    | *   | ✅      | ✅    |
 | DASH                           | ✅      |     |       |     | ✅      | ✅    |
 | HLS                            | ✅      | ✅  | ✅    |     | ✅      | ✅    |
 | ICY metadata                   | ✅      | ✅  | ✅    |     |         |       |
@@ -456,8 +456,7 @@ Please also consider pressing the thumbs up button at the top of [this page](htt
 | equalizer                      | ✅      |     |       |     |         | ✅    |
 | volume boost                   | ✅      |     |       |     |         | ✅    |
 
-[^1]: While headers cannot be set directly, cookies can be used to send information in the [Cookie header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cookie).
-See also `setWebCrossOrigin` to send cookies when loading audio files from a different origin (see [HTMLMediaElement crossOrigin](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/crossOrigin)).
+(*): While request headers cannot be set directly on Web, cookies can be used to send information in the [Cookie header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cookie). See also `AudioPlayer.setWebCrossOrigin` to allow sending cookies when loading audio files from the same origin or a different origin.
 
 
 ## Experimental features

just_audio/lib/just_audio.dart

@@ -138,6 +138,7 @@ class AudioPlayer {
   bool _playInterrupted = false;
   bool _platformLoading = false;
   AndroidAudioAttributes? _androidAudioAttributes;
+  WebCrossOrigin? _webCrossOrigin;
   final bool _androidApplyAudioAttributes;
   final bool _handleAudioSessionActivation;
 
@@ -1196,16 +1197,27 @@ class AudioPlayer {
         usage: audioAttributes.usage.value));
   }
 
-  Future<void> setWebCrossOrigin(bool useCredentials) async {
+  /// Set the `crossorigin` attribute on the `<audio>` element backing this
+  /// player instance on web (see
+  /// [HTMLMediaElement crossorigin](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/crossOrigin) ).
+  ///
+  /// If [webCrossOrigin] is null (the initial state), the URL will be fetched
+  /// without CORS. If it is `useCredentials`, a CORS request will be made
+  /// exchanging credentials (via cookies/certificates/HTTP authentication)
+  /// regardless of the origin. If it is 'anonymous', a CORS request will be
+  /// made, but credentials are exchanged only if the URL is fetched from the
+  /// same origin.
+  Future<void> setWebCrossOrigin(WebCrossOrigin? webCrossOrigin) async {
     if (_disposed) return;
     if (!kIsWeb && !_isUnitTest()) return;
-    final WebCrossOriginMessage crossOriginMsg = useCredentials
-        ? WebCrossOriginMessage.useCredentials
-        : WebCrossOriginMessage.anonymous;
 
-    await (await _platform).webSetCrossOrigin(
-      WebSetCrossOriginRequest(crossOrigin: crossOriginMsg),
+    await (await _platform).setWebCrossOrigin(
+      SetWebCrossOriginRequest(
+          crossOrigin: webCrossOrigin == null
+              ? null
+              : WebCrossOriginMessage.values[webCrossOrigin.index]),
     );
+    _webCrossOrigin = webCrossOrigin;
   }
 
   /// Release all resources associated with this player. You must invoke this
@@ -1458,6 +1470,11 @@ class AudioPlayer {
                 ? ShuffleModeMessage.all
                 : ShuffleModeMessage.none));
         if (checkInterruption()) return platform;
+        if (kIsWeb && _webCrossOrigin != null) {
+          await platform.setWebCrossOrigin(SetWebCrossOriginRequest(
+            crossOrigin: WebCrossOriginMessage.values[_webCrossOrigin!.index],
+          ));
+        }
         for (var audioEffect in _audioPipeline._audioEffects) {
           await audioEffect._activate(platform);
           if (checkInterruption()) return platform;
@@ -3498,6 +3515,9 @@ class DefaultShuffleOrder extends ShuffleOrder {
 /// An enumeration of modes that can be passed to [AudioPlayer.setLoopMode].
 enum LoopMode { off, one, all }
 
+/// Possible values that can be passed to [AudioPlayer.setWebCrossOrigin].
+enum WebCrossOrigin { anonymous, useCredentials }
+
 /// The stand-in platform implementation to use when the player is in the idle
 /// state and the native platform is deallocated.
 class _IdleAudioPlayer extends AudioPlayerPlatform {
@@ -3595,6 +3615,12 @@ class _IdleAudioPlayer extends AudioPlayerPlatform {
     return SetShuffleOrderResponse();
   }
 
+  @override
+  Future<SetWebCrossOriginResponse> setWebCrossOrigin(
+      SetWebCrossOriginRequest request) async {
+    return SetWebCrossOriginResponse();
+  }
+
   @override
   Future<SetAutomaticallyWaitsToMinimizeStallingResponse>
       setAutomaticallyWaitsToMinimizeStalling(

just_audio/pubspec.yaml

@@ -14,7 +14,7 @@ environment:
   flutter: ">=3.10.0"
 
 dependencies:
-  just_audio_platform_interface: ^4.2.3
+  just_audio_platform_interface: ^4.3.0
   # just_audio_platform_interface:
   #   path: ../just_audio_platform_interface
   just_audio_web: ^0.4.11

just_audio_platform_interface/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.3.0
+
+* Add setWebCrossOrigin for CORS on web (@danielwinkler).
+
 ## 4.2.2
 
 * Add setAllowsExternalPlayback on iOS/macOS.

just_audio_platform_interface/lib/just_audio_platform_interface.dart

@@ -232,9 +232,9 @@ abstract class AudioPlayerPlatform {
   }
 
   /// Sets the 'crossOrigin' attribute on the web audio element.
-  Future<WebSetCrossOriginResponse> webSetCrossOrigin(
-      WebSetCrossOriginRequest request) {
-    throw UnimplementedError("webSetCrossOrigin() has not been implemented.");
+  Future<SetWebCrossOriginResponse> setWebCrossOrigin(
+      SetWebCrossOriginRequest request) {
+    throw UnimplementedError("setWebCrossOrigin() has not been implemented.");
   }
 }
 
@@ -1492,15 +1492,12 @@ class AndroidEqualizerMessage extends AudioEffectMessage {
       };
 }
 
-class WebSetCrossOriginRequest {
-  final WebCrossOriginMessage crossOrigin;
+class SetWebCrossOriginRequest {
+  final WebCrossOriginMessage? crossOrigin;
 
-  WebSetCrossOriginRequest({required this.crossOrigin});
+  SetWebCrossOriginRequest({required this.crossOrigin});
 }
 
-class WebSetCrossOriginResponse {
-  static WebSetCrossOriginResponse fromMap(Map<dynamic, dynamic> map) =>
-      WebSetCrossOriginResponse();
-}
+class SetWebCrossOriginResponse {}
 
 enum WebCrossOriginMessage { anonymous, useCredentials }

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.2.3
+version: 4.3.0
 
 dependencies:
   flutter:

just_audio_web/CHANGELOG.md

@@ -1,7 +1,7 @@
 ## 0.4.11
 
 * Bump package:web upper bound to <0.6.0
-* Add AudioPlayer.setWebCrossOrigin for CORS on web.
+* Add AudioPlayer.setWebCrossOrigin for CORS on web (@danielwinkler).
 
 ## 0.4.10
 

just_audio_web/lib/just_audio_web.dart

@@ -350,19 +350,13 @@ class Html5AudioPlayer extends JustAudioPlayer {
   }
 
   @override
-  Future<WebSetCrossOriginResponse> webSetCrossOrigin(
-      WebSetCrossOriginRequest request) async {
-    switch (request.crossOrigin) {
-      case WebCrossOriginMessage.anonymous:
-        _audioElement.crossOrigin = 'anonymous';
-        break;
-      case WebCrossOriginMessage.useCredentials:
-        _audioElement.crossOrigin = 'use-credentials';
-        break;
-      default:
-        throw Exception("Unknown CrossOriginMessage: $request.crossOrigin");
-    }
-    return WebSetCrossOriginResponse();
+  Future<SetWebCrossOriginResponse> setWebCrossOrigin(
+      SetWebCrossOriginRequest request) async {
+    _audioElement.crossOrigin = const {
+      WebCrossOriginMessage.anonymous: 'anonymous',
+      WebCrossOriginMessage.useCredentials: 'use-credentials',
+    }[request.crossOrigin];
+    return SetWebCrossOriginResponse();
   }
 
   @override

just_audio_web/pubspec.yaml

@@ -11,7 +11,7 @@ flutter:
         fileName: just_audio_web.dart
 
 dependencies:
-  just_audio_platform_interface: ^4.2.3
+  just_audio_platform_interface: ^4.3.0
   # just_audio_platform_interface:
   #   path: ../just_audio_platform_interface
   flutter: