[webview_flutter_wkwebview] Add support for AutoMediaPlaybackPolicy on iOS (#6659)

Author: bparrishMines

packages/webview_flutter/webview_flutter_wkwebview/lib/src/v4/src/webkit_webview_controller.dart

@@ -17,14 +17,54 @@ import '../../foundation/foundation.dart';
 import '../../web_kit/web_kit.dart';
 import 'webkit_proxy.dart';
 
+/// Media types that can require a user gesture to begin playing.
+///
+/// See [WebKitWebViewControllerCreationParams.mediaTypesRequiringUserAction].
+enum PlaybackMediaTypes {
+  /// A media type that contains audio.
+  audio,
+
+  /// A media type that contains video.
+  video;
+
+  WKAudiovisualMediaType _toWKAudiovisualMediaType() {
+    switch (this) {
+      case PlaybackMediaTypes.audio:
+        return WKAudiovisualMediaType.audio;
+      case PlaybackMediaTypes.video:
+        return WKAudiovisualMediaType.video;
+    }
+  }
+}
+
 /// Object specifying creation parameters for a [WebKitWebViewController].
 @immutable
 class WebKitWebViewControllerCreationParams
     extends PlatformWebViewControllerCreationParams {
   /// Constructs a [WebKitWebViewControllerCreationParams].
   WebKitWebViewControllerCreationParams({
     @visibleForTesting this.webKitProxy = const WebKitProxy(),
-  }) : _configuration = webKitProxy.createWebViewConfiguration();
+    this.mediaTypesRequiringUserAction = const <PlaybackMediaTypes>{
+      PlaybackMediaTypes.audio,
+      PlaybackMediaTypes.video,
+    },
+    this.allowsInlineMediaPlayback = false,
+  }) : _configuration = webKitProxy.createWebViewConfiguration() {
+    if (mediaTypesRequiringUserAction.isEmpty) {
+      _configuration.setMediaTypesRequiringUserActionForPlayback(
+        <WKAudiovisualMediaType>{WKAudiovisualMediaType.none},
+      );
+    } else {
+      _configuration.setMediaTypesRequiringUserActionForPlayback(
+        mediaTypesRequiringUserAction
+            .map<WKAudiovisualMediaType>(
+              (PlaybackMediaTypes type) => type._toWKAudiovisualMediaType(),
+            )
+            .toSet(),
+      );
+    }
+    _configuration.setAllowsInlineMediaPlayback(allowsInlineMediaPlayback);
+  }
 
   /// Constructs a [WebKitWebViewControllerCreationParams] using a
   /// [PlatformWebViewControllerCreationParams].
@@ -33,10 +73,31 @@ class WebKitWebViewControllerCreationParams
     // ignore: avoid_unused_constructor_parameters
     PlatformWebViewControllerCreationParams params, {
     @visibleForTesting WebKitProxy webKitProxy = const WebKitProxy(),
-  }) : this(webKitProxy: webKitProxy);
+    Set<PlaybackMediaTypes> mediaTypesRequiringUserAction =
+        const <PlaybackMediaTypes>{
+      PlaybackMediaTypes.audio,
+      PlaybackMediaTypes.video,
+    },
+    bool allowsInlineMediaPlayback = false,
+  }) : this(
+          webKitProxy: webKitProxy,
+          mediaTypesRequiringUserAction: mediaTypesRequiringUserAction,
+          allowsInlineMediaPlayback: allowsInlineMediaPlayback,
+        );
 
   final WKWebViewConfiguration _configuration;
 
+  /// Media types that require a user gesture to begin playing.
+  ///
+  /// Defaults to include [PlaybackMediaTypes.audio] and
+  /// [PlaybackMediaTypes.video].
+  final Set<PlaybackMediaTypes> mediaTypesRequiringUserAction;
+
+  /// Whether inline playback of HTML5 videos is allowed.
+  ///
+  /// Defaults to false.
+  final bool allowsInlineMediaPlayback;
+
   /// Handles constructing objects and calling static methods for the WebKit
   /// native library.
   @visibleForTesting
@@ -226,11 +287,6 @@ class WebKitWebViewController extends PlatformWebViewController {
     return result.toString();
   }
 
-  /// Controls whether inline playback of HTML5 videos is allowed.
-  Future<void> setAllowsInlineMediaPlayback(bool allow) {
-    return _webView.configuration.setAllowsInlineMediaPlayback(allow);
-  }
-
   @override
   Future<String?> getTitle() => _webView.getTitle();
 

packages/webview_flutter/webview_flutter_wkwebview/pubspec.yaml

@@ -29,5 +29,5 @@ dev_dependencies:
     sdk: flutter
   flutter_test:
     sdk: flutter
-  mockito: ^5.1.0
+  mockito: ^5.3.2
   pigeon: ^3.0.3

packages/webview_flutter/webview_flutter_wkwebview/test/src/foundation/foundation_test.mocks.dart

@@ -1,7 +1,8 @@
-// Mocks generated by Mockito 5.2.0 from annotations
+// Mocks generated by Mockito 5.3.2 from annotations
 // in webview_flutter_wkwebview/example/ios/.symlinks/plugins/webview_flutter_wkwebview/test/src/foundation/foundation_test.dart.
 // Do not manually edit this file.
 
+// ignore_for_file: no_leading_underscores_for_library_prefixes
 import 'package:mockito/mockito.dart' as _i1;
 import 'package:webview_flutter_wkwebview/src/common/web_kit.pigeon.dart'
     as _i3;
@@ -17,6 +18,7 @@ import '../common/test_web_kit.pigeon.dart' as _i2;
 // ignore_for_file: prefer_const_constructors
 // ignore_for_file: unnecessary_parenthesis
 // ignore_for_file: camel_case_types
+// ignore_for_file: subtype_of_sealed_class
 
 /// A class which mocks [TestNSObjectHostApi].
 ///
@@ -28,21 +30,47 @@ class MockTestNSObjectHostApi extends _i1.Mock
   }
 
   @override
-  void dispose(int? identifier) =>
-      super.noSuchMethod(Invocation.method(#dispose, [identifier]),
-          returnValueForMissingStub: null);
+  void dispose(int? identifier) => super.noSuchMethod(
+        Invocation.method(
+          #dispose,
+          [identifier],
+        ),
+        returnValueForMissingStub: null,
+      );
   @override
-  void addObserver(int? identifier, int? observerIdentifier, String? keyPath,
-          List<_i3.NSKeyValueObservingOptionsEnumData?>? options) =>
+  void addObserver(
+    int? identifier,
+    int? observerIdentifier,
+    String? keyPath,
+    List<_i3.NSKeyValueObservingOptionsEnumData?>? options,
+  ) =>
       super.noSuchMethod(
-          Invocation.method(
-              #addObserver, [identifier, observerIdentifier, keyPath, options]),
-          returnValueForMissingStub: null);
+        Invocation.method(
+          #addObserver,
+          [
+            identifier,
+            observerIdentifier,
+            keyPath,
+            options,
+          ],
+        ),
+        returnValueForMissingStub: null,
+      );
   @override
   void removeObserver(
-          int? identifier, int? observerIdentifier, String? keyPath) =>
+    int? identifier,
+    int? observerIdentifier,
+    String? keyPath,
+  ) =>
       super.noSuchMethod(
-          Invocation.method(
-              #removeObserver, [identifier, observerIdentifier, keyPath]),
-          returnValueForMissingStub: null);
+        Invocation.method(
+          #removeObserver,
+          [
+            identifier,
+            observerIdentifier,
+            keyPath,
+          ],
+        ),
+        returnValueForMissingStub: null,
+      );
 }