#60048: Updated comments related to docs & typo's

packages/video_player/video_player/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 2.7.0
 
-* Added support for picture in picture on iOS
+* Adds support for picture-in-picture on iOS.
 
 ## 2.6.1
 

packages/video_player/video_player/README.md

@@ -135,12 +135,12 @@ and so on.
 
 To learn about playback speed limitations, see the [`setPlaybackSpeed` method documentation](https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerController/setPlaybackSpeed.html).
 
-### Picture in Picture
+### Picture-in-Picture
 
 #### iOS
-On iOS the picture in picture is linked to the AVPlayerController.
-If you want to enable picture in picture make sure to enable the `audio` capability (in Xcode's UI it will say **Audio, AirPlay, and Picture in Picture**).
-Not setting this capability but calling `setPictureInPictureOverlayRectMessage` and `setPictureInPicture` will not start the picture in picture.
+On iOS the picture-in-picture is linked to the AVPlayerController.
+If you want to enable picture-in-picture make sure to enable the `audio` capability (in Xcode's UI it will say **Audio, AirPlay, and Picture in Picture**).
+Not setting this capability but calling `setPictureInPictureOverlayRectMessage` and `setPictureInPicture` will not start the picture-in-picture.
 
 ```xml
     <key>UIBackgroundModes</key>
@@ -150,14 +150,14 @@ Not setting this capability but calling `setPictureInPictureOverlayRectMessage`
 ```
 
 Example:
-![The example app running in iOS with picture in picture enabled](https://github.com/flutter/plugins/blob/main/packages/video_player/video_player/doc/demo_pip_iphone.gif?raw=true)
+![The example app running in iOS with picture-in-picture enabled](https://github.com/flutter/plugins/blob/main/packages/video_player/video_player/doc/demo_pip_iphone.gif?raw=true)
 
 #### Android
 
-On Android the implementation is different. There is no link to the video player. Your complete app will be minimized ([picture in picutre Android documentation](https://developer.android.com/guide/topics/ui/picture-in-picture))
+On Android there is no link to the video player. Your complete app will be minimized ([picture-in-picture Android documentation](https://developer.android.com/guide/topics/ui/picture-in-picture))
 
 You have multiple options on Android:
 - [simple_pip_mode](https://pub.dev/packages/simple_pip_mode)
-- Create your own plugin that follows the andorid documentation
+- Create your own plugin that follows the android documentation
 
 Furthermore, see the example app for an example playback speed implementation.

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

@@ -253,15 +253,15 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
             future: _controller.isPictureInPictureSupported(),
             builder: (BuildContext context, AsyncSnapshot<bool> snapshot) =>
                 Text(snapshot.data ?? false
-                    ? 'Picture in picture is supported'
-                    : 'Picture in picture 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 picture in picture automatically when going to background'),
+                    'Start picture-in-picture automatically when going to background'),
               ),
               Switch(
                 value: _enableStartPictureInPictureAutomaticallyFromInline,
@@ -296,7 +296,7 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
                 ),
               );
             },
-            child: const Text('Set picture in picture overlay rect'),
+            child: const Text('Set picture-in-picture overlay rect'),
           ),
           MaterialButton(
             color: Colors.blue,
@@ -308,8 +308,8 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
               }
             },
             child: Text(_controller.value.isPictureInPictureActive
-                ? 'Stop picture in picture'
-                : 'Start picture in picture'),
+                ? 'Stop picture-in-picture'
+                : 'Start picture-in-picture'),
           ),
           Container(
             padding: const EdgeInsets.all(20),
@@ -330,7 +330,7 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
                       children: const <Widget>[
                         Icon(Icons.picture_in_picture),
                         SizedBox(height: 8),
-                        Text('This video is playing in picture in picture.'),
+                        Text('This video is playing in picture-in-picture.'),
                       ],
                     ),
                   ] else ...<Widget>[

packages/video_player/video_player/lib/video_player.dart

@@ -107,7 +107,7 @@ class VideoPlayerValue {
   /// The current speed of the playback.
   final double playbackSpeed;
 
-  /// True if picture in picture is currently active.
+  /// True if picture-in-picture is currently active.
   final bool isPictureInPictureActive;
 
   /// A description of the error if present.
@@ -577,25 +577,27 @@ class VideoPlayerController extends ValueNotifier<VideoPlayerValue> {
     await _videoPlayerPlatform.setVolume(_textureId, value.volume);
   }
 
-  /// Returns true if picture in picture is supported on the device.
+  /// Returns true if picture-in-picture is supported on the device.
   Future<bool> isPictureInPictureSupported() =>
       _videoPlayerPlatform.isPictureInPictureSupported();
 
-  /// Enable/disable to start picture in picture automatically when the app goes to the background.
+  /// Enable/disable to start picture-in-picture automatically when the app goes to the background.
   Future<void> setAutomaticallyStartPictureInPicture({
     required bool enableStartPictureInPictureAutomaticallyFromInline,
   }) async {
     if (!value.isInitialized || _isDisposed) {
       return;
     }
-    await _videoPlayerPlatform.setAutomaticallyStartPictureInPicture(
+    await _videoPlayerPlatform.setAutomaticallyStartsPictureInPicture(
       textureId: _textureId,
       enableStartPictureInPictureAutomaticallyFromInline:
           enableStartPictureInPictureAutomaticallyFromInline,
     );
   }
 
-  /// Set the location of the video player view. So picture in picture can use it for animating
+  /// Set the location of the video player view. So picture-in-picture can use it for animating.
+  /// The rect will represent the location of the video player view in Flutter. The rect will be
+  /// passed to the platform to position the native picture-in-picture overlay correctly.
   Future<void> setPictureInPictureOverlayRect({
     required Rect rect,
   }) async {
@@ -608,15 +610,15 @@ class VideoPlayerController extends ValueNotifier<VideoPlayerValue> {
     );
   }
 
-  /// Start picture in picture mode
+  /// Start picture-in-picture mode.
   Future<void> startPictureInPicture() async {
     if (!value.isInitialized || _isDisposed) {
       return;
     }
     await _videoPlayerPlatform.startPictureInPicture(_textureId);
   }
 
-  /// Stop picture in picture mode
+  /// Stop picture-in-picture mode.
   Future<void> stopPictureInPicture() async {
     if (!value.isInitialized || _isDisposed) {
       return;

packages/video_player/video_player_avfoundation/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 2.5.0
 
-* Added support for picture in picture on iOS
+* Adds support for picture-in-picture on iOS.
 
 ## 2.4.4
 

packages/video_player/video_player_avfoundation/example/ios/RunnerTests/VideoPlayerTests.m

@@ -275,7 +275,7 @@ - (void)testTransformFix {
   XCTAssertNil(error);
   XCTAssertEqual(avPlayer.volume, 0.1f);
 
-  // Set Picture In Picture
+  // Set picture-in-picture
   NSNumber *isPictureInPictureSupported = [videoPlayerPlugin isPictureInPictureSupported:&error];
   XCTAssertNil(error);
   XCTAssertNotNil(isPictureInPictureSupported);

packages/video_player/video_player_avfoundation/example/ios/RunnerUITests/VideoPlayerUITests.m

@@ -33,21 +33,21 @@ - (void)testPlayVideo {
   [playButton tap];
 
   if ([AVPictureInPictureController isPictureInPictureSupported]) {
-    XCUIElement *pipSupportedText = app.staticTexts[@"Picture in picture is supported"];
+    XCUIElement *pipSupportedText = app.staticTexts[@"Picture-in-picture is supported"];
     XCTAssertTrue([pipSupportedText waitForExistenceWithTimeout:30.0]);
 
-    XCUIElement *pipPrepareButton = app.buttons[@"Set picture in picture overlay rect"];
+    XCUIElement *pipPrepareButton = app.buttons[@"Set picture-in-picture overlay rect"];
     XCTAssertTrue([pipPrepareButton waitForExistenceWithTimeout:30.0]);
     [pipPrepareButton tap];
 
-    XCUIElement *pipStartButton = app.buttons[@"Start picture in picture"];
+    XCUIElement *pipStartButton = app.buttons[@"Start picture-in-picture"];
     XCTAssertTrue([pipStartButton waitForExistenceWithTimeout:30.0]);
     [pipStartButton tap];
 
     XCUIElement *pipUIView = app.otherElements[@"PIPUIView"];
     XCTAssertTrue([pipUIView waitForExistenceWithTimeout:30.0]);
 
-    XCUIElement *pipStopButton = app.buttons[@"Stop picture in picture"];
+    XCUIElement *pipStopButton = app.buttons[@"Stop picture-in-picture"];
     XCTAssertTrue([pipStopButton waitForExistenceWithTimeout:30.0]);
     [pipStopButton tap];
 
@@ -57,7 +57,7 @@ - (void)testPlayVideo {
     XCTAssertFalse([pipUIView exists]);
   } else {
     XCTAssertTrue(
-        [app.staticTexts[@"Picture in picture is not supported"] waitForExistenceWithTimeout:30.0]);
+        [app.staticTexts[@"Picture-in-picture is not supported"] waitForExistenceWithTimeout:30.0]);
   }
 
   NSPredicate *find1xButton = [NSPredicate predicateWithFormat:@"label CONTAINS '1.0x'"];

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

@@ -154,15 +154,15 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
             future: _controller.isPictureInPictureSupported(),
             builder: (BuildContext context, AsyncSnapshot<bool> snapshot) =>
                 Text(snapshot.data ?? false
-                    ? 'Picture in picture is supported'
-                    : 'Picture in picture 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 picture in picture automatically when going to background'),
+                    'Start picture-in-picture automatically when going to background'),
               ),
               Switch(
                 value: _enableStartPictureInPictureAutomaticallyFromInline,
@@ -197,7 +197,7 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
                 ),
               );
             },
-            child: const Text('Set picture in picture overlay rect'),
+            child: const Text('Set picture-in-picture overlay rect'),
           ),
           MaterialButton(
             color: Colors.blue,
@@ -209,8 +209,8 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
               }
             },
             child: Text(_controller.value.isPictureInPictureActive
-                ? 'Stop picture in picture'
-                : 'Start picture in picture'),
+                ? 'Stop picture-in-picture'
+                : 'Start picture-in-picture'),
           ),
           Container(
             padding: const EdgeInsets.all(20),

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

@@ -73,7 +73,7 @@ class VideoPlayerValue {
   /// The current speed of the playback.
   final double playbackSpeed;
 
-  /// True if picture in picture is currently active.
+  /// True if picture-in-picture is currently active.
   final bool isPictureInPictureActive;
 
   /// A description of the error if present.
@@ -384,23 +384,23 @@ class MiniController extends ValueNotifier<VideoPlayerValue> {
     await _applyPlaybackSpeed();
   }
 
-  /// Returns true if picture in picture is supported on the device.
+  /// Returns true if picture-in-picture is supported on the device.
   Future<bool> isPictureInPictureSupported() {
     return _platform.isPictureInPictureSupported();
   }
 
-  /// Enable/disable to start picture in picture automatically when the app goes to the background.
+  /// Enable/disable to start picture-in-picture automatically when the app goes to the background.
   Future<void> setAutomaticallyStartPictureInPicture({
     required bool enableStartPictureInPictureAutomaticallyFromInline,
   }) {
-    return _platform.setAutomaticallyStartPictureInPicture(
+    return _platform.setAutomaticallyStartsPictureInPicture(
       textureId: textureId,
       enableStartPictureInPictureAutomaticallyFromInline:
           enableStartPictureInPictureAutomaticallyFromInline,
     );
   }
 
-  /// Set the location of the video player view. So picture in picture can use it for animating
+  /// Set the location of the video player view. So picture-in-picture can use it for animating
   Future<void> setPictureInPictureOverlayRect({
     required Rect rect,
   }) {
@@ -410,12 +410,12 @@ class MiniController extends ValueNotifier<VideoPlayerValue> {
     );
   }
 
-  /// Start picture in picture mode
+  /// Start picture-in-picture mode.
   Future<void> startPictureInPicture() {
     return _platform.startPictureInPicture(textureId);
   }
 
-  /// Stop picture in picture mode
+  /// Stop picture-in-picture mode.
   Future<void> stopPictureInPicture() {
     return _platform.stopPictureInPicture(textureId);
   }

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

@@ -41,7 +41,7 @@ @interface FLTVideoPlayer
 // streams (not just iOS 16).  (https://github.com/flutter/flutter/issues/109116).
 // An invisible AVPlayerLayer is used to overwrite the protection of pixel buffers in those streams
 // for issue #1, and restore the correct width and height for issue #2.
-// It is also used to start picture in picture
+// It is also used to start picture-in-picture
 @property(readonly, nonatomic) AVPlayerLayer *playerLayer;
 @property(readonly, nonatomic) CADisplayLink *displayLink;
 @property(nonatomic) AVPictureInPictureController *pictureInPictureController;
@@ -258,10 +258,10 @@ - (instancetype)initWithPlayerItem:(AVPlayerItem *)item
   // video streams (not just iOS 16).  (https://github.com/flutter/flutter/issues/109116). An
   // invisible AVPlayerLayer is used to overwrite the protection of pixel buffers in those streams
   // for issue #1, and restore the correct width and height for issue #2.
-  // It is also used to start picture in picture
+  // It is also used to start picture-in-picture
   _playerLayer = [AVPlayerLayer playerLayerWithPlayer:_player];
   // We set the opacity to 0.001 because it is an overlay.
-  // Picture in picture will show a placeholder over other widgets when video_player is used in a
+  // Picture-in-picture will show a placeholder over other widgets when video_player is used in a
   // ScrollView, PageView or in a widget that changes location.
   _playerLayer.opacity = 0.001;
   [rootViewController().view.layer addSublayer:_playerLayer];
@@ -311,8 +311,7 @@ - (void)startOrStopPictureInPicture:(BOOL)shouldPictureInPictureStart {
   if (self.pictureInPictureController && self.isPictureInPictureStarted &&
       ![self.pictureInPictureController isPictureInPictureActive]) {
     if (_eventSink != nil) {
-      // The event is already send here to make sure that Flutter UI can be updates as soon as
-      // possible
+      // The event is sent here to make sure that the Flutter UI can be updated as soon as possible.
       _eventSink(@{@"event" : @"startingPictureInPicture"});
     }
     [self.pictureInPictureController startPictureInPicture];

packages/video_player/video_player_avfoundation/lib/src/avfoundation_video_player.dart

@@ -178,7 +178,7 @@ class AVFoundationVideoPlayer extends VideoPlayerPlatform {
   }
 
   @override
-  Future<void> setAutomaticallyStartPictureInPicture({
+  Future<void> setAutomaticallyStartsPictureInPicture({
     required int textureId,
     required bool enableStartPictureInPictureAutomaticallyFromInline,
   }) {

packages/video_player/video_player_avfoundation/test/avfoundation_video_player_test.dart

@@ -277,7 +277,7 @@ void main() {
     });
 
     test('setAutomaticallyStartPictureInPicture true', () async {
-      await player.setAutomaticallyStartPictureInPicture(
+      await player.setAutomaticallyStartsPictureInPicture(
           textureId: 1,
           enableStartPictureInPictureAutomaticallyFromInline: true);
       expect(log.log.last, 'setAutomaticallyStartPictureInPicture');
@@ -289,7 +289,7 @@ void main() {
     });
 
     test('setAutomaticallyStartPictureInPicture false', () async {
-      await player.setAutomaticallyStartPictureInPicture(
+      await player.setAutomaticallyStartsPictureInPicture(
           textureId: 1,
           enableStartPictureInPictureAutomaticallyFromInline: false);
       expect(log.log.last, 'setAutomaticallyStartPictureInPicture');

packages/video_player/video_player_platform_interface/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 6.2.0
 
-* Added support for picture in picture on iOS
+* Adds support for picture-in-picture on iOS.
 
 ## 6.1.0