[video_player] Implement screen auto-lock control for video playback by shrabanti722 · Pull Request #11225 · flutter/packages

shrabanti722 · 2026-03-11T10:22:43Z

Description

Adds support for screen auto-lock during video playback on iOS.

By default, the video player keeps the screen awake during playback. Some apps (e.g. login screens with background videos, ambient content) want the screen to be able to auto-lock while video plays. This PR adds an option to allow that behavior.

Changes

Add preventsDisplaySleepDuringVideoPlayback to VideoPlayerOptions (default: true to preserve existing behavior)
When false, the screen can auto-lock during playback
Implemented on iOS/macOS via AVPlayer.preventsDisplaySleepDuringVideoPlayback
Platform interface: setPreventsDisplaySleepDuringVideoPlayback(int playerId, bool preventsDisplaySleepDuringVideoPlayback)

Usage

VideoPlayerController.networkUrl(
  url,
  videoPlayerOptions: VideoPlayerOptions(preventsDisplaySleepDuringVideoPlayback: false),
);

Breakout PRs

Platform interface: [video_player_platform_interface] Add preventsDisplaySleepDuringVideoPlayback option #11546
AVFoundation (iOS/macOS): [video_player_avfoundation] Implement preventsDisplaySleepDuringVideoPlayback #11547 (draft)

Issues fixed

Fixes: flutter/flutter#183520 (How to disable wakelock on iOS side?)
Addresses the need to allow screen auto-lock during video playback on iOS (e.g. for ambient/background videos)

Pre-Review Checklist

- Added `setAllowScreenAutoLock` method to the video player platform interface and its implementations for iOS. - Updated `VideoPlayerOptions` to include `allowScreenAutoLock` property. - Modified the `AVFoundationVideoPlayer` class to handle screen auto-lock settings during playback. - Added tests to verify the functionality of screen auto-lock settings. This feature allows users to control whether the screen should stay awake during video playback on iOS devices.

- Removed redundant player ID assignment and completer initialization from the `VideoPlayerController` class. - Enhanced code clarity by consolidating player setup logic. - This change improves maintainability and readability of the video player implementation.

Made-with: Cursor

…ontrol for video playback in the video player packages.

google-cla · 2026-03-11T10:22:54Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Made-with: Cursor

gemini-code-assist

Code Review

This pull request introduces a new feature to control screen auto-locking during video playback by adding an allowScreenAutoLock option. The changes are implemented across the platform interface, the main video_player package, and the video_player_avfoundation implementation for iOS and macOS. My review has identified a few areas for improvement: a potential bug in the macOS implementation's availability check, a style guide violation regarding dependency_overrides in pubspec.yaml files, and opportunities for enhancing code clarity and documentation.

LouiseHsu

looks like you have some compilation errors.

https://logs.chromium.org/logs/flutter/buildbucket/cr-buildbucket/8687630786392823857/+/u/Run_package_tests/drive_examples/stdout

../lib/video_player.dart:594:34: Error: The method 'setAllowScreenAutoLock' isn't defined for the type 'VideoPlayerPlatform'.
 - 'VideoPlayerPlatform' is from 'package:video_player_platform_interface/video_player_platform_interface.dart' ('../../../../../.pub-cache/hosted/pub.dev/video_player_platform_interface-6.6.0/lib/video_player_platform_interface.dart').
Try correcting the name to the name of an existing method, or defining a method named 'setAllowScreenAutoLock'.
      await _videoPlayerPlatform.setAllowScreenAutoLock(

JetA2 · 2026-03-12T13:25:27Z

Thanks for the PR, I was just looking at this issue.
For my use case, it would be preferable to have this feature on the VideoPlayerControllerinstead of VideoPlayerOptions, otherwise you have to create a new controller if you want to change the value of the setting.

In my use case I have a video playing in a list without sound ("background mode" that should allow the device to auto-lock), but when it's tapped will go to full screen with sound ("foreground mode" that should keep the device awake).

If I were to recreate the controller when moving to fullscreen, the playback would be interrupted.

…ckages to use relative paths for local dependencies. This change is for testing and initial review only; do not merge.

…layer_avfoundation/Sources/video_player_avfoundation/FVPVideoPlayer.m Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

…o_player_platform_interface.dart Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

hellohuanlin · 2026-03-19T17:49:43Z

@@ -1,3 +1,7 @@
+## 2.9.5
+
+* Implement screen auto-lock control for video playback.


Implements

… screen sleep during video playback.

…essages for improved readability.

hellohuanlin

iOS part LGTM

nateshmbhat · 2026-03-27T07:29:19Z

Thanks @shrabanti722 for this feature. we also need this option in our app badly : )

LouiseHsu · 2026-03-31T17:58:27Z

https://ci.chromium.org/ui/p/flutter/builders/try/Linux%20repo_checks/22937/overview

