WakeLockManager

Kotlin |Java

@UnstableApi
class WakeLockManager

Utility class to handle a WakeLock.

The handling of wake locks requires the WAKE_LOCK permission.

The class must be used from a single thread. This can be the main thread as all blocking operations are internally handled on the background Looper thread provided in the constructor.

Summary

Public constructors
`WakeLockManager(context: Context!, wakeLockLooper: Looper!, clock: Clock!)` Creates the wake lock manager.

Public functions
`Unit`	`setEnabled(enabled: Boolean)` Sets whether to enable the acquiring and releasing of the `WakeLock`.
`Unit`	`setStayAwake(stayAwake: Boolean)` Sets whether to acquire or release the `WakeLock`.

Public constructors

WakeLockManager

WakeLockManager(context: Context!, wakeLockLooper: Looper!, clock: Clock!)

Creates the wake lock manager.

Parameters
`context: Context!`	A `Context`
`wakeLockLooper: Looper!`	A background `Looper` to call wake lock system calls on.
`clock: Clock!`	The `Clock` to schedule handler messages.

Public functions

setEnabled

fun setEnabled(enabled: Boolean): Unit

Sets whether to enable the acquiring and releasing of the WakeLock.

By default, wake lock handling is not enabled. Enabling this will acquire the wake lock if necessary. Disabling this will release the wake lock if it is held.

Enabling WakeLock requires the WAKE_LOCK.

Parameters
`enabled: Boolean`	True if the player should handle a `WakeLock`, false otherwise.

setStayAwake

fun setStayAwake(stayAwake: Boolean): Unit

Sets whether to acquire or release the WakeLock.

Please note this method requires wake lock handling to be enabled through setEnabled(boolean enable) to actually have an impact on the WakeLock.

Parameters
`stayAwake: Boolean`	True if the player should acquire the `WakeLock`. False if the player should release.