wakelock_plus 1.2.8

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

wakelock_plus

A continuation of the original wakelock Flutter Plugin written by creativecreatorormaybenot that allows you to keep the device screen awake, i.e. prevent the screen from sleeping.

You can enable and toggle the screen wakelock, which prevents the screen from turning off automatically.

---

Table of Contents

1. Supported Platforms
2. Usage
   1. Implementation
   2. Ensure the WidgetsBinding is initialized
   3. Calling WakelockPlus.enable() in main()
3. Platform Specific Integration Instructions
   1. Android
4. Learn More

---

Supported Platforms

Platform	wakelock_plus support
Android	✅
iOS	✅
Web	✅
macOS	✅
Windows	✅
Linux	✅

Usage

To use this plugin, follow the installation guide.

The wakelock_plus 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 WakelockPlus class.
If you want to enable the wakelock, i.e. keep the device awake, you can simply call WakelockPlus.enable and to disable it again, you can use WakelockPlus.disable:

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

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

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

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

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

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

enable = false;
// The following statement disables the wakelock.
WakelockPlus.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 WakelockPlus.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 WakelockPlus.enable, WakelockPlus.disable, and WakelockPlus.toggle.

Ensure the WidgetsBinding is initialized

If you want to call WakelockPlus.enable() or the other functions before runApp() (e.g. in main()), you will have to ensure that the WidgetsBinding is initialized first:

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  WakelockPlus.enable();

  runApp(..);
}

In general, it is advisable to make your wakelock dependent on certain components within your app instead, e.g. by only enabling it (continually) when a certain widget is visible. There is no negative impact in calling WakelockPlus.enable() more often.

Calling WakelockPlus.enable() in main()

As touched on in the previous paragraph, calling WakelockPlus.enable() in your main() function is not the best approach for a number of reasons.

The most important factors are:

1. Users expect their screen to automatically turn off unless e.g. a video is playing.
   It is unlikely that your whole app requires the screen to always stay on.
2. The wakelock can be released by external sources at any time (e.g. by the OS).
   Only calling WakelockPlus.enable() once will most likely mean that the screen turns off at one point or another anyway.

This is why you should instead prefer to enable the wakelock whenever components inside of your app that require the screen to stay on are active. This can e.g. happen in the build method of your widget.

Platform Specific Integration Instructions

Android

When building your app on Android and using this library, you may be prompted by the following:

One or more plugins require a higher Android NDK version.

If this occurs, simply add the NDK version specified in the error message in your app module's build.gradle file's android closure. For example:

android {
    // Current version at the time of this writing.
    // Use the version specified by the error message.
    ndkVersion "25.1.8937393" 
    //....
}

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.