[video_player] #60048 ios picture in picture #3500

vanlooverenkoen · 2023-03-20T20:52:57Z

Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.

List which issues are fixed by this PR. You must list at least one issue.

This feature is only available on iOS because android has a different implementation. simple_pip_mode can be used for Android

Fixes flutter/flutter#60048

Migration from flutter/plugin to flutter/packages is done with this pr

old pr: flutter/plugins#6284

No migration needed this is an addon

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

vanlooverenkoen · 2023-03-20T20:56:18Z

@hellohuanlin & @stuartmorgan I did the migration from flutter/plugins#6284 to here

hellohuanlin

carrying over the stamp from previous PR

vanlooverenkoen · 2023-04-03T10:31:45Z

@tarrinneal can I assist you with the review?

tarrinneal

Initial pass. A few changes to be made. Good work on this!

packages/video_player/video_player/CHANGELOG.md

packages/video_player/video_player/README.md

packages/video_player/video_player_avfoundation/CHANGELOG.md

packages/video_player/video_player_platform_interface/lib/video_player_platform_interface.dart

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

packages/video_player/video_player/README.md

packages/video_player/video_player_platform_interface/CHANGELOG.md

# Conflicts: # packages/video_player/video_player/CHANGELOG.md # packages/video_player/video_player/lib/video_player.dart # packages/video_player/video_player/pubspec.yaml # packages/video_player/video_player_android/example/lib/mini_controller.dart # packages/video_player/video_player_avfoundation/CHANGELOG.md # packages/video_player/video_player_avfoundation/example/lib/mini_controller.dart # packages/video_player/video_player_avfoundation/lib/src/avfoundation_video_player.dart # packages/video_player/video_player_avfoundation/pubspec.yaml

…tsPictureInPicture

vanlooverenkoen · 2023-04-17T16:18:14Z

@tarrinneal I updated my pull request fully retested it to make sure it does what I expect.

packages/video_player/video_player/lib/video_player.dart

tarrinneal · 2023-05-10T08:17:19Z

@tarrinneal I updated my pull request fully retested it to make sure it does what I expect.

Seems like you still have a few broken tests. I should be able to get this re-reviewed this week, if you can git them sorted out.

vanlooverenkoen · 2023-05-10T08:22:39Z

@tarrinneal the tests are failing on camera because of the dependency overrides. How should I handle this? Because the dependency override script doesn't update it in the camera package.

I will fix the merge conflicts today

Nols1000 · 2025-01-03T11:24:11Z

Hi @vanlooverenkoen,
Thanks for reaching out. I've pushed the changes to you branch.

stuartmorgan-g · 2025-01-03T11:34:14Z

@stuartmorgan I really want to get this merged, but what do you think is the best way forward?

Merging the changes from @Nols1000 in this PR?

I added @Nols1000 to my repository.

Creating a new merge request @Nols1000 created?

Either one is fine; usually when people pick up unfinished PRs they aren't able to push to them so make a new PR, but since that's not an issue here continuing with the same PR shouldn't have any issues.

stuartmorgan-g

A couple of quick notes on the updated version until I have time for a full review.

stuartmorgan-g · 2025-01-03T11:38:59Z

...undation/darwin/video_player_avfoundation/Sources/video_player_avfoundation/FVPVideoPlayer.m

-#import "./include/video_player_avfoundation/AVAssetTrackUtils.h"
+#import "AVAssetTrackUtils.h"
+#import "FVPDisplayLink.h"
+#import "messages.g.h"


Local imports need to use project-relative paths; fixing that should fix the build_all CI failures.

stuartmorgan-g · 2025-01-03T11:39:21Z

...undation/darwin/video_player_avfoundation/Sources/video_player_avfoundation/FVPVideoPlayer.m

@@ -4,10 +4,14 @@

 #import "./include/video_player_avfoundation/FVPVideoPlayer.h"
 #import "./include/video_player_avfoundation/FVPVideoPlayer_Test.h"
+#import "./include/video_player_avfoundation/AVAssetTrackUtils.h"


This change is incorrect; please see the style guide rules for header import ordering.

stuartmorgan-g · 2025-01-03T11:44:14Z

...ayer/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.5.0), do not edit directly.
+// Autogenerated from Pigeon (v22.7.2), do not edit directly.


Why was video_player_android Pigeon code regenerated for this PR?

…ported

… pip

…cture-in-picture

philipgiuliani · 2025-02-20T14:41:46Z

Hi @vanlooverenkoen, we are using your fork already for a while in production and it works very well. Our released version was still from the end of last year. We've just updated the library and noticed a strange animation happening when setting the pip overlay rect. Also when changing page the video remains visible for a while. See the video below:

TEST.Simulator.Screen.Recording.-.iPhone.16.-.2025-02-20.at.15.39.09.mp4

Nols1000 · 2025-02-20T14:47:23Z

