#ifndef __TIZEN_SYSTEM_BATTERY_H__
#define __TIZEN_SYSTEM_BATTERY_H__
+
#include <stdbool.h>
#include "device-error.h"
+
#ifdef __cplusplus
extern "C" {
#endif
* @{
*/
+
/**
* @brief Enumeration for the battery level status.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef enum {
- DEVICE_BATTERY_LEVEL_EMPTY = 0, /**< The battery goes empty. Prepare for the safe termination of the application, because the device starts a shutdown process soon after entering this level. */
- DEVICE_BATTERY_LEVEL_CRITICAL, /**< The battery charge is at a critical state. You may have to stop using multimedia features, because they are not guaranteed to work correctly at this battery status. */
- DEVICE_BATTERY_LEVEL_LOW, /**< The battery has little charge left. */
- DEVICE_BATTERY_LEVEL_HIGH, /**< The battery status is not to be careful. */
- DEVICE_BATTERY_LEVEL_FULL, /**< The battery status is full. */
+ DEVICE_BATTERY_LEVEL_EMPTY = 0, /**< The battery goes empty. Prepare for the safe termination of the application, because the device starts a shutdown process soon after entering this level. */
+ DEVICE_BATTERY_LEVEL_CRITICAL, /**< The battery charge is at a critical state. You may have to stop using multimedia features, because they are not guaranteed to work correctly at this battery status. */
+ DEVICE_BATTERY_LEVEL_LOW, /**< The battery has little charge left. */
+ DEVICE_BATTERY_LEVEL_HIGH, /**< The battery status is not to be careful. */
+ DEVICE_BATTERY_LEVEL_FULL, /**< The battery status is full. */
} device_battery_level_e;
+
/**
* @brief Enumeration for battery health information.
* @since_tizen 3.0
*/
typedef enum {
- DEVICE_BATTERY_HEALTH_GOOD, /**< The battery health is good */
- DEVICE_BATTERY_HEALTH_COLD, /**< The temperature of the battery is cold */
- DEVICE_BATTERY_HEALTH_DEAD, /**< The battery is dead */
- DEVICE_BATTERY_HEALTH_OVER_HEAT, /**< The temperature of the battery is high */
- DEVICE_BATTERY_HEALTH_OVER_VOLTAGE,/**< The battery is in over voltage state */
+ DEVICE_BATTERY_HEALTH_GOOD, /**< The battery health is good */
+ DEVICE_BATTERY_HEALTH_COLD, /**< The temperature of the battery is cold */
+ DEVICE_BATTERY_HEALTH_DEAD, /**< The battery is dead */
+ DEVICE_BATTERY_HEALTH_OVER_HEAT, /**< The temperature of the battery is high */
+ DEVICE_BATTERY_HEALTH_OVER_VOLTAGE, /**< The battery is in over voltage state */
} device_battery_health_e;
+
/**
* @brief Enumeration for power source information.
* @since_tizen 3.0
*/
typedef enum {
- DEVICE_BATTERY_POWER_SOURCE_NONE, /**< There is no power source */
- DEVICE_BATTERY_POWER_SOURCE_AC, /**< AC power cable is connected */
- DEVICE_BATTERY_POWER_SOURCE_USB, /**< USB power cable is connected */
- DEVICE_BATTERY_POWER_SOURCE_WIRELESS,/**< Power is provided by a wireless source */
+ DEVICE_BATTERY_POWER_SOURCE_NONE, /**< There is no power source */
+ DEVICE_BATTERY_POWER_SOURCE_AC, /**< AC power cable is connected */
+ DEVICE_BATTERY_POWER_SOURCE_USB, /**< USB power cable is connected */
+ DEVICE_BATTERY_POWER_SOURCE_WIRELESS, /**< Power is provided by a wireless source */
} device_battery_power_source_e;
+
/**
* @brief Enumeration for battery property information.
* @since_tizen 3.0
*/
typedef enum {
- DEVICE_BATTERY_PROPERTY_CAPACITY, /**< The battery capacity (0 ~ 100 %) */
- DEVICE_BATTERY_PROPERTY_CURRENT_NOW, /**< The battery current (uA) */
- DEVICE_BATTERY_PROPERTY_CURRENT_AVERAGE,/**< The average battery current (uA) */
+ DEVICE_BATTERY_PROPERTY_CAPACITY, /**< The battery capacity (0 ~ 100 %) */
+ DEVICE_BATTERY_PROPERTY_CURRENT_NOW, /**< The battery current (uA) */
+ DEVICE_BATTERY_PROPERTY_CURRENT_AVERAGE, /**< The average battery current (uA) */
} device_battery_property_e;
+
/**
* @brief Enumeration for battery status information.
* @since_tizen 3.0
*/
typedef enum {
- DEVICE_BATTERY_STATUS_CHARGING, /**< Battery is charging */
- DEVICE_BATTERY_STATUS_DISCHARGING, /**< Battery is discharging */
- DEVICE_BATTERY_STATUS_FULL, /**< Battery is fully charged */
+ DEVICE_BATTERY_STATUS_CHARGING, /**< Battery is charging */
+ DEVICE_BATTERY_STATUS_DISCHARGING, /**< Battery is discharging */
+ DEVICE_BATTERY_STATUS_FULL, /**< Battery is fully charged */
DEVICE_BATTERY_STATUS_NOT_CHARGING, /**< Battery is not charging */
} device_battery_status_e;
+
/**
* @brief Gets the battery charge percentage.
* @details It returns an integer value from @c 0 to @c 100 that indicates remaining battery charge
* as a percentage of the maximum level.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @remarks In order to be notified when the battery state changes, use system_info_set_changed_cb().
- *
* @param[out] percent The remaining battery charge percentage (@c 0 ~ @c 100)
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
*/
int device_battery_get_percent(int *percent);
+
/**
* @brief Gets the charging state.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[out] charging The battery charging state
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_add_callback
* @see device_remove_callback
* @see #DEVICE_CALLBACK_BATTERY_CHARGING
*/
int device_battery_is_charging(bool *charging);
+
/**
* @brief Gets the battery level status.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[out] status The battery level status
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_battery_level_e
* @see device_add_callback
* @see device_remove_callback
*/
int device_battery_get_level_status(device_battery_level_e *status);
+
/**
* @brief Gets the battery health information.
- *
* @since_tizen 3.0
- *
* @param[out] health The battery health information
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
*/
int device_battery_get_health(device_battery_health_e *health);
+
/**
* @brief Gets the battery power source information.
- *
* @since_tizen 3.0
- *
* @param[out] source The battery power source information
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
*/
int device_battery_get_power_source(device_battery_power_source_e *source);
+
/**
* @brief Gets the battery properties.
- *
* @since_tizen 3.0
- *
* @param[in] property The property type
* @param[out] value The battery information for the property given
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
*/
int device_battery_get_property(device_battery_property_e property, int *value);
+
/**
* @brief Gets the battery status information.
- *
* @since_tizen 3.0
- *
* @param[out] status The battery status information
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
*/
int device_battery_get_status(device_battery_status_e *status);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif // __TIZEN_SYSTEM_BATTERY_H__
#ifndef __TIZEN_SYSTEM_CALLBACK_H__
#define __TIZEN_SYSTEM_CALLBACK_H__
+
#include <stdbool.h>
#include "device-error.h"
+
#ifdef __cplusplus
extern "C" {
#endif
* @{
*/
+
/**
* @brief Enumeration for the device state callback.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef enum {
- DEVICE_CALLBACK_BATTERY_CAPACITY, /**< Called when a battery charge percentage is changed */
- DEVICE_CALLBACK_BATTERY_LEVEL, /**< Called when a battery level is changed */
- DEVICE_CALLBACK_BATTERY_CHARGING, /**< Called when battery charging state is changed */
- DEVICE_CALLBACK_DISPLAY_STATE, /**< Called when a display state is changed */
- DEVICE_CALLBACK_FLASH_BRIGHTNESS, /**< Called when a flash brightness is changed (Since Tizen @if Mobile 2.4 @elseif WEARABLE 3.0 @endif) */
+ DEVICE_CALLBACK_BATTERY_CAPACITY, /**< Called when a battery charge percentage is changed */
+ DEVICE_CALLBACK_BATTERY_LEVEL, /**< Called when a battery level is changed */
+ DEVICE_CALLBACK_BATTERY_CHARGING, /**< Called when battery charging state is changed */
+ DEVICE_CALLBACK_DISPLAY_STATE, /**< Called when a display state is changed */
+ DEVICE_CALLBACK_FLASH_BRIGHTNESS, /**< Called when a flash brightness is changed (Since Tizen @if Mobile 2.4 @elseif WEARABLE 3.0 @endif) */
DEVICE_CALLBACK_MAX
} device_callback_e;
+
/**
* @brief Called when a device status is changed.
* @details Each device callback has a different output param type. \n
* DEVICE_CALLBACK_BATTERY_CHARGING bool \n
* DEVICE_CALLBACK_DISPLAY_STATE int \n
* DEVICE_CALLBACK_FLASH_BRIGHTNESS int
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @remarks DEVICE_CALLBACK_FLASH_BRIGHTNESS callback invoked when user set flash brightness by using device_flash_set_brightness(). It does not work by camera flash operation. To register DEVICE_CALLBACK_FLASH_BRIGHTNESS callback, you need to declare the LED privilege (%http://tizen.org/privilege/led).
- *
- * @param[out] type The device type to monitor
- * @param[out] value The changed value \n
- * @param[out] user_data The user data passed from the callback registration function
+ * @param[out] type The device type to monitor
+ * @param[out] value The changed value
+ * @param[out] user_data The user data passed from the callback registration function
*/
typedef void (*device_changed_cb)(device_callback_e type, void *value, void *user_data);
+
/**
* @brief Adds a callback to the observing device state.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] type The device type to monitor
- * @param[in] callback The callback function to add
- * @param[in] user_data The user data to be passed to the callback function
- *
+ * @param[in] type The device type to monitor
+ * @param[in] callback The callback function to add
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_ALREADY_IN_PROGRESS Operation already
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_ALREADY_IN_PROGRESS Operation already
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
*/
int device_add_callback(device_callback_e type, device_changed_cb callback, void *user_data);
+
/**
* @brief Removes a device callback function.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] type The device type to monitor
- * @param[in] callback The callback function to remove
- *
+ * @param[in] type The device type to monitor
+ * @param[in] callback The callback function to remove
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
*/
int device_remove_callback(device_callback_e type, device_changed_cb callback);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif // __TIZEN_SYSTEM_CALLBACK_H__
#ifndef __TIZEN_SYSTEM_DEVICE_ERROR_H__
#define __TIZEN_SYSTEM_DEVICE_ERROR_H__
+
#include <tizen.h>
+
#ifdef __cplusplus
extern "C" {
#endif
* @{
*/
+
/**
- * @brief Enumerations of error code for Device.
+ * @brief Enumeration for device's error code.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef enum {
- DEVICE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
- DEVICE_ERROR_OPERATION_FAILED = TIZEN_ERROR_NOT_PERMITTED, /**< Operation not permitted */
- DEVICE_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
- DEVICE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
+ DEVICE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
+ DEVICE_ERROR_OPERATION_FAILED = TIZEN_ERROR_NOT_PERMITTED, /**< Operation not permitted */
+ DEVICE_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
+ DEVICE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
DEVICE_ERROR_ALREADY_IN_PROGRESS = TIZEN_ERROR_ALREADY_IN_PROGRESS, /**< Operation already in progress */
- DEVICE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported in this device */
- DEVICE_ERROR_RESOURCE_BUSY = TIZEN_ERROR_RESOURCE_BUSY, /**< Device or resource busy */
- DEVICE_ERROR_NOT_INITIALIZED = TIZEN_ERROR_DEVICE | 0x13, /**< Not initialized */
+ DEVICE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported in this device */
+ DEVICE_ERROR_RESOURCE_BUSY = TIZEN_ERROR_RESOURCE_BUSY, /**< Device or resource busy */
+ DEVICE_ERROR_NOT_INITIALIZED = TIZEN_ERROR_DEVICE | 0x13, /**< Not initialized */
} device_error_e;
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif // __TIZEN_SYSTEM_DEVICE_ERROR_H__
#ifndef __TIZEN_SYSTEM_DISPLAY_H__
#define __TIZEN_SYSTEM_DISPLAY_H__
+
#include "device-error.h"
+
#ifdef __cplusplus
extern "C" {
#endif
* @{
*/
+
/**
* @brief Gets the number of display devices.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/display
- *
* @param[out] device_number The total number of displays
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_display_get_brightness()
* @see device_display_set_brightness()
* @see device_display_get_max_brightness()
*/
int device_display_get_numbers(int *device_number);
+
/**
* @brief Gets the maximum brightness value that can be set.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/display
- *
- * @param[in] display_index The index of the display \n
- * It can be greater than or equal to @c 0 and less than
- * the number of displays returned by device_display_get_numbers(). \n
- * The index zero is always assigned to the main display.
- * @param[out] max_brightness The maximum brightness value of the display
- *
+ * @param[in] display_index The index of the display \n
+ * It can be greater than or equal to @c 0 and less than the number of displays returned by device_display_get_numbers(). \n
+ * The index zero is always assigned to the main display
+ * @param[out] max_brightness The maximum brightness value of the display
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_display_get_numbers()
* @see device_display_set_brightness()
* @see device_display_get_brightness()
*/
int device_display_get_max_brightness(int display_index, int *max_brightness);
+
/**
* @brief Gets the display brightness value.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/display
- *
* @param[in] display_index The index of the display \n
- * It can be greater than or equal to @c 0 and less than
- * the number of displays returned by device_display_get_numbers(). \n
- * The index zero is always assigned to the main display.
- * @param[out] brightness The current brightness value of the display
- *
+ * It can be greater than or equal to @c 0 and less than the number of displays returned by device_display_get_numbers(). \n
+ * The index zero is always assigned to the main display
+ * @param[out] brightness The current brightness value of the display
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_display_get_numbers()
* @see device_display_set_brightness()
* @see device_display_get_max_brightness()
*/
int device_display_get_brightness(int display_index, int *brightness);
+
/**
* @brief Sets the display brightness value.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/display
- *
* @param[in] display_index The index of the display \n
- * It can be greater than or equal to @c 0 and less than
- * the number of displays returned by device_display_get_numbers(). \n
- * The index zero is always assigned to the main display.
- * @param[in] brightness The new brightness value to set \n
- * The maximum value can be represented by device_display_get_max_brightness().
- *
+ * It can be greater than or equal to @c 0 and less than the number of displays returned by device_display_get_numbers(). \n
+ * The index zero is always assigned to the main display
+ * @param[in] brightness The new brightness value to set \n
+ * The maximum value can be represented by device_display_get_max_brightness()
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_display_get_numbers()
* @see device_display_get_max_brightness()
* @see device_display_get_brightness()
*/
int device_display_set_brightness(int display_index, int brightness);
+
/**
- * @brief Enumeration for the available display states.
+ * @brief Enumeration for the available display states.
* @details An application cannot put the device into the power off state or the suspend state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef enum
{
- DISPLAY_STATE_NORMAL, /**< Normal state */
- DISPLAY_STATE_SCREEN_DIM, /**< @if TV @internal @endif Screen dim state */
- DISPLAY_STATE_SCREEN_OFF, /**< Screen off state */
+ DISPLAY_STATE_NORMAL, /**< Normal state */
+ DISPLAY_STATE_SCREEN_DIM, /**< @if TV @internal @endif Screen dim state */
+ DISPLAY_STATE_SCREEN_OFF, /**< Screen off state */
} display_state_e;
+
/**
* @brief Gets the current display state.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[out] state the display state
- *
+ * @param[out] state The display state
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_add_callback
* @see device_remove_callback
* @see #DEVICE_CALLBACK_DISPLAY_STATE
*/
int device_display_get_state(display_state_e *state);
+
/**
* @deprecated Deprecated Since @if WEARABLE 3.0 @else 2.4 @endif
* @brief Changes the display state by force.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/display
- *
- * @remarks This API triggers display change process and then updates the status when it completes. While the operation is on-going, the device_display_get_state() function returns previous display state
- *
- * @param[in] state the display state
- *
+ * @remarks This API triggers display change process and then updates the status when it completes. While the operation is on-going, the device_display_get_state() function returns previous display state.
+ * @param[in] state The display state
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_power_request_lock()
* @see device_power_release_lock()
* @see device_add_callback
* @code
* ...
* result = device_display_change_state(DISPLAY_STATE_SCREEN_OFF);
- * if( result < 0 )
+ * if (result < 0)
* dlog_print(DLOG_ERROR, LOG_TAG, "[ERROR] return value result =%d, \n",result);
* else
* dlog_print(DLOG_DEBUG, LOG_TAG, "[SUCCESS] return value result =%d \n",result);
*/
int device_display_change_state(display_state_e state) TIZEN_DEPRECATED_API;
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif // __TIZEN_SYSTEM_DISPLAY_H__
#ifndef __TIZEN_SYSTEM_HAPTIC_H__
#define __TIZEN_SYSTEM_HAPTIC_H__
+
#include "device-error.h"
+
#ifdef __cplusplus
extern "C" {
#endif
* @{
*/
+
/**
* @brief The haptic device handle.
*/
typedef void* haptic_device_h;
+
/**
* @brief The haptic effect handle.
*/
typedef void* haptic_effect_h;
+
/**
* @brief Gets the number of vibrators.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
- *
* @param[in] device_number The number of vibrators
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
*/
int device_haptic_get_count(int *device_number);
+
/**
* @brief Opens a haptic-vibration device.
* @details Internally, it makes a connection to the vibrator.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
- *
* @remarks You must close the Haptic API using device_haptic_close().
- *
* @param[in] device_index The index of device what you want to vibrate \n
- * The index starts from @c 0.
+ * The index starts from @c 0
* @param[out] device_handle The handle of vibrator
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
* @see device_haptic_close()
*/
int device_haptic_open(int device_index, haptic_device_h *device_handle);
+
/**
* @brief Closes a haptic-vibration device.
* @details Internally, it disconnects the connection to the vibrator.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
- *
* @param[in] device_handle The device handle from device_haptic_open()
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
* @see device_haptic_open()
*/
int device_haptic_close(haptic_device_h device_handle);
+
/**
* @brief Vibrates during the specified time with a constant intensity.
* @details This function can be used to start monotonous vibration for the specified time.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
- *
* @remarks @a feedback level is reserved for auto changing to save variable in the settings.
* @remarks @a effect_handle effect_handle value can be @c 0(zero).
- *
* @param[in] device_handle The device handle from device_haptic_open()
* @param[in] duration The play duration in milliseconds
* @param[in] feedback The amount of the intensity variation (@c 0 ~ @c 100)
* @param[out] effect_handle The pointer to the variable that will receive a handle to the playing effect
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
* @see device_haptic_stop()
*/
+int device_haptic_vibrate(haptic_device_h device_handle, int duration, int feedback, haptic_effect_h *effect_handle);
-int device_haptic_vibrate(haptic_device_h device_handle,
- int duration, int feedback, haptic_effect_h *effect_handle);
/**
* @brief Stops all vibration effects which are being played.
* @details This function can be used to stop all effects started by device_haptic_vibrate().
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
- *
* @param[in] device_handle The device handle from device_haptic_open()
* @param[in] effect_handle The effect handle from device_haptic_vibrate()
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
* @see device_haptic_vibrate()
*/
int device_haptic_stop(haptic_device_h device_handle, haptic_effect_h effect_handle);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif // __TIZEN_SYSTEM_HAPTIC_H__
#ifndef __TIZEN_SYSTEM_IR_H__
#define __TIZEN_SYSTEM_IR_H__
+
#include <stdbool.h>
#include "device-error.h"
+
#ifdef __cplusplus
extern "C" {
#endif
* @{
*/
+
/**
* @brief Gets the information whether IR module is available.
- *
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/use_ir
- *
- * @param[out] available The information whether IR is available.
- *
+ * @param[out] available The information whether IR is available
* @return @c 0 on success,
- * otherwise a negative error value.
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * otherwise a negative error value
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
*/
int device_ir_is_available(bool *available);
+
/**
* @brief Transmits IR command.
- *
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/use_ir
- *
- * @param[in] carrier_frequency Carrier frequency to transmit IR command. (Hertz)
- * @param[in] pattern Integer array of IR command.
- * @param[in] size Size of IR command pattern.
- *
+ * @param[in] carrier_frequency Carrier frequency to transmit IR command (Hertz)
+ * @param[in] pattern Integer array of IR command
+ * @param[in] size Size of IR command pattern
* @return @c 0 on success,
- * otherwise a negative error value.
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * otherwise a negative error value
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
*/
int device_ir_transmit(int carrier_frequency, int *pattern, int size);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif /* __TIZEN_SYSTEM_IR_H__ */
#ifndef __TIZEN_SYSTEM_LED_H__
#define __TIZEN_SYSTEM_LED_H__
+
#include "device-error.h"
+
#ifdef __cplusplus
extern "C" {
#endif
* @{
*/
+
/**
* @brief Gets the max brightness value of a LED that is located next to the camera.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/led
- *
* @remarks This API is related to the following feature: %http://tizen.org/feature/camera.back.flash
- *
* @param[out] max_brightness The max brightness value of the LED
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
*/
int device_flash_get_max_brightness(int *max_brightness);
+
/**
* @brief Gets the brightness value of a LED that is located next to the camera.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/led
- *
* @remarks This API is related to the following feature: %http://tizen.org/feature/camera.back.flash
- *
* @param[out] brightness The brightness value of LED (@c 0 ~ MAX)
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
*/
int device_flash_get_brightness(int *brightness);
+
/**
* @brief Sets the brightness value of a LED that is located next to the camera.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/led
- *
* @remarks Since @if Mobile 2.4 @elseif WEARABLE 3.0 @endif, this API check camera flash status whether camera API preempted flash or not, so it could be failed if flash was preempted by camera API. In this case, API will return #DEVICE_ERROR_RESOURCE_BUSY error.
- * This API is related to the following feature: %http://tizen.org/feature/camera.back.flash
- *
+ * This API is related to the following feature: %http://tizen.org/feature/camera.back.flash
* @param[in] brightness The brightness value of LED (@c 0 ~ MAX)
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
- * @retval #DEVICE_ERROR_RESOURCE_BUSY Device or resource busy
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * @retval #DEVICE_ERROR_RESOURCE_BUSY Device or resource busy
*/
int device_flash_set_brightness(int brightness);
+
/**
* @brief Enumeration for custom LED flags.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef enum {
- LED_CUSTOM_DUTY_ON = 1 << 0, /**< blink LED */
- LED_CUSTOM_DEFAULT = (LED_CUSTOM_DUTY_ON), /**< Default flag */
+ LED_CUSTOM_DUTY_ON = 1 << 0, /**< blink LED */
+ LED_CUSTOM_DEFAULT = (LED_CUSTOM_DUTY_ON), /**< Default flag */
} led_custom_flags;
+
/**
* @brief Plays the custom effect of the service LED that is located to the front of a device.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/led
- *
* @remarks This API is related to the following feature: %http://tizen.org/feature/led
- *
- * @param[in] on Turn on time in milliseconds
- * @param[in] off Turn off time in milliseconds
+ * @param[in] on Turn on time in milliseconds
+ * @param[in] off Turn off time in milliseconds
* @param[in] color The Color value \n
- * The first byte means opaque and the other 3 bytes are RGB values.
+ * The first byte means opaque and the other 3 bytes are RGB values
* @param[in] flags The combination of enum #led_custom_flags
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
*/
int device_led_play_custom(int on, int off, unsigned int color, unsigned int flags);
+
/**
* @brief Stops the custom effect of the service LED that is located to the front of a device.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/led
- *
* @remarks This API is related to the following feature: %http://tizen.org/feature/led
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
*/
int device_led_stop_custom(void);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif // __TIZEN_SYSTEM_LED_H__
#ifndef __TIZEN_SYSTEM_POWER_H__
#define __TIZEN_SYSTEM_POWER_H__
+
#include <stdbool.h>
#include "device-error.h"
+
#ifdef __cplusplus
extern "C" {
#endif
* @{
*/
+
/**
* @brief Enumeration for lock type.
- * @details Each enum ensures that the suitable device is on
- * until all the lock requests have been released or after a timeout. \n
- *
+ * @details Each enum ensures that the suitable device is on until all the lock requests have been released or after a timeout.
* <TABLE>
* <TR><TH>Enum Type</TH><TH>CPU</TH><TH>Brightness(Display)</TH></TR>
* <TR><TD>POWER_LOCK_CPU</TD><TD>ON</TD><TD>OFF</TD></TR>
* </TABLE>
* The POWER_LOCK_DISPLAY and POWER_LOCK_DISPLAY_DIM types were deprecated in Tizen @if Mobile 2.4 @elseif WEARABLE 3.0 @endif.\n
* Please use below api set instead of these types.\n
- * int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e mode);\n
+ * int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e mode); \n
* int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e *mode);
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @remarks An application can lock the specific type.
* @remarks These enums are mutually exclusive.
* @remarks You cannot combine with an enum below.
- *
*/
typedef enum {
- POWER_LOCK_CPU, /**< CPU lock */
- POWER_LOCK_DISPLAY, /**< Display normal lock (Deprecated since @if Mobile 2.4 @elseif WEARABLE 3.0 @endif. Use efl_util_set_window_screen_mode() instead) */
+ POWER_LOCK_CPU, /**< CPU lock */
+ POWER_LOCK_DISPLAY, /**< Display normal lock (Deprecated since @if Mobile 2.4 @elseif WEARABLE 3.0 @endif. Use efl_util_set_window_screen_mode() instead) */
POWER_LOCK_DISPLAY_DIM, /**< Display dim lock (Deprecated since @if Mobile 2.4 @elseif WEARABLE 3.0 @endif. Use efl_util_set_window_screen_mode() instead) */
} power_lock_e;
+
/**
* @brief Locks the given lock state for a specified time.
* @details After the given @a timeout_ms (in milliseconds), unlock the given lock state automatically.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/display
- *
* @remarks If the process dies, then every lock will be removed.
- *
- * @param[in] type The power type to request lock
- * @param[in] timeout_ms The positive number in milliseconds or @c 0 for permanent lock \n
- * So you must release the permanent lock of power state with #device_power_release_lock() if @a timeout_ms is zero.
- *
+ * @param[in] type The power type to request lock
+ * @param[in] timeout_ms The positive number in milliseconds or @c 0 for permanent lock \n
+ * So you must release the permanent lock of power state with #device_power_release_lock() if @a timeout_ms is zero
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_power_release_lock()
*/
int device_power_request_lock(power_lock_e type, int timeout_ms);
+
/**
- * @brief Releases the given lock state locked before.
- *
+ * @brief Releases the given lock state which was locked before.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/display
- *
* @param[in] type The power type to release lock
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @see device_power_request_lock()
*/
int device_power_release_lock(power_lock_e type);
+
/**
* @deprecated Deprecated Since @if WEARABLE 3.0 @else 2.4 @endif
* @brief Changes the current power state to the normal/dim state.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/display
- *
- * @remarks This API triggers turn on process and then updates the status when it completes. While the operation is on-going, the device_display_get_state() function returns previous display state
- *
+ * @remarks This API triggers turn on process and then updates the status when it completes. While the operation is on-going, the device_display_get_state() function returns previous display state.
* @param[in] dim Set @c true to set the dim state,
* otherwise set @c false to not set the dim state
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
- *
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
* @post The device will be in #DISPLAY_STATE_NORMAL state.
*/
int device_power_wakeup(bool dim) TIZEN_DEPRECATED_API;
+
/**
* @platform
* @brief Reboots the device.
* @details Will not return if the reboot is successful. \n
* It operates asynchronously.
- *
* @since_tizen 2.3.1
* @privlevel platform
* @privilege %http://tizen.org/privilege/reboot
- *
- * @param[in] reason Pass to the platform and kernel to request special reboot reason, or null.
- *
+ * @param[in] reason Pass to the platform and kernel to request special reboot reason, or null
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #DEVICE_ERROR_NONE Successful
- * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #DEVICE_ERROR_NONE Successful
+ * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
*/
int device_power_reboot(const char *reason);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif // __TIZEN_SYSTEM_POWER_H__
projects / platform / core / api / device.git / commitdiff