Merge pull request #875 from Ortes/pause-on-tap

Add background tap to pause video feature

Author: diegotori

lib/src/chewie_player.dart

@@ -308,6 +308,7 @@ class ChewieController extends ChangeNotifier {
     this.progressIndicatorDelay,
     this.hideControlsTimer = defaultHideControlsTimer,
     this.controlsSafeAreaMinimum = EdgeInsets.zero,
+    this.pauseOnBackgroundTap = false,
   }) : assert(
           playbackSpeeds.every((speed) => speed > 0),
           'The playbackSpeeds values must all be greater than 0',
@@ -365,6 +366,7 @@ class ChewieController extends ChangeNotifier {
       Animation<double>,
       ChewieControllerProvider,
     )? routePageBuilder,
+    bool? pauseOnBackgroundTap,
   }) {
     return ChewieController(
       draggableProgressBar: draggableProgressBar ?? this.draggableProgressBar,
@@ -420,6 +422,7 @@ class ChewieController extends ChangeNotifier {
       hideControlsTimer: hideControlsTimer ?? this.hideControlsTimer,
       progressIndicatorDelay:
           progressIndicatorDelay ?? this.progressIndicatorDelay,
+      pauseOnBackgroundTap: pauseOnBackgroundTap ?? this.pauseOnBackgroundTap,
     );
   }
 
@@ -584,6 +587,9 @@ class ChewieController extends ChangeNotifier {
   /// Defaults to [EdgeInsets.zero].
   final EdgeInsets controlsSafeAreaMinimum;
 
+  /// Defines if the player should pause when the background is tapped
+  final bool pauseOnBackgroundTap;
+
   static ChewieController of(BuildContext context) {
     final chewieControllerProvider =
         context.dependOnInheritedWidgetOfExactType<ChewieControllerProvider>()!;

lib/src/cupertino/cupertino_controls.dart

@@ -354,7 +354,15 @@ class _CupertinoControlsState extends State<CupertinoControls>
 
     return GestureDetector(
       onTap: _latestValue.isPlaying
-          ? _cancelAndRestartTimer
+          ? _chewieController?.pauseOnBackgroundTap ?? false
+              ? () {
+                  _playPause();
+
+                  setState(() {
+                    notifier.hideStuff = true;
+                  });
+                }
+              : _cancelAndRestartTimer
           : () {
               _hideTimer?.cancel();
 

lib/src/material/material_controls.dart

@@ -380,12 +380,17 @@ class _MaterialControlsState extends State<MaterialControls>
     return GestureDetector(
       onTap: () {
         if (_latestValue.isPlaying) {
-          if (_displayTapped) {
-            setState(() {
-              notifier.hideStuff = true;
-            });
-          } else {
+          if (_chewieController?.pauseOnBackgroundTap ?? false) {
+            _playPause();
             _cancelAndRestartTimer();
+          } else {
+            if (_displayTapped) {
+              setState(() {
+                notifier.hideStuff = true;
+              });
+            } else {
+              _cancelAndRestartTimer();
+            }
           }
         } else {
           _playPause();

lib/src/material/material_desktop_controls.dart

@@ -106,7 +106,10 @@ class _MaterialDesktopControlsState extends State<MaterialDesktopControls>
           _cancelAndRestartTimer();
         },
         child: GestureDetector(
-          onTap: () => _cancelAndRestartTimer(),
+          onTap: () {
+            _playPause();
+            _cancelAndRestartTimer();
+          },
           child: AbsorbPointer(
             absorbing: notifier.hideStuff,
             child: Stack(
@@ -365,12 +368,17 @@ class _MaterialDesktopControlsState extends State<MaterialDesktopControls>
     return GestureDetector(
       onTap: () {
         if (_latestValue.isPlaying) {
-          if (_displayTapped) {
-            setState(() {
-              notifier.hideStuff = true;
-            });
-          } else {
+          if (_chewieController?.pauseOnBackgroundTap ?? false) {
+            _playPause();
             _cancelAndRestartTimer();
+          } else {
+            if (_displayTapped) {
+              setState(() {
+                notifier.hideStuff = true;
+              });
+            } else {
+              _cancelAndRestartTimer();
+            }
           }
         } else {
           _playPause();