[video_player] Implement screen auto-lock control for video playback

packages/video_player/video_player/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 2.11.1
 
+* Implement screen auto-lock control for video playback.
 * Optimizes caption retrieval with binary search.
 
 ## 2.11.0

packages/video_player/video_player/example/pubspec.yaml

@@ -35,3 +35,8 @@ flutter:
     - assets/bumble_bee_captions.srt
     - assets/bumble_bee_captions.vtt
     - assets/Audio.mp3
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_avfoundation: {path: ../../../../packages/video_player/video_player_avfoundation}
+  video_player_platform_interface: {path: ../../../../packages/video_player/video_player_platform_interface}

packages/video_player/video_player/lib/video_player.dart

@@ -587,8 +587,15 @@ class VideoPlayerController extends ValueNotifier<VideoPlayerValue> {
     _playerId =
         (await _videoPlayerPlatform.createWithOptions(creationOptions)) ??
         kUninitializedPlayerId;
-    _creatingCompleter!.complete(null);
-    final initializingCompleter = Completer<void>();
+    if (videoPlayerOptions != null) {
+      await _videoPlayerPlatform.setAllowScreenAutoLock(
+        _playerId,
+        videoPlayerOptions.allowScreenAutoLock,
+      );
+    }
+        videoPlayerOptions!.allowScreenAutoLock,
+      );
+    }
 
     // Apply the web-specific options
     if (kIsWeb && videoPlayerOptions?.webOptions != null) {

packages/video_player/video_player/pubspec.yaml

@@ -39,3 +39,10 @@ dev_dependencies:
 topics:
   - video
   - video-player
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_avfoundation: {path: ../../../packages/video_player/video_player_avfoundation}
+  video_player_platform_interface: {path: ../../../packages/video_player/video_player_platform_interface}
+

packages/video_player/video_player/test/video_player_test.dart

@@ -1954,6 +1954,21 @@ void main() {
         expect(controller.videoPlayerOptions!.mixWithOthers, true);
       });
 
