The Power API provides functions to control the power service.
Required Header
#include <device/power.h>
Overview
The Power API provides the way to control the power service. It can be made to hold the specific state to avoid changing display and CPU state internally.
Enumeration Type Documentation
Enumeration for lock type.
Each enum ensures that the suitable device is on until all the lock requests have been released or after a timeout.
CPU Brightness
POWER_LOCK_CPU ON OFF
POWER_LOCK_DISPLAY ON ON(normal)
POWER_LOCK_DISPLAY_DIM ON ON(dim)
- Since :
- 2.3.1
- Enumerator:
POWER_LOCK_CPU |
CPU lock
|
POWER_LOCK_DISPLAY |
Display normal lock
|
POWER_LOCK_DISPLAY_DIM |
Display dim lock
|
Function Documentation
Releases the given lock state locked before.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Parameters:
-
[in] | type | The power type to release lock |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- device_power_request_lock()
Locks the given lock state for a specified time.
After the given timeout_ms (in milliseconds), unlock the given lock state automatically.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Parameters:
-
[in] | type | The power type to request lock |
[in] | timeout_ms | The positive number in milliseconds or 0 for permanent lock
So you must release the permanent lock of power state with device_power_release_lock() if timeout_ms is zero. |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- device_power_release_lock()
Changes the current power state to the normal/dim state.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Parameters:
-
[in] | dim | Set true to set the dim state, otherwise set false to not set the dim state |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- Postcondition:
- The device will be in DISPLAY_STATE_NORMAL state.