Can you make sure your changelog + pubspec is up to date? also make sure to run dart format!

https://ci.chromium.org/ui/p/flutter/builders/try/Mac_arm64%20ios_platform_tests_shard_1%20master/27862/overview

00:27 +10 ~1: /Volumes/Work/s/w/ir/x/w/packages/packages/video_player/video_player/example/integration_test/video_player_test.dart: network videos reports buffering status
══╡ EXCEPTION CAUGHT BY FLUTTER TEST FRAMEWORK ╞════════════════════════════════════════════════════
The following PlatformException was thrown running a test:
PlatformException(VideoError, Failed to load video: unknown error: The operation couldn’t be
completed. (CoreMediaErrorDomain error -16845 - HTTP 429: (unhandled)), null, null)

tarrinneal

A couple changelog adjustments and doc comment changes, This should be good to break out into child pr's.

tarrinneal · 2026-04-03T17:45:20Z

@@ -1,5 +1,6 @@
 ## 2.11.1


This will need to be a new entry in the changelog along with a version bump to 2.12.0

tarrinneal · 2026-04-03T17:50:25Z

@@ -1,5 +1,6 @@
-## NEXT
+## 6.6.1


tarrinneal · 2026-04-03T17:50:33Z

 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 6.6.0
+version: 6.6.1


tarrinneal · 2026-04-03T17:58:45Z

  /// currently no way to implement this feature in this platform).
  final bool mixWithOthers;

+  /// Set this to true to prevent the screen from sleeping during video playback.


Here and everywhere else this comment is located:

"Whether the screen is prevented from from sleeping during video playback."

https://dart.dev/effective-dart/documentation#prefer-starting-a-boolean-variable-or-property-comment-with-whether-followed-by-a-noun-or-gerund-phrase

tarrinneal · 2026-04-03T17:59:19Z

  final bool mixWithOthers;

+  /// Set this to true to prevent the screen from sleeping during video playback.
+  /// The default value is true.


