Skip to content

Add documentation about pauseOnBackgroundTap feature #911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation about pauseOnBackgroundTap feature #911

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,21 @@ optionsBuilder: (context, defaultOptions) async {

Your `additionalOptions` are already included here (if you provided `additionalOptions`)!

### `pauseOnBackgroundTap` (Tap Anywhere to Pause/Play)

The `pauseOnBackgroundTap` feature allows the video to be paused or played by tapping anywhere on the video player area.
This eliminates the need for users to tap the play/pause icon in the center of the video.

This feature can be enabled by setting the `pauseOnBackgroundTap` property in the ChewieController.
When enabled, tapping anywhere on the video will toggle between play and pause states.

```dart
final chewieController = ChewieController(
videoPlayerController: videoPlayerController,
pauseOnBackgroundTap: true, // Allow tapping anywhere on the video to pause/play
);
```

### Translations

What is an option without proper translation?
Expand Down