[video_player] ios picture in picture

packages/video_player/video_player/example/ios/Runner.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 46;
+	objectVersion = 50;
 	objects = {
 
 /* Begin PBXBuildFile section */

packages/video_player/video_player/example/ios/Runner/Info.plist

@@ -2,6 +2,8 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
+	<key>CADisableMinimumFrameDurationOnPhone</key>
+	<true/>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -27,6 +29,10 @@
 		<key>NSAllowsArbitraryLoads</key>
 		<true/>
 	</dict>
+	<key>UIBackgroundModes</key>
+	<array>
+		<string>audio</string>
+	</array>
 	<key>UILaunchStoryboardName</key>
 	<string>LaunchScreen</string>
 	<key>UIMainStoryboardFile</key>

packages/video_player/video_player/example/lib/main.dart

@@ -207,6 +207,10 @@ class _BumbleBeeRemoteVideo extends StatefulWidget {
 class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
   late VideoPlayerController _controller;
 
+  final GlobalKey<State<StatefulWidget>> _key =
+      GlobalKey<State<StatefulWidget>>();
+  final Key _pictureInPictureKey = UniqueKey();
+
   Future<ClosedCaptionFile> _loadCaptions() async {
     final String fileContents = await DefaultAssetBundle.of(context)
         .loadString('assets/bumble_bee_captions.vtt');
@@ -243,17 +247,63 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
         children: <Widget>[
           Container(padding: const EdgeInsets.only(top: 20.0)),
           const Text('With remote mp4'),
+          FutureBuilder<bool>(
+            key: _pictureInPictureKey,
+            future: _controller.isPictureInPictureSupported(),
+            builder: (BuildContext context, AsyncSnapshot<bool> snapshot) =>
+                Text(snapshot.data ?? false
+                    ? 'Pip is suported'
+                    : 'Pip is not supported'),
+          ),
+          MaterialButton(
+            color: Colors.blue,
+            onPressed: () {
+              final RenderBox? box =
+                  _key.currentContext?.findRenderObject() as RenderBox?;
+              if (box == null) {
+                return;
+              }
+              final Offset offset = box.localToGlobal(Offset.zero);
+              _controller.preparePictureInPicture(
+                top: offset.dy,
+                left: offset.dx,
+                width: box.size.width,
+                height: box.size.height,
+              );
+            },
+            child: const Text('Prepare'),
+          ),
+          MaterialButton(
+            color: Colors.blue,
+            onPressed: () =>
+                _controller.setPictureInPicture(!_controller.value.isPipActive),
+            child:
+                Text(_controller.value.isPipActive ? 'Stop PiP' : 'Start PiP'),
+          ),
           Container(
             padding: const EdgeInsets.all(20),
             child: AspectRatio(
               aspectRatio: _controller.value.aspectRatio,
               child: Stack(
+                key: _key,
                 alignment: Alignment.bottomCenter,
                 children: <Widget>[
                   VideoPlayer(_controller),
                   ClosedCaption(text: _controller.value.caption.text),
-                  _ControlsOverlay(controller: _controller),
-                  VideoProgressIndicator(_controller, allowScrubbing: true),
+                  if (_controller.value.isPipActive) ...<Widget>[
+                    Container(color: Colors.white),
+                    Column(
+                      mainAxisAlignment: MainAxisAlignment.center,
+                      children: const <Widget>[
+                        Icon(Icons.picture_in_picture),
+                        SizedBox(height: 8),
+                        Text('This video is playing in picture in picture.'),
+                      ],
+                    ),
+                  ] else ...<Widget>[
+                    VideoProgressIndicator(_controller, allowScrubbing: true),
+                    _ControlsOverlay(controller: _controller),
+                  ],
                 ],
               ),
             ),

packages/video_player/video_player/lib/video_player.dart

@@ -47,6 +47,7 @@ class VideoPlayerValue {
     this.isPlaying = false,
     this.isLooping = false,
     this.isBuffering = false,
+    this.isPipActive = false,
     this.volume = 1.0,
     this.playbackSpeed = 1.0,
     this.rotationCorrection = 0,
@@ -105,6 +106,9 @@ class VideoPlayerValue {
   /// The current speed of the playback.
   final double playbackSpeed;
 
+  /// True if picture in picture is currently active.
+  final bool isPipActive;
+
   /// A description of the error if present.
   ///
   /// If [hasError] is false this is `null`.
@@ -153,6 +157,7 @@ class VideoPlayerValue {
     bool? isPlaying,
     bool? isLooping,
     bool? isBuffering,
+    bool? isPipActive,
     double? volume,
     double? playbackSpeed,
     int? rotationCorrection,
@@ -169,6 +174,7 @@ class VideoPlayerValue {
       isPlaying: isPlaying ?? this.isPlaying,
       isLooping: isLooping ?? this.isLooping,
       isBuffering: isBuffering ?? this.isBuffering,
+      isPipActive: isPipActive ?? this.isPipActive,
       volume: volume ?? this.volume,
       playbackSpeed: playbackSpeed ?? this.playbackSpeed,
       rotationCorrection: rotationCorrection ?? this.rotationCorrection,
@@ -191,6 +197,7 @@ class VideoPlayerValue {
         'isPlaying: $isPlaying, '
         'isLooping: $isLooping, '
         'isBuffering: $isBuffering, '
+        'isPipActive: $isPipActive, '
         'volume: $volume, '
         'playbackSpeed: $playbackSpeed, '
         'errorDescription: $errorDescription)';
@@ -400,6 +407,12 @@ class VideoPlayerController extends ValueNotifier<VideoPlayerValue> {
         case VideoEventType.bufferingEnd:
           value = value.copyWith(isBuffering: false);
           break;
+        case VideoEventType.startingPiP:
+          value = value.copyWith(isPipActive: true);
+          break;
+        case VideoEventType.stoppedPiP:
+          value = value.copyWith(isPipActive: false);
+          break;
         case VideoEventType.unknown:
           break;
       }
@@ -519,6 +532,40 @@ class VideoPlayerController extends ValueNotifier<VideoPlayerValue> {
     await _videoPlayerPlatform.setVolume(_textureId, value.volume);
   }
 
+  /// Returns true if picture in picture is supported on the device.
+  Future<bool> isPictureInPictureSupported() {
+    return _videoPlayerPlatform.isPictureInPictureSupported();
+  }
+
+  /// Prepare picture in picture by passing the location of the video player view
+  Future<void> preparePictureInPicture({
+    double top = 0,
+    double left = 0,
+    double width = 0,
+    double height = 0,
+  }) async {
+    if (!value.isInitialized || _isDisposed) {
+      return;
+    }
+    await _videoPlayerPlatform.preparePictureInPicture(
+      textureId: _textureId,
+      top: top,
+      left: left,
+      width: width,
+      height: height,
+    );
+  }
+
+  /// Start/stop picture in picture mode
+  Future<void> setPictureInPicture(
+    bool enabled,
+  ) async {
+    if (!value.isInitialized || _isDisposed) {
+      return;
+    }
+    await _videoPlayerPlatform.setPictureInPicture(_textureId, enabled);
+  }
+
   Future<void> _applyPlaybackSpeed() async {
     if (_isDisposedOrNotInitialized) {
       return;
@@ -690,6 +737,7 @@ class _VideoAppLifeCycleObserver extends Object with WidgetsBindingObserver {
   _VideoAppLifeCycleObserver(this._controller);
 
   bool _wasPlayingBeforePause = false;
+  bool _showingPip = false;
   final VideoPlayerController _controller;
 
   void initialize() {
@@ -701,7 +749,10 @@ class _VideoAppLifeCycleObserver extends Object with WidgetsBindingObserver {
     switch (state) {
       case AppLifecycleState.paused:
         _wasPlayingBeforePause = _controller.value.isPlaying;
-        _controller.pause();
+        _showingPip = _controller.value.isPipActive;
+        if (!_showingPip) {
+          _controller.pause();
+        }
         break;
       case AppLifecycleState.resumed:
         if (_wasPlayingBeforePause) {
@@ -734,9 +785,11 @@ class _VideoPlayerState extends State<VideoPlayer> {
   _VideoPlayerState() {
     _listener = () {
       final int newTextureId = widget.controller.textureId;
-      if (newTextureId != _textureId) {
+      final bool newEnabledVideo = !widget.controller.value.isPipActive;
+      if (newTextureId != _textureId || newEnabledVideo != _enabledVideo) {
         setState(() {
           _textureId = newTextureId;
+          // _enabledVideo = newEnabledVideo;
         });
       }
     };
@@ -745,11 +798,13 @@ class _VideoPlayerState extends State<VideoPlayer> {
   late VoidCallback _listener;
 
   late int _textureId;
+  late bool _enabledVideo;
 
   @override
   void initState() {
     super.initState();
     _textureId = widget.controller.textureId;
+    _enabledVideo = !widget.controller.value.isPipActive;
     // Need to listen for initialization events since the actual texture ID
     // becomes available after asynchronous initialization finishes.
     widget.controller.addListener(_listener);
@@ -760,6 +815,7 @@ class _VideoPlayerState extends State<VideoPlayer> {
     super.didUpdateWidget(oldWidget);
     oldWidget.controller.removeListener(_listener);
     _textureId = widget.controller.textureId;
+    _enabledVideo = !widget.controller.value.isPipActive;
     widget.controller.addListener(_listener);
   }
 

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, and web.
 repository: https://github.com/flutter/plugins/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.4.6
+version: 2.5.0
 
 environment:
   sdk: ">=2.14.0 <3.0.0"

packages/video_player/video_player/test/video_player_test.dart

@@ -79,6 +79,22 @@ class FakeController extends ValueNotifier<VideoPlayerValue>
   Future<void> setClosedCaptionFile(
     Future<ClosedCaptionFile>? closedCaptionFile,
   ) async {}
+
+  @override
+  Future<void> preparePictureInPicture({
+    double top = 0,
+    double left = 0,
+    double width = 0,
+    double height = 0,
+  }) async {}
+
+  @override
+  Future<void> setPictureInPicture(bool enabled) async {}
+
+  @override
+  Future<bool> isPictureInPictureSupported() async {
+    return true;
+  }
 }
 
 Future<ClosedCaptionFile> _loadClosedCaption() async =>

packages/video_player/video_player_android/example/lib/mini_controller.dart

@@ -243,6 +243,10 @@ class MiniController extends ValueNotifier<VideoPlayerValue> {
         case VideoEventType.bufferingEnd:
           value = value.copyWith(isBuffering: false);
           break;
+        case VideoEventType.startingPiP:
+          break;
+        case VideoEventType.stoppedPiP:
+          break;
         case VideoEventType.unknown:
           break;
       }

packages/video_player/video_player_avfoundation/example/lib/mini_controller.dart

@@ -35,6 +35,7 @@ class VideoPlayerValue {
     this.isInitialized = false,
     this.isPlaying = false,
     this.isBuffering = false,
+    this.isPipActive = false,
     this.playbackSpeed = 1.0,
     this.errorDescription,
   });
@@ -70,6 +71,9 @@ class VideoPlayerValue {
   /// The current speed of the playback.
   final double playbackSpeed;
 
+  /// True if picture in picture is currently active.
+  final bool isPipActive;
+
   /// A description of the error if present.
   ///
   /// If [hasError] is false this is `null`.
@@ -112,6 +116,7 @@ class VideoPlayerValue {
     bool? isInitialized,
     bool? isPlaying,
     bool? isBuffering,
+    bool? isPipActive,
     double? playbackSpeed,
     String? errorDescription,
   }) {
@@ -123,6 +128,7 @@ class VideoPlayerValue {
       isInitialized: isInitialized ?? this.isInitialized,
       isPlaying: isPlaying ?? this.isPlaying,
       isBuffering: isBuffering ?? this.isBuffering,
+      isPipActive: isPipActive ?? this.isPipActive,
       playbackSpeed: playbackSpeed ?? this.playbackSpeed,
       errorDescription: errorDescription ?? this.errorDescription,
     );
@@ -243,6 +249,12 @@ class MiniController extends ValueNotifier<VideoPlayerValue> {
         case VideoEventType.bufferingEnd:
           value = value.copyWith(isBuffering: false);
           break;
+        case VideoEventType.startingPiP:
+          value = value.copyWith(isPipActive: true);
+          break;
+        case VideoEventType.stoppedPiP:
+          value = value.copyWith(isPipActive: false);
+          break;
         case VideoEventType.unknown:
           break;
       }