Cleanup pip to picture in picture

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

@@ -253,13 +253,15 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
             future: _controller.isPictureInPictureSupported(),
             builder: (BuildContext context, AsyncSnapshot<bool> snapshot) =>
                 Text(snapshot.data ?? false
-                    ? 'PiP is supported'
-                    : 'PiP is not supported'),
+                    ? 'Picture in picture is supported'
+                    : 'Picture in picture is not supported'),
           ),
           Row(
             children: <Widget>[
+              const SizedBox(width: 16),
               const Expanded(
-                child: Text('Start PiP automaticly when going to background'),
+                child: Text(
+                    'Start picture in picture automatically when going to background'),
               ),
               Switch(
                 value: _enableStartPictureInPictureAutomaticallyFromInline,
@@ -268,8 +270,12 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
                     _enableStartPictureInPictureAutomaticallyFromInline =
                         newValue;
                   });
+                  _controller.setAutomaticallyStartPictureInPicture(
+                      enableStartPictureInPictureAutomaticallyFromInline:
+                          _enableStartPictureInPictureAutomaticallyFromInline);
                 },
               ),
+              const SizedBox(width: 16),
             ],
           ),
           MaterialButton(
@@ -290,14 +296,15 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
                 ),
               );
             },
-            child: const Text('Prepare'),
+            child: const Text('Set picture in picture overlay rect'),
           ),
           MaterialButton(
             color: Colors.blue,
-            onPressed: () =>
-                _controller.setPictureInPicture(!_controller.value.isPipActive),
-            child:
-                Text(_controller.value.isPipActive ? 'Stop PiP' : 'Start PiP'),
+            onPressed: () => _controller.setPictureInPicture(
+                !_controller.value.isPictureInPictureActive),
+            child: Text(_controller.value.isPictureInPictureActive
+                ? 'Stop picture in picture'
+                : 'Start picture in picture'),
           ),
           Container(
             padding: const EdgeInsets.all(20),
@@ -309,7 +316,7 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
                 children: <Widget>[
                   VideoPlayer(_controller),
                   ClosedCaption(text: _controller.value.caption.text),
-                  if (_controller.value.isPipActive) ...<Widget>[
+                  if (_controller.value.isPictureInPictureActive) ...<Widget>[
                     Container(color: Colors.white),
                     Column(
                       mainAxisAlignment: MainAxisAlignment.center,

packages/video_player/video_player/lib/video_player.dart

@@ -47,7 +47,7 @@ class VideoPlayerValue {
     this.isPlaying = false,
     this.isLooping = false,
     this.isBuffering = false,
-    this.isPipActive = false,
+    this.isPictureInPictureActive = false,
     this.volume = 1.0,
     this.playbackSpeed = 1.0,
     this.rotationCorrection = 0,
@@ -107,7 +107,7 @@ class VideoPlayerValue {
   final double playbackSpeed;
 
   /// True if picture in picture is currently active.
-  final bool isPipActive;
+  final bool isPictureInPictureActive;
 
   /// A description of the error if present.
   ///
@@ -157,7 +157,7 @@ class VideoPlayerValue {
     bool? isPlaying,
     bool? isLooping,
     bool? isBuffering,
-    bool? isPipActive,
+    bool? isPictureInPictureActive,
     double? volume,
     double? playbackSpeed,
     int? rotationCorrection,
@@ -174,7 +174,8 @@ class VideoPlayerValue {
       isPlaying: isPlaying ?? this.isPlaying,
       isLooping: isLooping ?? this.isLooping,
       isBuffering: isBuffering ?? this.isBuffering,
-      isPipActive: isPipActive ?? this.isPipActive,
+      isPictureInPictureActive:
+          isPictureInPictureActive ?? this.isPictureInPictureActive,
       volume: volume ?? this.volume,
       playbackSpeed: playbackSpeed ?? this.playbackSpeed,
       rotationCorrection: rotationCorrection ?? this.rotationCorrection,
@@ -197,7 +198,7 @@ class VideoPlayerValue {
         'isPlaying: $isPlaying, '
         'isLooping: $isLooping, '
         'isBuffering: $isBuffering, '
-        'isPipActive: $isPipActive, '
+        'isPictureInPictureActive: $isPictureInPictureActive, '
         'volume: $volume, '
         'playbackSpeed: $playbackSpeed, '
         'errorDescription: $errorDescription)';
@@ -407,11 +408,11 @@ class VideoPlayerController extends ValueNotifier<VideoPlayerValue> {
         case VideoEventType.bufferingEnd:
           value = value.copyWith(isBuffering: false);
           break;
-        case VideoEventType.startingPiP:
-          value = value.copyWith(isPipActive: true);
+        case VideoEventType.startingPictureInPicture:
+          value = value.copyWith(isPictureInPictureActive: true);
           break;
-        case VideoEventType.stoppedPiP:
-          value = value.copyWith(isPipActive: false);
+        case VideoEventType.stoppedPictureInPicture:
+          value = value.copyWith(isPictureInPictureActive: false);
           break;
         case VideoEventType.unknown:
           break;
@@ -744,7 +745,7 @@ class _VideoAppLifeCycleObserver extends Object with WidgetsBindingObserver {
   _VideoAppLifeCycleObserver(this._controller);
 
   bool _wasPlayingBeforePause = false;
-  bool _showingPip = false;
+  bool _isPictureInPictureActive = false;
   final VideoPlayerController _controller;
 
   void initialize() {
@@ -756,8 +757,8 @@ class _VideoAppLifeCycleObserver extends Object with WidgetsBindingObserver {
     switch (state) {
       case AppLifecycleState.paused:
         _wasPlayingBeforePause = _controller.value.isPlaying;
-        _showingPip = _controller.value.isPipActive;
-        if (!_showingPip) {
+        _isPictureInPictureActive = _controller.value.isPictureInPictureActive;
+        if (!_isPictureInPictureActive) {
           _controller.pause();
         }
         break;

packages/video_player/video_player/test/video_player_test.dart

@@ -935,7 +935,7 @@ void main() {
           'isPlaying: true, '
           'isLooping: true, '
           'isBuffering: true, '
-          'isPipActive: false, '
+          'isPictureInPictureActive: false, '
           'volume: 0.5, '
           'playbackSpeed: 1.5, '
           'errorDescription: null)');

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

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

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

@@ -201,9 +201,9 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
           ),
           MaterialButton(
             color: Colors.blue,
-            onPressed: () =>
-                _controller.setPictureInPicture(!_controller.value.isPipActive),
-            child: Text(_controller.value.isPipActive
+            onPressed: () => _controller.setPictureInPicture(
+                !_controller.value.isPictureInPictureActive),
+            child: Text(_controller.value.isPictureInPictureActive
                 ? 'Stop picture in picture'
                 : 'Start picture in picture'),
           ),

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

@@ -35,7 +35,7 @@ class VideoPlayerValue {
     this.isInitialized = false,
     this.isPlaying = false,
     this.isBuffering = false,
-    this.isPipActive = false,
+    this.isPictureInPictureActive = false,
     this.playbackSpeed = 1.0,
     this.errorDescription,
   });
@@ -72,7 +72,7 @@ class VideoPlayerValue {
   final double playbackSpeed;
 
   /// True if picture in picture is currently active.
-  final bool isPipActive;
+  final bool isPictureInPictureActive;
 
   /// A description of the error if present.
   ///
@@ -116,7 +116,7 @@ class VideoPlayerValue {
     bool? isInitialized,
     bool? isPlaying,
     bool? isBuffering,
-    bool? isPipActive,
+    bool? isPictureInPictureActive,
     double? playbackSpeed,
     String? errorDescription,
   }) {
@@ -128,7 +128,8 @@ class VideoPlayerValue {
       isInitialized: isInitialized ?? this.isInitialized,
       isPlaying: isPlaying ?? this.isPlaying,
       isBuffering: isBuffering ?? this.isBuffering,
-      isPipActive: isPipActive ?? this.isPipActive,
+      isPictureInPictureActive:
+          isPictureInPictureActive ?? this.isPictureInPictureActive,
       playbackSpeed: playbackSpeed ?? this.playbackSpeed,
       errorDescription: errorDescription ?? this.errorDescription,
     );
@@ -249,11 +250,11 @@ class MiniController extends ValueNotifier<VideoPlayerValue> {
         case VideoEventType.bufferingEnd:
           value = value.copyWith(isBuffering: false);
           break;
-        case VideoEventType.startingPiP:
-          value = value.copyWith(isPipActive: true);
+        case VideoEventType.startingPictureInPicture:
+          value = value.copyWith(isPictureInPictureActive: true);
           break;
-        case VideoEventType.stoppedPiP:
-          value = value.copyWith(isPipActive: false);
+        case VideoEventType.stoppedPictureInPicture:
+          value = value.copyWith(isPictureInPictureActive: false);
           break;
         case VideoEventType.unknown:
           break;

packages/video_player/video_player_avfoundation/ios/Classes/FLTVideoPlayerPlugin.m

@@ -46,7 +46,7 @@ @interface FLTVideoPlayer
 @property(nonatomic, readonly) BOOL isPlaying;
 @property(nonatomic) BOOL isLooping;
 @property(nonatomic, readonly) BOOL isInitialized;
-@property(nonatomic) BOOL isPiPStarted;
+@property(nonatomic) BOOL isPictureInPictureStarted;
 - (instancetype)initWithURL:(NSURL *)url
                frameUpdater:(FLTFrameUpdater *)frameUpdater
                 httpHeaders:(nonnull NSDictionary<NSString *, NSString *> *)headers;
@@ -295,19 +295,21 @@ - (void)setPictureInPictureOverlayRect:(CGRect)frame {
   }
 }
 
-- (void)setPictureInPicture:(BOOL)isPiPStarted {
-  if (self.isPiPStarted == isPiPStarted) {
+- (void)setPictureInPicture:(BOOL)shouldPictureInPictureStart {
+  if (self.isPictureInPictureStarted == shouldPictureInPictureStart) {
     return;
   }
 
-  self.isPiPStarted = isPiPStarted;
-  if (pictureInPictureController && self.isPiPStarted &&
+  self.isPictureInPictureStarted = shouldPictureInPictureStart;
+  if (pictureInPictureController && self.isPictureInPictureStarted &&
       ![pictureInPictureController isPictureInPictureActive]) {
     if (_eventSink != nil) {
-      _eventSink(@{@"event" : @"startingPiP"});
+      // The event is already send here to make sure that Flutter UI can be updates as soon as
+      // possible
+      _eventSink(@{@"event" : @"startingPictureInPicture"});
     }
     [pictureInPictureController startPictureInPicture];
-  } else if (pictureInPictureController && !self.isPiPStarted &&
+  } else if (pictureInPictureController && !self.isPictureInPictureStarted &&
              [pictureInPictureController isPictureInPictureActive]) {
     [pictureInPictureController stopPictureInPicture];
   }
@@ -317,17 +319,17 @@ - (void)setPictureInPicture:(BOOL)isPiPStarted {
 
 - (void)pictureInPictureControllerDidStopPictureInPicture:
     (AVPictureInPictureController *)pictureInPictureController {
-  self.isPiPStarted = NO;
+  self.isPictureInPictureStarted = NO;
   if (_eventSink != nil) {
-    _eventSink(@{@"event" : @"stoppedPiP"});
+    _eventSink(@{@"event" : @"stoppedPictureInPicture"});
   }
 }
 
 - (void)pictureInPictureControllerDidStartPictureInPicture:
     (AVPictureInPictureController *)pictureInPictureController {
-  self.isPiPStarted = YES;
+  self.isPictureInPictureStarted = YES;
   if (_eventSink != nil) {
-    _eventSink(@{@"event" : @"startingPiP"});
+    _eventSink(@{@"event" : @"startingPictureInPicture"});
   }
   [self updatePlayingState];
 }

packages/video_player/video_player_avfoundation/ios/Classes/messages.g.h

@@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN
 @class FLTMixWithOthersMessage;
 @class FLTAutomaticallyStartPictureInPictureMessage;
 @class FLTSetPictureInPictureOverlayRectMessage;
-@class FLTPiPRect;
+@class FLTPictureInPictureOverlayRect;
 @class FLTSetPictureInPictureMessage;
 
 @interface FLTTextureMessage : NSObject
@@ -97,12 +97,13 @@ NS_ASSUME_NONNULL_BEGIN
 @interface FLTSetPictureInPictureOverlayRectMessage : NSObject
 /// `init` unavailable to enforce nonnull fields, see the `make` class method.
 - (instancetype)init NS_UNAVAILABLE;
-+ (instancetype)makeWithTextureId:(NSNumber *)textureId rect:(nullable FLTPiPRect *)rect;
++ (instancetype)makeWithTextureId:(NSNumber *)textureId
+                             rect:(nullable FLTPictureInPictureOverlayRect *)rect;
 @property(nonatomic, strong) NSNumber *textureId;
-@property(nonatomic, strong, nullable) FLTPiPRect *rect;
+@property(nonatomic, strong, nullable) FLTPictureInPictureOverlayRect *rect;
 @end
 
-@interface FLTPiPRect : NSObject
+@interface FLTPictureInPictureOverlayRect : NSObject
 /// `init` unavailable to enforce nonnull fields, see the `make` class method.
 - (instancetype)init NS_UNAVAILABLE;
 + (instancetype)makeWithTop:(NSNumber *)top

packages/video_player/video_player_avfoundation/ios/Classes/messages.g.m

@@ -69,8 +69,8 @@ @interface FLTSetPictureInPictureOverlayRectMessage ()
 + (FLTSetPictureInPictureOverlayRectMessage *)fromMap:(NSDictionary *)dict;
 - (NSDictionary *)toMap;
 @end
-@interface FLTPiPRect ()
-+ (FLTPiPRect *)fromMap:(NSDictionary *)dict;
+@interface FLTPictureInPictureOverlayRect ()
++ (FLTPictureInPictureOverlayRect *)fromMap:(NSDictionary *)dict;
 - (NSDictionary *)toMap;
 @end
 @interface FLTSetPictureInPictureMessage ()
@@ -275,7 +275,8 @@ - (NSDictionary *)toMap {
 @end
 
 @implementation FLTSetPictureInPictureOverlayRectMessage
-+ (instancetype)makeWithTextureId:(NSNumber *)textureId rect:(nullable FLTPiPRect *)rect {
++ (instancetype)makeWithTextureId:(NSNumber *)textureId
+                             rect:(nullable FLTPictureInPictureOverlayRect *)rect {
   FLTSetPictureInPictureOverlayRectMessage *pigeonResult =
       [[FLTSetPictureInPictureOverlayRectMessage alloc] init];
   pigeonResult.textureId = textureId;
@@ -287,7 +288,7 @@ + (FLTSetPictureInPictureOverlayRectMessage *)fromMap:(NSDictionary *)dict {
       [[FLTSetPictureInPictureOverlayRectMessage alloc] init];
   pigeonResult.textureId = GetNullableObject(dict, @"textureId");
   NSAssert(pigeonResult.textureId != nil, @"");
-  pigeonResult.rect = [FLTPiPRect fromMap:GetNullableObject(dict, @"rect")];
+  pigeonResult.rect = [FLTPictureInPictureOverlayRect fromMap:GetNullableObject(dict, @"rect")];
   return pigeonResult;
 }
 - (NSDictionary *)toMap {
@@ -297,20 +298,20 @@ - (NSDictionary *)toMap {
 }
 @end
 
-@implementation FLTPiPRect
+@implementation FLTPictureInPictureOverlayRect
 + (instancetype)makeWithTop:(NSNumber *)top
                        left:(NSNumber *)left
                       width:(NSNumber *)width
                      height:(NSNumber *)height {
-  FLTPiPRect *pigeonResult = [[FLTPiPRect alloc] init];
+  FLTPictureInPictureOverlayRect *pigeonResult = [[FLTPictureInPictureOverlayRect alloc] init];
   pigeonResult.top = top;
   pigeonResult.left = left;
   pigeonResult.width = width;
   pigeonResult.height = height;
   return pigeonResult;
 }
-+ (FLTPiPRect *)fromMap:(NSDictionary *)dict {
-  FLTPiPRect *pigeonResult = [[FLTPiPRect alloc] init];
++ (FLTPictureInPictureOverlayRect *)fromMap:(NSDictionary *)dict {
+  FLTPictureInPictureOverlayRect *pigeonResult = [[FLTPictureInPictureOverlayRect alloc] init];
   pigeonResult.top = GetNullableObject(dict, @"top");
   NSAssert(pigeonResult.top != nil, @"");
   pigeonResult.left = GetNullableObject(dict, @"left");
@@ -370,7 +371,7 @@ - (nullable id)readValueOfType:(UInt8)type {
       return [FLTMixWithOthersMessage fromMap:[self readValue]];
 
     case 132:
-      return [FLTPiPRect fromMap:[self readValue]];
+      return [FLTPictureInPictureOverlayRect fromMap:[self readValue]];
 
     case 133:
       return [FLTPlaybackSpeedMessage fromMap:[self readValue]];
@@ -412,7 +413,7 @@ - (void)writeValue:(id)value {
   } else if ([value isKindOfClass:[FLTMixWithOthersMessage class]]) {
     [self writeByte:131];
     [self writeValue:[value toMap]];
-  } else if ([value isKindOfClass:[FLTPiPRect class]]) {
+  } else if ([value isKindOfClass:[FLTPictureInPictureOverlayRect class]]) {
     [self writeByte:132];
     [self writeValue:[value toMap]];
   } else if ([value isKindOfClass:[FLTPlaybackSpeedMessage class]]) {