[video_player] Implements background playback functionality

packages/video_player/video_player/CHANGELOG.md

@@ -1,8 +1,12 @@
+## 2.11.0
+
+* Implements background playback functionality using allowBackgroundPlayback option.
+
 ## 2.10.0
 
 * Adds support for platform views as an optional way of displaying a video on Android and iOS.
-* Updates README to indicate that Andoid SDK <21 is no longer supported.
 * Updates minimum supported SDK version to Flutter 3.27/Dart 3.6.
+* Updates README to indicate that Android SDK <21 is no longer supported.
 
 ## 2.9.5
 

packages/video_player/video_player/README.md

@@ -22,6 +22,15 @@ in `<project root>/ios/Runner/Info.plist`. See
 [Apple's documentation](https://developer.apple.com/documentation/bundleresources/information_property_list/nsapptransportsecurity)
 to determine the right combination of entries for your use case and supported iOS versions.
 
+If you plan to use background playback, you will also need to add the following permission in your Info.plist file.
+
+```xml
+<key>UIBackgroundModes</key>
+<array>
+  <string>audio</string>
+</array>
+```
+
 ### Android
 
 If you are using network-based videos, ensure that the following permission is present in your
@@ -31,6 +40,12 @@ Android Manifest file, located in `<project root>/android/app/src/main/AndroidMa
 <uses-permission android:name="android.permission.INTERNET"/>
 ```
 
+If you plan to use background playback, you will also need to add the following permission in your Android Manifest file.
+
+```xml
+<uses-permission android:name="android.permission.WAKE_LOCK"/>
+```
+
 ### macOS
 
 If you are using network-based videos, you will need to [add the

packages/video_player/video_player/example/pubspec.yaml

@@ -35,3 +35,10 @@ flutter:
     - assets/bumble_bee_captions.srt
     - assets/bumble_bee_captions.vtt
     - assets/Audio.mp3
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_android: {path: ../../../../packages/video_player/video_player_android}
+  video_player_avfoundation: {path: ../../../../packages/video_player/video_player_avfoundation}
+  video_player_platform_interface: {path: ../../../../packages/video_player/video_player_platform_interface}
+  video_player_web: {path: ../../../../packages/video_player/video_player_web}

packages/video_player/video_player/lib/video_player.dart

@@ -464,6 +464,11 @@ class VideoPlayerController extends ValueNotifier<VideoPlayerValue> {
           .setMixWithOthers(videoPlayerOptions!.mixWithOthers);
     }
 
+    if (videoPlayerOptions?.allowBackgroundPlayback != null) {
+      await _videoPlayerPlatform.setAllowBackgroundPlayback(
+          videoPlayerOptions!.allowBackgroundPlayback);
+    }
+
     _playerId =
         (await _videoPlayerPlatform.createWithOptions(creationOptions)) ??
             kUninitializedPlayerId;

packages/video_player/video_player/pubspec.yaml

@@ -3,7 +3,7 @@ description: Flutter plugin for displaying inline video with other Flutter
   widgets on Android, iOS, macOS and web.
 repository: https://github.com/flutter/packages/tree/main/packages/video_player/video_player
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+video_player%22
-version: 2.10.0
+version: 2.11.0
 
 environment:
   sdk: ^3.6.0
@@ -38,3 +38,10 @@ dev_dependencies:
 topics:
   - video
   - video-player
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_android: {path: ../../../packages/video_player/video_player_android}
+  video_player_avfoundation: {path: ../../../packages/video_player/video_player_avfoundation}
+  video_player_platform_interface: {path: ../../../packages/video_player/video_player_platform_interface}
+  video_player_web: {path: ../../../packages/video_player/video_player_web}

packages/video_player/video_player/test/video_player_test.dart

@@ -1519,6 +1519,11 @@ class FakeVideoPlayerPlatform extends VideoPlayerPlatform {
     calls.add('setMixWithOthers');
   }
 
+  @override
+  Future<void> setAllowBackgroundPlayback(bool allowBackgroundPlayback) async {
+    calls.add('setAllowBackgroundPlayback');
+  }
+
   @override
   Widget buildView(int playerId) {
     return Texture(textureId: playerId);

packages/video_player/video_player_android/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.9.0
+
+* Implements background playback functionality using allowBackgroundPlayback option.
+
 ## 2.8.7
 
 * Adds note about known issue regarding platform views to the README.

packages/video_player/video_player_android/README.md

@@ -11,6 +11,12 @@ so you do not need to add it to your `pubspec.yaml`.
 However, if you `import` this package to use any of its APIs directly, you
 should add it to your `pubspec.yaml` as usual.
 
+If you plan to use background playback, you will also need to add the following permission in your Android Manifest file.
+
+```xml
+<uses-permission android:name="android.permission.WAKE_LOCK"/>
+```
+
 ## Known issues
 
 Using `VideoViewType.platformView` is not currently recommended on Android due to a known [issue][3] affecting platform views on Android.

packages/video_player/video_player_android/android/src/main/java/io/flutter/plugins/videoplayer/Messages.java

@@ -1,7 +1,7 @@
 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-// Autogenerated from Pigeon (v22.6.1), do not edit directly.
+// Autogenerated from Pigeon (v22.7.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 
 package io.flutter.plugins.videoplayer;
@@ -397,6 +397,8 @@ public interface AndroidVideoPlayerApi {
 
     void setMixWithOthers(@NonNull Boolean mixWithOthers);
 
+    void setAllowBackgroundPlayback(@NonNull Boolean allowBackgroundPlayback);
+
     /** The codec used by AndroidVideoPlayerApi. */
     static @NonNull MessageCodec<Object> getCodec() {
       return PigeonCodec.INSTANCE;
@@ -693,6 +695,31 @@ static void setUp(
           channel.setMessageHandler(null);
         }
       }
+      {
+        BasicMessageChannel<Object> channel =
+            new BasicMessageChannel<>(
+                binaryMessenger,
+                "dev.flutter.pigeon.video_player_android.AndroidVideoPlayerApi.setAllowBackgroundPlayback"
+                    + messageChannelSuffix,
+                getCodec());
+        if (api != null) {
+          channel.setMessageHandler(
+              (message, reply) -> {
+                ArrayList<Object> wrapped = new ArrayList<>();
+                ArrayList<Object> args = (ArrayList<Object>) message;
+                Boolean allowBackgroundPlaybackArg = (Boolean) args.get(0);
+                try {
+                  api.setAllowBackgroundPlayback(allowBackgroundPlaybackArg);
+                  wrapped.add(0, null);
+                } catch (Throwable exception) {
+                  wrapped = wrapError(exception);
+                }
+                reply.reply(wrapped);
+              });
+        } else {
+          channel.setMessageHandler(null);
+        }
+      }
     }
   }
 }

packages/video_player/video_player_android/android/src/main/java/io/flutter/plugins/videoplayer/VideoPlayer.java

@@ -49,7 +49,7 @@ public VideoPlayer(
     exoPlayer.setMediaItem(mediaItem);
     exoPlayer.prepare();
     exoPlayer.addListener(createExoPlayerEventListener(exoPlayer, surfaceProducer));
-    setAudioAttributes(exoPlayer, options.mixWithOthers);
+    setAudioAttributes(exoPlayer, options.mixWithOthers, options.allowBackgroundPlayback);
   }
 
   @NonNull
@@ -60,7 +60,13 @@ void sendBufferingUpdate() {
     videoPlayerEvents.onBufferingUpdate(exoPlayer.getBufferedPosition());
   }
 
-  private static void setAudioAttributes(ExoPlayer exoPlayer, boolean isMixMode) {
+  private static void setAudioAttributes(
+      ExoPlayer exoPlayer, boolean isMixMode, boolean allowBackgroundPlayback) {
+    if (allowBackgroundPlayback) {
+      // This flag allows playback to continue when the device is in Doze mode.
+      // WAKE_MODE_NETWORK is used to allow network streaming to continue.
+      exoPlayer.setWakeMode(C.WAKE_MODE_NETWORK);
+    }
     exoPlayer.setAudioAttributes(
         new AudioAttributes.Builder().setContentType(C.AUDIO_CONTENT_TYPE_MOVIE).build(),
         !isMixMode);

packages/video_player/video_player_android/android/src/main/java/io/flutter/plugins/videoplayer/VideoPlayerOptions.java

@@ -6,4 +6,5 @@
 
 public class VideoPlayerOptions {
   public boolean mixWithOthers;
+  public boolean allowBackgroundPlayback;
 }

packages/video_player/video_player_android/android/src/main/java/io/flutter/plugins/videoplayer/VideoPlayerPlugin.java

@@ -223,6 +223,11 @@ public void setMixWithOthers(@NonNull Boolean mixWithOthers) {
     options.mixWithOthers = mixWithOthers;
   }
 
+  @Override
+  public void setAllowBackgroundPlayback(@NonNull Boolean allowBackgroundPlayback) {
+    options.allowBackgroundPlayback = allowBackgroundPlayback;
+  }
+
   private interface KeyForAssetFn {
     String get(String asset);
   }

packages/video_player/video_player_android/android/src/test/java/io/flutter/plugins/videoplayer/VideoPlayerTest.java

@@ -213,4 +213,27 @@ public void disposeReleasesExoPlayer() {
 
     verify(mockExoPlayer).release();
   }
+
+  @Test
+  public void loadsAndPreparesProvidedMediaWithoutWakeModeByDefault() {
+    VideoPlayerOptions options = new VideoPlayerOptions();
+
+    VideoPlayer videoPlayer = createVideoPlayer(options);
+
+    verify(mockExoPlayer, never()).setWakeMode(anyInt());
+
+    videoPlayer.dispose();
+  }
+
+  @Test
+  public void loadsAndPreparesProvidedMediaWakeModeWhenAllowBackgroundPlaybackSet() {
+    VideoPlayerOptions options = new VideoPlayerOptions();
+    options.allowBackgroundPlayback = true;
+
+    VideoPlayer videoPlayer = createVideoPlayer(options);
+
+    verify(mockExoPlayer).setWakeMode(C.WAKE_MODE_NETWORK);
+
+    videoPlayer.dispose();
+  }
 }

packages/video_player/video_player_android/example/pubspec.yaml

@@ -34,3 +34,7 @@ flutter:
   assets:
     - assets/flutter-mark-square-64.png
     - assets/Butterfly-209.mp4
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_platform_interface: {path: ../../../../packages/video_player/video_player_platform_interface}

packages/video_player/video_player_android/lib/src/android_video_player.dart

@@ -199,6 +199,11 @@ class AndroidVideoPlayer extends VideoPlayerPlatform {
     return _api.setMixWithOthers(mixWithOthers);
   }
 
+  @override
+  Future<void> setAllowBackgroundPlayback(bool allowBackgroundPlayback) {
+    return _api.setAllowBackgroundPlayback(allowBackgroundPlayback);
+  }
+
   EventChannel _eventChannelFor(int playerId) {
     return EventChannel('flutter.io/videoPlayer/videoEvents$playerId');
   }

packages/video_player/video_player_android/lib/src/messages.g.dart

@@ -1,7 +1,7 @@
 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-// Autogenerated from Pigeon (v22.6.1), do not edit directly.
+// Autogenerated from Pigeon (v22.7.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name, unnecessary_import, no_leading_underscores_for_local_identifiers
 
@@ -429,4 +429,29 @@ class AndroidVideoPlayerApi {
       return;
     }
   }
+
+  Future<void> setAllowBackgroundPlayback(bool allowBackgroundPlayback) async {
+    final String pigeonVar_channelName =
+        'dev.flutter.pigeon.video_player_android.AndroidVideoPlayerApi.setAllowBackgroundPlayback$pigeonVar_messageChannelSuffix';
+    final BasicMessageChannel<Object?> pigeonVar_channel =
+        BasicMessageChannel<Object?>(
+          pigeonVar_channelName,
+          pigeonChannelCodec,
+          binaryMessenger: pigeonVar_binaryMessenger,
+        );
+    final List<Object?>? pigeonVar_replyList =
+        await pigeonVar_channel.send(<Object?>[allowBackgroundPlayback])
+            as List<Object?>?;
+    if (pigeonVar_replyList == null) {
+      throw _createConnectionError(pigeonVar_channelName);
+    } else if (pigeonVar_replyList.length > 1) {
+      throw PlatformException(
+        code: pigeonVar_replyList[0]! as String,
+        message: pigeonVar_replyList[1] as String?,
+        details: pigeonVar_replyList[2],
+      );
+    } else {
+      return;
+    }
+  }
 }