There should be an empty line between this and the line above it. (for all versions of this comment

tarrinneal · 2026-04-03T18:02:07Z

@@ -1,3 +1,7 @@
+## 2.9.5


tarrinneal · 2026-04-06T21:58:00Z

    # the parent directory to use the current plugin's version.
    path: ../
-  video_player_platform_interface: ^6.6.0
+  video_player_platform_interface: ^6.7.0


revert this

tarrinneal · 2026-04-06T21:58:10Z

  flutter:
    sdk: flutter
-  video_player_platform_interface: ^6.6.0
+  video_player_platform_interface: ^6.7.0


tarrinneal · 2026-04-06T21:58:19Z

    # the parent directory to use the current plugin's version.
    path: ../
-  video_player_platform_interface: ^6.6.0
+  video_player_platform_interface: ^6.7.0


tarrinneal · 2026-04-06T21:58:44Z

  flutter:
    sdk: flutter
-  video_player_platform_interface: ^6.3.0
+  video_player_platform_interface: ^6.7.0


tarrinneal · 2026-04-06T21:58:51Z

  flutter_web_plugins:
    sdk: flutter
-  video_player_platform_interface: ^6.4.0
+  video_player_platform_interface: ^6.7.0


…across multiple packages

…multiple packages

shrabanti722 · 2026-04-16T08:16:49Z

The tests are failing due to version issues. How to proceed forward ? Should I create a child PR with the version updates ? @LouiseHsu @tarrinneal

…Playback option Adds the `preventsDisplaySleepDuringVideoPlayback` field to `VideoPlayerOptions` and a `setPreventsDisplaySleepDuringVideoPlayback` method to `VideoPlayerPlatform`, allowing platform implementations to control whether the display sleeps during video playback. Platform interface breakout PR for flutter#11225. Made-with: Cursor

…Playback Implements the platform interface method `setPreventsDisplaySleepDuringVideoPlayback` using `AVPlayer.preventsDisplaySleepDuringVideoPlayback` on iOS and macOS. AVFoundation implementation breakout PR for flutter#11225. Depends on the platform interface breakout PR (6.7.0). Made-with: Cursor

shrabanti722 · 2026-04-21T12:13:49Z

Hi @tarrinneal @LouiseHsu — I've split this into child PRs:

Platform interface: [video_player_platform_interface] Add preventsDisplaySleepDuringVideoPlayback option #11546 (ready for review)
AVFoundation: [video_player_avfoundation] Implement preventsDisplaySleepDuringVideoPlayback #11547 (draft — will mark ready once [video_player_platform_interface] Add preventsDisplaySleepDuringVideoPlayback option #11546 lands and 6.7.0 publishes on pub.dev)

stuartmorgan-g · 2026-05-19T18:35:21Z

From triage: This is waiting on the platform interface PR to land, but it's currently failing CLA.

shrabanti722 · 2026-05-22T09:13:32Z

@stuartmorgan-g it's resolved, thanks.

shrabanti722 added 4 commits March 9, 2026 14:54

PR prep: format, fix pubspec sort, update changelog and versions

3c60307

Made-with: Cursor

Update changelogs to reflect the implementation of screen auto-lock c…

46ea3e9

…ontrol for video playback in the video player packages.

shrabanti722 requested review from LouiseHsu, hellohuanlin and tarrinneal as code owners March 11, 2026 10:22

github-actions Bot added platform-ios platform-macos p: video_player labels Mar 11, 2026

shrabanti722 added 2 commits March 11, 2026 15:55

Merge upstream/main into video-player-screen-auto-lock

74b02a4

Made-with: Cursor

Add allowScreenAutoLock default value test

dffa3a4

shrabanti722 changed the title ~~Video player screen auto lock~~ [video_player] Implement screen auto-lock control for video playback Mar 11, 2026

gemini-code-assist Bot reviewed Mar 11, 2026

View reviewed changes

LouiseHsu requested changes Mar 11, 2026

View reviewed changes

Update dependency overrides in pubspec.yaml files for video_player pa…

742e1b5

…ckages to use relative paths for local dependencies. This change is for testing and initial review only; do not merge.

shrabanti722 requested review from mboetger and mdebbar as code owners March 12, 2026 16:32

github-actions Bot added platform-android platform-web labels Mar 12, 2026

shrabanti722 requested a review from LouiseHsu March 14, 2026 11:42

shrabanti722 and others added 3 commits March 14, 2026 17:12

Update packages/video_player/video_player_avfoundation/darwin/video_p…

263bdc5

…layer_avfoundation/Sources/video_player_avfoundation/FVPVideoPlayer.m Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update packages/video_player/video_player/lib/video_player.dart

04f9b57

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update packages/video_player/video_player_platform_interface/lib/vide…

15d7d64

…o_player_platform_interface.dart Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

LouiseHsu added the CICD Run CI/CD label Mar 16, 2026

mdebbar removed their request for review March 18, 2026 16:05

mdebbar removed the platform-web label Mar 18, 2026

hellohuanlin reviewed Mar 19, 2026

View reviewed changes

shrabanti722 requested review from LouiseHsu and hellohuanlin March 20, 2026 12:44

shrabanti722 added 2 commits March 21, 2026 13:31

feat: Add preventsDisplaySleepDuringVideoPlayback option to control…

da08c54

… screen sleep during video playback.

style: reformat AVFoundation video player code and generated Pigeon m…

6353082

…essages for improved readability.

hellohuanlin approved these changes Mar 26, 2026

View reviewed changes

LouiseHsu added CICD Run CI/CD and removed CICD Run CI/CD labels Mar 31, 2026

tarrinneal reviewed Apr 3, 2026

View reviewed changes

updating versions

1e1f173

github-actions Bot removed the CICD Run CI/CD label Apr 4, 2026

shrabanti722 requested a review from tarrinneal April 4, 2026 07:55

tarrinneal requested changes Apr 6, 2026

View reviewed changes

chore: downgrade video_player_platform_interface dependency versions …

5a42c83

…across multiple packages

shrabanti722 requested a review from tarrinneal April 7, 2026 07:42

LouiseHsu added the CICD Run CI/CD label Apr 7, 2026

chore: downgrade video_player_platform_interface version to 6.6.0 in …

0bd9c68

…multiple packages

github-actions Bot removed the CICD Run CI/CD label Apr 8, 2026

LouiseHsu added the CICD Run CI/CD label Apr 15, 2026

This was referenced Apr 21, 2026

[video_player_platform_interface] Add preventsDisplaySleepDuringVideoPlayback option #11546

Open

[video_player_avfoundation] Implement preventsDisplaySleepDuringVideoPlayback #11547

Draft

stuartmorgan-g added the federated: all_changes PR that contains changes for all packages for a federated plugin change label May 4, 2026

		@@ -1,3 +1,7 @@
		## 2.9.5

		* Implement screen auto-lock control for video playback.

Conversation

shrabanti722 commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Usage

Breakout PRs

Issues fixed

Pre-Review Checklist

Uh oh!

google-cla Bot commented Mar 11, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LouiseHsu left a comment

Choose a reason for hiding this comment

Uh oh!

JetA2 commented Mar 12, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hellohuanlin left a comment

Choose a reason for hiding this comment

Uh oh!

nateshmbhat commented Mar 27, 2026

Uh oh!

LouiseHsu commented Mar 31, 2026

Uh oh!

tarrinneal 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shrabanti722 commented Apr 16, 2026

Uh oh!

shrabanti722 commented Apr 21, 2026

Uh oh!

stuartmorgan-g commented May 19, 2026

Uh oh!

shrabanti722 commented May 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

shrabanti722 commented Mar 11, 2026 •

edited

Loading