refactor: deprecate mediaPlaybackAllowsAirPlay

Apple has deprecated "mediaPlaybackAllowsAirPlay" in iOS 8.0-9.0. This flag should be replaced with "allowsAirPlayForMediaPlayback". Preference name has also been changed to "AllowsAirPlayForMediaPlayback"
apache · Feb 22, 2020 · 60795b6 · 60795b6
1 parent 4ac1552
commit 60795b6
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/CordovaLib/Classes/Private/Plugins/CDVWebViewEngine/CDVWebViewEngine.m b/CordovaLib/Classes/Private/Plugins/CDVWebViewEngine/CDVWebViewEngine.m
@@ -84,7 +84,17 @@ - (WKWebViewConfiguration*) createConfigurationFromSettings:(NSDictionary*)setti
     configuration.mediaTypesRequiringUserActionForPlayback = mediaTypesRequiringUserActionForPlayback;
 
     configuration.suppressesIncrementalRendering = [settings cordovaBoolSettingForKey:@"SuppressesIncrementalRendering" defaultValue:NO];
-    configuration.mediaPlaybackAllowsAirPlay = [settings cordovaBoolSettingForKey:@"MediaPlaybackAllowsAirPlay" defaultValue:YES];
+
+    /*
+     * If the old preference key "MediaPlaybackAllowsAirPlay" exists, use it or default to "YES".
+     * Check if the new preference key "AllowsAirPlayForMediaPlayback" exists and overwrite the "MediaPlaybackAllowsAirPlay" value.
+     */
+    BOOL allowsAirPlayForMediaPlayback = [settings cordovaBoolSettingForKey:@"MediaPlaybackAllowsAirPlay" defaultValue:YES];
+    if([settings cordovaSettingForKey:@"AllowsAirPlayForMediaPlayback"] != nil) {
+        allowsAirPlayForMediaPlayback = [settings cordovaBoolSettingForKey:@"MediaPlaybackAllowsAirPlay" defaultValue:YES];
+    }
+    configuration.allowsAirPlayForMediaPlayback = allowsAirPlayForMediaPlayback;
+
     return configuration;
 }
 

diff --git a/bin/templates/scripts/cordova/lib/prepare.js b/bin/templates/scripts/cordova/lib/prepare.js
@@ -522,7 +522,8 @@ function updateFileResources (cordovaProject, locations) {
 
 function alertDeprecatedPreference (configParser) {
     const deprecatedToNewPreferences = {
-        MediaPlaybackRequiresUserAction: 'MediaTypesRequiringUserActionForPlayback'
+        MediaPlaybackRequiresUserAction: 'MediaTypesRequiringUserActionForPlayback',
+        MediaPlaybackAllowsAirPlay: 'AllowsAirPlayForMediaPlayback'
     };
 
     Object.keys(deprecatedToNewPreferences).forEach(oldKey => {

diff --git a/tests/CordovaLibTests/CDVWebViewEngineTest.m b/tests/CordovaLibTests/CDVWebViewEngineTest.m
@@ -92,7 +92,7 @@ - (void) testUpdateInfo {
                                [@"AllowInlineMediaPlayback" lowercaseString] : @YES, // default is NO
                                [@"MediaTypesRequiringUserActionForPlayback" lowercaseString] : @YES, // default is NO
                                [@"SuppressesIncrementalRendering" lowercaseString] : @YES, // default is NO
-                               [@"MediaPlaybackAllowsAirPlay" lowercaseString] : @NO, // default is YES
+                               [@"AllowsAirPlayForMediaPlayback" lowercaseString] : @NO, // default is YES
                                [@"DisallowOverscroll" lowercaseString] : @YES, // so bounces is to be NO. defaults to NO
                                [@"WKWebViewDecelerationSpeed" lowercaseString] : @"fast" // default is 'normal'
                                };
@@ -108,7 +108,7 @@ - (void) testUpdateInfo {
     XCTAssertTrue(wkWebView.configuration.mediaTypesRequiringUserActionForPlayback);
     XCTAssertFalse(wkWebView.configuration.allowsInlineMediaPlayback);
     XCTAssertFalse(wkWebView.configuration.suppressesIncrementalRendering);
-    XCTAssertTrue(wkWebView.configuration.mediaPlaybackAllowsAirPlay);
+    XCTAssertTrue(wkWebView.configuration.allowsAirPlayForMediaPlayback);
 
     // in the test above, DisallowOverscroll is YES, so no bounce
     if ([wkWebView respondsToSelector:@selector(scrollView)]) {
@@ -135,7 +135,7 @@ - (void) testConfigurationFromSettings {
                                   [@"AllowInlineMediaPlayback" lowercaseString] : @YES, // default is NO
                                   [@"MediaTypesRequiringUserActionForPlayback" lowercaseString] : @YES, // default is NO
                                   [@"SuppressesIncrementalRendering" lowercaseString] : @YES, // default is NO
-                                  [@"MediaPlaybackAllowsAirPlay" lowercaseString] : @NO, // default is YES
+                                  [@"AllowsAirPlayForMediaPlayback" lowercaseString] : @NO, // default is YES
                                   [@"DisallowOverscroll" lowercaseString] : @YES, // so bounces is to be NO. defaults to NO
                                   [@"WKWebViewDecelerationSpeed" lowercaseString] : @"fast" // default is 'normal'
                                   };
@@ -157,7 +157,7 @@ - (void) testConfigurationFromSettings {
     XCTAssertTrue(wkWebView.configuration.allowsInlineMediaPlayback);
     XCTAssertTrue(wkWebView.configuration.suppressesIncrementalRendering);
     // The test case below is in a separate test "testConfigurationWithMediaPlaybackAllowsAirPlay" (Apple bug)
-    // XCTAssertFalse(wkWebView.configuration.mediaPlaybackAllowsAirPlay);
+    // XCTAssertFalse(wkWebView.configuration.allowsAirPlayForMediaPlayback);
 
     // in the test above, DisallowOverscroll is YES, so no bounce
     if ([wkWebView respondsToSelector:@selector(scrollView)]) {