packages/video_player/video_player_android/pigeons/messages.dart

@@ -47,4 +47,5 @@ abstract class AndroidVideoPlayerApi {
   void seekTo(int playerId, int position);
   void pause(int playerId);
   void setMixWithOthers(bool mixWithOthers);
+  void setAllowBackgroundPlayback(bool allowBackgroundPlayback);
 }

packages/video_player/video_player_android/pubspec.yaml

@@ -2,7 +2,7 @@ name: video_player_android
 description: Android implementation of the video_player plugin.
 repository: https://github.com/flutter/packages/tree/main/packages/video_player/video_player_android
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+video_player%22
-version: 2.8.7
+version: 2.9.0
 
 environment:
   sdk: ^3.7.0
@@ -30,3 +30,7 @@ dev_dependencies:
 topics:
   - video
   - video-player
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_platform_interface: {path: ../../../packages/video_player/video_player_platform_interface}

packages/video_player/video_player_android/test/android_video_player_test.dart

@@ -21,6 +21,7 @@ class _ApiLogger implements TestHostVideoPlayerApi {
   double? passedVolume;
   double? passedPlaybackSpeed;
   bool? passedMixWithOthers;
+  bool? passedAllowBackgroundPlayback;
 
   @override
   int create(CreateMessage arg) {
@@ -58,6 +59,12 @@ class _ApiLogger implements TestHostVideoPlayerApi {
     passedMixWithOthers = mixWithOthers;
   }
 
+  @override
+  void setAllowBackgroundPlayback(bool allowBackgroundPlayback) {
+    log.add('setAllowBackgroundPlayback');
+    passedAllowBackgroundPlayback = allowBackgroundPlayback;
+  }
+
   @override
   int position(int playerId) {
     log.add('position');
@@ -381,6 +388,16 @@ void main() {
       expect(log.passedMixWithOthers, false);
     });
 
+    test('setAllowBackgroundPlayback', () async {
+      await player.setAllowBackgroundPlayback(true);
+      expect(log.log.last, 'setAllowBackgroundPlayback');
+      expect(log.passedAllowBackgroundPlayback, true);
+
+      await player.setAllowBackgroundPlayback(false);
+      expect(log.log.last, 'setAllowBackgroundPlayback');
+      expect(log.passedAllowBackgroundPlayback, false);
+    });
+
     test('setVolume', () async {
       await player.setVolume(1, 0.7);
       expect(log.log.last, 'setVolume');