wakelock 0.5.2
wakelock: ^0.5.2 copied to clipboard

Plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping on Android, iOS, macOS, Windows, and web.

wakelock Pub version GitHub stars Twitter Follow #

Plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping


The plugin allows you to enable and toggle the screen wakelock, which prevents the screen from turning off automatically.
Essentially, this allows you to keep the device awake, i.e. prevent the device from sleeping.

Supported platforms #

Platformwakelock support
Android
iOS
Web
macOS
Windows
Linuxplanned

Usage #

To use this plugin, follow the installing guide.

The wakelock plugin does not require any special permissions on any platform :)
This is because it only enables the screen wakelock and not any partial (CPU) wakelocks that would keep the app alive in the background.

Implementation #

Everything in this plugin is controlled via the Wakelock class.
If you want to enable the wakelock, i.e. keep the device awake, you can simply call Wakelock.enable and to disable it again, you can use Wakelock.disable:

import 'package:wakelock/wakelock.dart';
// ...

// The following line will enable the Android and iOS wakelock.
Wakelock.enable();

// The next line disables the wakelock again.
Wakelock.disable();

For more advanced usage, you can pass a bool to Wakelock.toggle to enable or disable the wakelock and also retrieve the current wakelock status using Wakelock.isEnabled:

import 'package:wakelock/wakelock.dart';
// ...

// The following lines of code toggle the wakelock based on a bool value.
bool enable = true;
// The following statement enables the wakelock.
Wakelock.toggle(enable: enable);

enable = false;
// The following statement disables the wakelock.
Wakelock.toggle(enable: enable);

// If you want to retrieve the current wakelock status,
// you will have to be in an async scope
// to await the Future returned by `enabled`.
bool wakelockEnabled = await Wakelock.enabled;

If you want to wait for the wakelock toggle to complete (which takes an insignificant amount of time), you can also await any of Wakelock.enable, Wakelock.disable, and Wakelock.toggle.

Learn more #

If you want to learn more about how this plugin works, how to contribute, etc., you can read through the main README on GitHub.

558
likes
130
pub points
99%
popularity

Publisher

creativemaybeno.dev

Plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping on Android, iOS, macOS, Windows, and web.

Homepage
Repository (GitHub)
View/report issues

Documentation

API reference

License

BSD (LICENSE)

Dependencies

flutter, meta, wakelock_macos, wakelock_platform_interface, wakelock_web, wakelock_windows

More

Packages that depend on wakelock