Hi @philipgiuliani ,
this is probably because of me merging the new main branch and trying to implment the change requests. If you use stuff in production please be sure to pin the commit, or maintain your own branch, as features in development might break. I'll try to get to working on it again, but it might be a bit before my weekends are available again.

philipgiuliani · 2025-02-20T14:51:58Z

Thanks for the quick response and checking it! We pinned the commit, but we had to update the package because the old video_player cannot build on Android with Flutter 3.29.

philipgiuliani · 2025-02-20T16:29:16Z

It seems to work perfectly fine by adding the following code back in the initWithPlayerItem function. This code was removed in the process of the refactoring at the beginning of January.

  _playerLayer = [AVPlayerLayer playerLayerWithPlayer:_player];
  // picture-in-picture shows a placeholder where the original video was playing.
  // This is a native overlay that does not scroll with the rest of the Flutter UI.
  // That is why we need to set the opacity of the overlay.
  // Setting it to 0 would result in the picture-in-picture not working.
  // Setting it to 1 would result in the picture-in-picture overlay always showing over other
  // widget. Setting it to 0.001 makes the placeholder invisible, but still allows the
  // picture-in-picture.
  _playerLayer.opacity = 0.001;
  [self.flutterViewLayer addSublayer:_playerLayer];

stuartmorgan-g

Apologies, doing another review pass had fallen off my radar since the review state was never switched back to review request. I've done an initial pass over the current state.

stuartmorgan-g · 2025-04-01T15:00:00Z

packages/camera/camera/example/pubspec.yaml

@@ -18,6 +18,7 @@ dependencies:
    sdk: flutter
  path_provider: ^2.0.0
  video_player: ^2.7.0
+  video_player_platform_interface: ^6.2.3


Why is this addition necessary?

stuartmorgan-g · 2025-04-01T15:02:44Z

packages/video_player/video_player/README.md

+### Picture-in-Picture
+
+#### iOS
+To enable picture-in-picture functionality, you need to add the **Background Modes** capabilities for **Audio, AirPlay, and Picture in Picture** as described in [Configuring your app for media playback > Configure the background modes](https://developer.apple.com/documentation/AVFoundation/configuring-your-app-for-media-playback#Configure-the-background-modes). Resulting in a new string entry `audio` in the array value of the entry `UIBackgroundModes` in your `Info.plist` file, which is located in `<project root>/ios/Runner/Info.plist`:


The second sentence here is a fragment. It should probably say something like "Adding this mode will result in ..."

stuartmorgan-g · 2025-04-01T15:03:29Z

packages/video_player/video_player/README.md

+### Picture-in-Picture
+
+#### iOS
+To enable picture-in-picture functionality, you need to add the **Background Modes** capabilities for **Audio, AirPlay, and Picture in Picture** as described in [Configuring your app for media playback > Configure the background modes](https://developer.apple.com/documentation/AVFoundation/configuring-your-app-for-media-playback#Configure-the-background-modes). Resulting in a new string entry `audio` in the array value of the entry `UIBackgroundModes` in your `Info.plist` file, which is located in `<project root>/ios/Runner/Info.plist`:


Everything from "which is located in" on can be removed; documenting basic iOS project structure isn't necessary here.

stuartmorgan-g · 2025-04-01T15:05:44Z

packages/video_player/video_player/README.md

+> Failing to add the `audio` **Background Modes** capability will result in a silent failure to start picture-in-picture playback.
+
+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)


READMEs should never have references to non-pinned URLs, as it means old versions' READMEs can change or break at any time. E.g., renaming the plugin in the future would break all previous READMEs.

This will need to be added in a follow-up PR, using a hash instead of main.

stuartmorgan-g · 2025-04-01T15:08:45Z

packages/video_player/video_player/doc/demo_pip_iphone.gif

This file should be listed in a .pubignore.

stuartmorgan-g · 2025-04-01T15:18:20Z

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

+                ),
+              );
+            },
+            child: const Text('Set picture-in-picture overlay rect'),


Why is this something that clients have to call manually? Shouldn't the controller be determining this information from the widget as needed?

stuartmorgan-g · 2025-04-01T15:18:39Z

packages/video_player/video_player/lib/video_player.dart

+  }
+
+  /// Sets the location of the video player view in order to animate the picture-in-picture view.
+  Future<void> setPictureInPictureOverlaySettings({


Per my comment in the example code, it's not clear to me why this needs to be public API.

stuartmorgan-g · 2025-04-01T15:19:40Z

packages/video_player/video_player/lib/video_player.dart

+    );
+  }
+
+  /// Starts picture-in-picture mode.


The methods that require isPictureInPictureSupported to be true in order to call them should all be commented accordingly.

stuartmorgan-g · 2025-04-01T15:21:09Z

packages/video_player/video_player_avfoundation/darwin/RunnerTests/VideoPlayerTests.m