+      test('setAllowScreenAutoLock', () async {
+        final controller = VideoPlayerController.networkUrl(
+          _localhostUri,
+          videoPlayerOptions: VideoPlayerOptions(allowScreenAutoLock: true),
+        );
+        addTearDown(controller.dispose);
+
+        await controller.initialize();
+        expect(controller.videoPlayerOptions!.allowScreenAutoLock, true);
+        expect(
+          fakeVideoPlayerPlatform.calls.contains('setAllowScreenAutoLock'),
+          true,
+        );
+      });
+
       test('true allowBackgroundPlayback continues playback', () async {
         final controller = VideoPlayerController.networkUrl(
           _localhostUri,
@@ -2227,6 +2242,14 @@ class FakeVideoPlayerPlatform extends VideoPlayerPlatform {
     calls.add('setMixWithOthers');
   }
 
+  @override
+  Future<void> setAllowScreenAutoLock(
+    int playerId,
+    bool allowScreenAutoLock,
+  ) async {
+    calls.add('setAllowScreenAutoLock');
+  }
+
   @override
   Widget buildView(int playerId) {
     return Texture(textureId: playerId);

packages/video_player/video_player_android/example/pubspec.yaml

@@ -34,3 +34,7 @@ flutter:
   assets:
     - assets/flutter-mark-square-64.png
     - assets/Butterfly-209.mp4
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_platform_interface: {path: ../../../../packages/video_player/video_player_platform_interface}

packages/video_player/video_player_android/pubspec.yaml

@@ -32,3 +32,7 @@ dev_dependencies:
 topics:
   - video
   - video-player
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_platform_interface: {path: ../../../packages/video_player/video_player_platform_interface}

packages/video_player/video_player_avfoundation/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.9.5
+
+* Implement screen auto-lock control for video playback.
+
 ## 2.9.4
 
 * Ensures that the display link does not continue requesting frames after a player is disposed.

packages/video_player/video_player_avfoundation/darwin/video_player_avfoundation/Sources/video_player_avfoundation/FVPVideoPlayer.m

@@ -508,6 +508,12 @@ - (void)selectAudioTrackAtIndex:(NSInteger)trackIndex
   }
 }
 
+- (void)setAllowScreenAutoLock:(BOOL)allowScreenAutoLock error:(FlutterError *_Nullable *_Nonnull)error {
+  if (@available(iOS 12.0, macOS 10.14, *)) {
+    self.player.preventsDisplaySleepDuringVideoPlayback = !allowScreenAutoLock;
+  }
+}
+
 #pragma mark - Private
 
 - (int64_t)duration {

packages/video_player/video_player_avfoundation/darwin/video_player_avfoundation/Sources/video_player_avfoundation/include/video_player_avfoundation/messages.g.h

@@ -100,6 +100,7 @@ extern void SetUpFVPAVFoundationVideoPlayerApiWithSuffix(
     (FlutterError *_Nullable *_Nonnull)error;
 - (void)selectAudioTrackAtIndex:(NSInteger)trackIndex
                           error:(FlutterError *_Nullable *_Nonnull)error;
+- (void)setAllowScreenAutoLock:(BOOL)allowScreenAutoLock error:(FlutterError *_Nullable *_Nonnull)error;
 @end
 
 extern void SetUpFVPVideoPlayerInstanceApi(id<FlutterBinaryMessenger> binaryMessenger,

packages/video_player/video_player_avfoundation/darwin/video_player_avfoundation/Sources/video_player_avfoundation/messages.g.m

@@ -591,4 +591,28 @@ void SetUpFVPVideoPlayerInstanceApiWithSuffix(id<FlutterBinaryMessenger> binaryM
       [channel setMessageHandler:nil];
     }
   }
+  {
+    FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc]
+           initWithName:[NSString stringWithFormat:@"%@%@",
+                                                   @"dev.flutter.pigeon.video_player_avfoundation."
+                                                   @"VideoPlayerInstanceApi.setAllowScreenAutoLock",
+                                                   messageChannelSuffix]
+        binaryMessenger:binaryMessenger
+                  codec:FVPGetMessagesCodec()];
+    if (api) {
+      NSCAssert([api respondsToSelector:@selector(setAllowScreenAutoLock:error:)],
+                @"FVPVideoPlayerInstanceApi api (%@) doesn't respond to "
+                @"@selector(setAllowScreenAutoLock:error:)",
+                api);
+      [channel setMessageHandler:^(id _Nullable message, FlutterReply callback) {
+        NSArray<id> *args = message;
+        BOOL arg_allowScreenAutoLock = [GetNullableObjectAtIndex(args, 0) boolValue];
+        FlutterError *error;
+        [api setAllowScreenAutoLock:arg_allowScreenAutoLock error:&error];
+        callback(wrapResult(nil, error));
+      }];
+    } else {
+      [channel setMessageHandler:nil];
+    }
+  }
 }

packages/video_player/video_player_avfoundation/example/pubspec.yaml

@@ -31,3 +31,7 @@ flutter:
   assets:
     - assets/flutter-mark-square-64.png
     - assets/Butterfly-209.mp4
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_platform_interface: {path: ../../../../packages/video_player/video_player_platform_interface}

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

@@ -178,6 +178,13 @@ class AVFoundationVideoPlayer extends VideoPlayerPlatform {
     return _api.setMixWithOthers(mixWithOthers);
   }
 
+  @override
+  Future<void> setAllowScreenAutoLock(int playerId, bool allowScreenAutoLock) {
+    return _playerWith(
+      id: playerId,
+    ).setAllowScreenAutoLock(allowScreenAutoLock);
+  }
+
   @override
   Future<List<VideoAudioTrack>> getAudioTracks(int playerId) async {
     final List<MediaSelectionAudioTrackData> nativeData = await _playerWith(
@@ -275,6 +282,9 @@ class _PlayerInstance {
 
   Future<void> setPlaybackSpeed(double speed) => _api.setPlaybackSpeed(speed);
 
+  Future<void> setAllowScreenAutoLock(bool allowScreenAutoLock) =>
+      _api.setAllowScreenAutoLock(allowScreenAutoLock);
+
   Future<void> seekTo(Duration position) {
     return _api.seekTo(position.inMilliseconds);
   }

packages/video_player/video_player_avfoundation/lib/src/messages.g.dart

@@ -678,4 +678,29 @@ class VideoPlayerInstanceApi {
       return;
     }
   }
+
+  Future<void> setAllowScreenAutoLock(bool allowScreenAutoLock) async {
+    final pigeonVar_channelName =
+        'dev.flutter.pigeon.video_player_avfoundation.VideoPlayerInstanceApi.setAllowScreenAutoLock$pigeonVar_messageChannelSuffix';
+    final pigeonVar_channel = BasicMessageChannel<Object?>(
+      pigeonVar_channelName,
+      pigeonChannelCodec,
+      binaryMessenger: pigeonVar_binaryMessenger,
+    );
+    final Future<Object?> pigeonVar_sendFuture = pigeonVar_channel.send(
+      <Object?>[allowScreenAutoLock],
+    );
+    final pigeonVar_replyList = await pigeonVar_sendFuture as List<Object?>?;
+    if (pigeonVar_replyList == null) {
+      throw _createConnectionError(pigeonVar_channelName);
+    } else if (pigeonVar_replyList.length > 1) {
+      throw PlatformException(
+        code: pigeonVar_replyList[0]! as String,
+        message: pigeonVar_replyList[1] as String?,
+        details: pigeonVar_replyList[2],
+      );
+    } else {
+      return;
+    }
+  }
 }

packages/video_player/video_player_avfoundation/pigeons/messages.dart

@@ -93,4 +93,6 @@ abstract class VideoPlayerInstanceApi {
   List<MediaSelectionAudioTrackData> getAudioTracks();
   @ObjCSelector('selectAudioTrackAtIndex:')
   void selectAudioTrack(int trackIndex);
+  @ObjCSelector('setAllowScreenAutoLock:')
+  void setAllowScreenAutoLock(bool allowScreenAutoLock);
 }

packages/video_player/video_player_avfoundation/pubspec.yaml

@@ -2,7 +2,7 @@ name: video_player_avfoundation
 description: iOS and macOS implementation of the video_player plugin.
 repository: https://github.com/flutter/packages/tree/main/packages/video_player/video_player_avfoundation
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+video_player%22
-version: 2.9.4
+version: 2.9.5
 
 environment:
   sdk: ^3.10.0
@@ -36,3 +36,9 @@ dev_dependencies:
 topics:
   - video
   - video-player
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_platform_interface: {path: ../../../packages/video_player/video_player_platform_interface}
+

packages/video_player/video_player_platform_interface/CHANGELOG.md

@@ -1,5 +1,6 @@
-## NEXT
+## 6.6.1
 
+* Implement screen auto-lock control for video playback.
 * Updates minimum supported SDK version to Flutter 3.35/Dart 3.9.
 
 ## 6.6.0

packages/video_player/video_player_platform_interface/lib/video_player_platform_interface.dart

@@ -124,6 +124,13 @@ abstract class VideoPlayerPlatform extends PlatformInterface {
     );
   }
 
+  /// Sets whether the screen should be allowed to auto-lock during playback.
+  Future<void> setAllowScreenAutoLock(int playerId, bool allowScreenAutoLock) {
+    throw UnimplementedError(
+      'setAllowScreenAutoLock() has not been implemented.',
+    );
+  }
+
   /// Sets additional options on web.
   Future<void> setWebOptions(int playerId, VideoPlayerWebOptions options) {
     throw UnimplementedError('setWebOptions() has not been implemented.');
@@ -435,6 +442,7 @@ class VideoPlayerOptions {
   VideoPlayerOptions({
     this.mixWithOthers = false,
     this.allowBackgroundPlayback = false,
+    this.allowScreenAutoLock = false,
     this.webOptions,
   });
 
@@ -449,6 +457,12 @@ class VideoPlayerOptions {
   /// currently no way to implement this feature in this platform).
   final bool mixWithOthers;
 
+  /// Set this to true to allow the screen to auto-lock during video playback.
+  /// The default value is false, meaning the screen will stay awake during playback.
+  ///
+  /// This option is currently only supported on iOS and macOS.
+  final bool allowScreenAutoLock;
+
   /// Additional web controls
   final VideoPlayerWebOptions? webOptions;
 }

packages/video_player/video_player_platform_interface/pubspec.yaml

@@ -4,7 +4,7 @@ repository: https://github.com/flutter/packages/tree/main/packages/video_player/
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+video_player%22
 # 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
 
 environment:
   sdk: ^3.9.0

packages/video_player/video_player_platform_interface/test/video_player_options_test.dart

@@ -14,4 +14,8 @@ void main() {
     final options = VideoPlayerOptions();
     expect(options.mixWithOthers, false);
   });
+  test('VideoPlayerOptions allowScreenAutoLock defaults to false', () {
+    final options = VideoPlayerOptions();
+    expect(options.allowScreenAutoLock, false);
+  });
 }

packages/video_player/video_player_web/example/pubspec.yaml

@@ -18,3 +18,7 @@ dev_dependencies:
     sdk: flutter
   integration_test:
     sdk: flutter
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_platform_interface: {path: ../../../../packages/video_player/video_player_platform_interface}

packages/video_player/video_player_web/pubspec.yaml

@@ -31,3 +31,7 @@ dev_dependencies:
 topics:
   - video
   - video-player
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  video_player_platform_interface: {path: ../../../packages/video_player/video_player_platform_interface}