Android Guides | Samples

Android.OS.WakeLockFlags Enumeration

Enumerates values returned by several methods of WakeLockFlags and taken as a parameter of the MediaPlayer.SetWakeMode, PowerManager+WakeLock.Release, and PowerManager.NewWakeLock members.

Syntax

[System.Flags]
public enum WakeLockFlags

Remarks

Members

Member NameDescription
AcquireCausesWakeup

Wake lock flag: Turn the screen on when the wake lock is acquired.

Normally wake locks don't actually wake the device, they just cause the screen to remain on once it's already on. Think of the video player application as the normal behavior. Notifications that pop up and want the device to be on are the exception; use this flag to be like them.

Cannot be used with WakeLockFlags.Partial.

Full

Wake lock level: Ensures that the screen and keyboard backlight are on at full brightness.

If the user presses the power button, then the WakeLockFlags.Full will be implicitly released by the system, causing both the screen and the CPU to be turned off. Contrast with WakeLockFlags.Partial.

OnAfterRelease

Wake lock flag: When this wake lock is released, poke the user activity timer so the screen stays on for a little longer.

Will not turn the screen on if it is not already on. See WakeLockFlags.AcquireCausesWakeup if you want that.

Cannot be used with WakeLockFlags.Partial.

Partial

Wake lock level: Ensures that the CPU is running; the screen and keyboard backlight will be allowed to go off.

If the user presses the power button, then the screen will be turned off but the CPU will be kept on until all partial wake locks have been released.

ProximityScreenOff
ReleaseFlagWaitForNoProximity
ScreenBright

Wake lock level: Ensures that the screen is on at full brightness; the keyboard backlight will be allowed to go off.

If the user presses the power button, then the WakeLockFlags.ScreenBright will be implicitly released by the system, causing both the screen and the CPU to be turned off. Contrast with WakeLockFlags.Partial.

ScreenDim

Wake lock level: Ensures that the screen is on (but may be dimmed); the keyboard backlight will be allowed to go off.

If the user presses the power button, then the WakeLockFlags.ScreenDim will be implicitly released by the system, causing both the screen and the CPU to be turned off. Contrast with WakeLockFlags.Partial.

Requirements

Namespace: Android.OS
Assembly: Mono.Android (in Mono.Android.dll)
Assembly Versions: 0.0.0.0

The members of Android.OS.WakeLockFlags are listed below.

See Also: Enum

Public Fields

AcquireCausesWakeupWakeLockFlags.

Wake lock flag: Turn the screen on when the wake lock is acquired.

Normally wake locks don't actually wake the device, they just cause the screen to remain on once it's already on. Think of the video player application as the normal behavior. Notifications that pop up and want the device to be on are the exception; use this flag to be like them.

Cannot be used with WakeLockFlags.Partial.

FullWakeLockFlags.

Wake lock level: Ensures that the screen and keyboard backlight are on at full brightness.

If the user presses the power button, then the WakeLockFlags.Full will be implicitly released by the system, causing both the screen and the CPU to be turned off. Contrast with WakeLockFlags.Partial.

OnAfterReleaseWakeLockFlags.

Wake lock flag: When this wake lock is released, poke the user activity timer so the screen stays on for a little longer.

Will not turn the screen on if it is not already on. See WakeLockFlags.AcquireCausesWakeup if you want that.

Cannot be used with WakeLockFlags.Partial.

PartialWakeLockFlags.

Wake lock level: Ensures that the CPU is running; the screen and keyboard backlight will be allowed to go off.

If the user presses the power button, then the screen will be turned off but the CPU will be kept on until all partial wake locks have been released.

ProximityScreenOffWakeLockFlags.
ReleaseFlagWaitForNoProximityWakeLockFlags.
ScreenBrightWakeLockFlags.

Wake lock level: Ensures that the screen is on at full brightness; the keyboard backlight will be allowed to go off.

If the user presses the power button, then the WakeLockFlags.ScreenBright will be implicitly released by the system, causing both the screen and the CPU to be turned off. Contrast with WakeLockFlags.Partial.

ScreenDimWakeLockFlags.

Wake lock level: Ensures that the screen is on (but may be dimmed); the keyboard backlight will be allowed to go off.

If the user presses the power button, then the WakeLockFlags.ScreenDim will be implicitly released by the system, causing both the screen and the CPU to be turned off. Contrast with WakeLockFlags.Partial.