@@ -664,6 +664,30 @@ - (void)testSeekToleranceWhenSeekingToEnd {
  XCTAssertNil(error);
  XCTAssertEqual(avPlayer.volume, 0.1f);

+  // Set picture-in-picture


This still needs to be resolved.

stuartmorgan-g · 2025-04-01T15:21:35Z

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

@@ -31,6 +32,34 @@ - (void)testPlayVideo {
  XCTAssertTrue([playButton waitForExistenceWithTimeout:30.0]);
  [playButton tap];

+  if ([AVPictureInPictureController isPictureInPictureSupported]) {


This still needs to be resolved.

vanlooverenkoen added 5 commits March 20, 2023 19:47

#60048: Migration from flutter-plugins to flutter-packages

595d3df

Updated doc

4831f57

Merged current main into ios pip

976b630

#60048: Formatting

a7d5dd5

Fixed formatting

876dfe8

vanlooverenkoen requested review from hellohuanlin, camsim99 and tarrinneal as code owners March 20, 2023 20:52

github-actions bot added p: video_player platform-android platform-ios labels Mar 20, 2023

hellohuanlin approved these changes Mar 20, 2023

View reviewed changes

#60048: Updated the changelogs

a4ca9e7

camsim99 removed their request for review March 27, 2023 15:33

Merge branch 'main' into feature/#60048-ios-picture-in-picture

49f769a

tarrinneal requested changes Apr 14, 2023

View reviewed changes

vanlooverenkoen added 5 commits April 15, 2023 09:20

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

0764e27

Renamed setAutomaticallyStartPictureInPicture to setAutomaticallyStar…

65fdf65

…tsPictureInPicture

Updated starting to started to match stopped enum values

d4d9ff9

Removed some logic to pause

ff6d02f

vanlooverenkoen requested a review from tarrinneal April 17, 2023 16:17

tarrinneal requested a review from stuartmorgan-g April 17, 2023 18:44

reidbaker requested a review from camsim99 May 4, 2023 18:44

ErickCReis reviewed May 9, 2023

View reviewed changes

packages/video_player/video_player/lib/video_player.dart Show resolved Hide resolved

Nols1000 requested a review from matanlurey as a code owner January 3, 2025 11:22

github-actions bot removed the p: camera label Jan 3, 2025

[video_player] format code

bc56139

stuartmorgan-g requested changes Jan 3, 2025

View reviewed changes

Nols1000 added 4 commits January 3, 2025 13:16

[video_player_avfoundation] reorder imports

e1348c8

[video_player] update version

7e70da0

[video_player_android] Revert all changes made to this package

4abe6f1

[video_player] upgrade dependencies

2006494

github-actions bot removed the platform-android label Jan 3, 2025

Nols1000 added 2 commits January 3, 2025 15:15

[video_player] fix dependencies for example

58dabf4

[video_player_android] add overwrite to fix analysis error

881e80e

github-actions bot added the platform-android label Jan 3, 2025

Nols1000 added 7 commits January 5, 2025 00:47

[video_player_avfoundation] fix type issue with isPictureInPictureSup…

917bdd4

…ported

[video_player_avfoundation] refactore naming and setting the start of…

fba55da

… pip

[video_player] Update dependencies

b0f42d8

Merge remote-tracking branch 'origin/main' into feature/#60048-ios-pi…

e0231d8

…cture-in-picture

[video_player] Upgrade dart version

c58b722

[video_player] Update dependencies

376bcf5

[camera] Add video_player_platform_interface to overwrite

5dd6e13

github-actions bot added the p: camera label Jan 8, 2025

This comment was marked as off-topic.

Sign in to view

stuartmorgan-g requested changes Apr 1, 2025

View reviewed changes

matanlurey removed request for ErickCReis and matanlurey April 2, 2025 15:27

[video_player] #60048 ios picture in picture #3500

Are you sure you want to change the base?

[video_player] #60048 ios picture in picture #3500

Uh oh!

Conversation

vanlooverenkoen commented Mar 20, 2023 • edited by stuartmorgan-g Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

vanlooverenkoen commented Mar 20, 2023

Uh oh!

hellohuanlin left a comment

Choose a reason for hiding this comment

Uh oh!

vanlooverenkoen commented Apr 3, 2023

Uh oh!

tarrinneal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vanlooverenkoen commented Apr 17, 2023

Uh oh!

Uh oh!

tarrinneal commented May 10, 2023

Uh oh!

vanlooverenkoen commented May 10, 2023

Uh oh!

Nols1000 commented Jan 3, 2025

Uh oh!

stuartmorgan-g commented Jan 3, 2025

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as off-topic.

philipgiuliani commented Feb 20, 2025

Uh oh!

Nols1000 commented Feb 20, 2025

Uh oh!

philipgiuliani commented Feb 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

philipgiuliani commented Feb 20, 2025

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vanlooverenkoen commented Mar 20, 2023 •

edited by stuartmorgan-g

Loading

philipgiuliani commented Feb 20, 2025 •

edited

Loading