diff options
author | Abhishek Chandra <abhishek.ch@samsung.com> | 2017-02-08 17:36:16 +0530 |
---|---|---|
committer | Abhishek Chandra <abhishek.ch@samsung.com> | 2017-02-08 17:37:50 +0530 |
commit | bc00e3c3947421c675186c0da4a9119a692f54da (patch) | |
tree | 7196825167cf6041e9665acb262af621c1fc1941 | |
parent | 302a44fc7e72caf8d899520e9da361f10f59bc27 (diff) | |
download | bluetooth-bc00e3c3947421c675186c0da4a9119a692f54da.tar.gz bluetooth-bc00e3c3947421c675186c0da4a9119a692f54da.tar.bz2 bluetooth-bc00e3c3947421c675186c0da4a9119a692f54da.zip |
API Doxygen change merge
This Commit is done to incorporate doxygen
changes done by API team in bluetooth.h for wearables and tv
Change-Id: I994a76da4380d194098035d8ab02fda9bf3f58a1
Signed-off-by: Abhishek Chandra <abhishek.ch@samsung.com>
-rw-r--r-- | include/tv/bluetooth.h | 4846 | ||||
-rw-r--r-- | include/wearable/bluetooth.h | 4416 |
2 files changed, 4580 insertions, 4682 deletions
diff --git a/include/tv/bluetooth.h b/include/tv/bluetooth.h index 0090261..30eea37 100644 --- a/include/tv/bluetooth.h +++ b/include/tv/bluetooth.h @@ -35,10 +35,11 @@ extern "C" { #endif /* __cplusplus */ + /** - * @file bluetooth.h - * @brief API to control the Bluetooth adapter and devices and communications. - * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE + * @file bluetooth.h + * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE + * @brief API to control the Bluetooth adapter, devices, and communications. */ @@ -52,16 +53,14 @@ extern "C" * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE * @brief Initializes the Bluetooth API. * @since_tizen 2.3 - * * @remarks This function must be called before Bluetooth API starts. \n - * You must free all resources of the Bluetooth service by calling bt_deinitialize() if Bluetooth service is no longer needed. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_deinitialize() + * You must free all resources of the Bluetooth service by calling bt_deinitialize() if Bluetooth service is no longer needed. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_deinitialize() */ int bt_initialize(void); @@ -70,130 +69,115 @@ int bt_initialize(void); * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE * @brief Releases all resources of the Bluetooth API. * @since_tizen 2.3 - * * @remarks This function must be called if Bluetooth API is no longer needed. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre Bluetooth API must be initialized with bt_initialize(). - * * @see bt_initialize() */ int bt_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE * @brief Gets the specification name for the given UUID. * @since_tizen 3.0 - * * @remarks The @a name must be released using free(). - * * @param[in] uuid The UUID * @param[out] name The specification name defined at www.bluetooth.com - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value. + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_get_uuid() */ int bt_get_uuid_name(const char *uuid, char **name); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the current state of local Bluetooth adapter. * @since_tizen 2.3 - * * @param[out] adapter_state The current adapter state - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre Bluetooth service must be initialized with bt_initialize(). - * * @see bt_initialize() */ int bt_adapter_get_state(bt_adapter_state_e *adapter_state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the address of local Bluetooth adapter. * @since_tizen 2.3 - * * @remarks The @a local_address must be released with free() by you. - * * @param[out] local_address The device address of local Bluetooth adapter - * - * @return 0 on success, otherwise a negative error value. + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @see bt_adapter_get_name() */ int bt_adapter_get_address(char **local_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the name of local Bluetooth adapter. + * @details Use this function to get the friendly name associated with Bluetooth device, retrieved by the remote Bluetooth devices. * @since_tizen 2.3 - * - * @details Use this function to get the friendly name associated with Bluetooth - * device, retrieved by the remote Bluetooth devices. - * * @remarks The @a local_name must be released with free() by you. - * - * @param[out] local_name The local device name - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[out] local_name The local device name + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * * @see bt_adapter_set_name() */ int bt_adapter_get_name(char **local_name); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Sets the name of local Bluetooth adapter. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] local_name The name of the Bluetooth device. \n - * The maximum length is 248 characters. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled + * The maximum length is 248 characters + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post bt_adapter_name_changed_cb() will be invoked if this function returns #BT_ERROR_NONE. - * * @see bt_adapter_get_name() * @see bt_adapter_name_changed_cb() * @see bt_adapter_set_name_changed_cb() @@ -201,51 +185,49 @@ int bt_adapter_get_name(char **local_name); */ int bt_adapter_set_name(const char *local_name); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Gets the visibility mode of local Bluetooth adapter. + * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE + * @brief Gets the visibility mode of local Bluetooth adapter. * @since_tizen 2.3 - * @param[out] mode The visibility mode of the Bluetooth device - * @param[out] duration The duration until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE (in seconds). - * @a duration is valid only if @a mode is #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE. This value can be NULL. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[out] mode The visibility mode of the Bluetooth device + * @param[out] duration The duration until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE (in seconds). + * @a duration is valid only if @a mode is #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE. This value can be NULL + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. */ int bt_adapter_get_visibility(bt_adapter_visibility_mode_e *mode, int *duration); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Starts the device discovery, asynchronously. + * @details If a device is discovered, bt_adapter_device_discovery_state_changed_cb() will be invoked + * with #BT_ADAPTER_DEVICE_DISCOVERY_FOUND, and then bt_adapter_device_discovery_state_changed_cb() + * will be called with #BT_ADAPTER_DEVICE_DISCOVERY_FINISHED in case of the completion or cancellation of the discovery. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @details If a device is discovered, bt_adapter_device_discovery_state_changed_cb() will be invoked - * with #BT_ADAPTER_DEVICE_DISCOVERY_FOUND, and then bt_adapter_device_discovery_state_changed_cb() - * will be called with #BT_ADAPTER_DEVICE_DISCOVERY_FINISHED in case of the completion or cancellation of the discovery. - * * @remarks To connect to peer Bluetooth device, you need to know its Bluetooth address. \n - * The device discovery can be stopped by bt_adapter_stop_device_discovery(). - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * The device discovery can be stopped by bt_adapter_stop_device_discovery(). + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post This function invokes bt_adapter_device_discovery_state_changed_cb(). - * * @see bt_adapter_is_discovering() * @see bt_adapter_stop_device_discovery() * @see bt_adapter_device_discovery_state_changed_cb() @@ -254,6 +236,7 @@ int bt_adapter_get_visibility(bt_adapter_visibility_mode_e *mode, int *duration) */ int bt_adapter_start_device_discovery(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Stops the device discovery, asynchronously. @@ -261,19 +244,17 @@ int bt_adapter_start_device_discovery(void); * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @remarks The device discovery process will take 10 ~ 20 seconds to get all the devices in vicinity. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The device discovery must be in progress with bt_adapter_start_device_discovery(). * @post This function invokes bt_adapter_device_discovery_state_changed_cb(). - * * @see bt_adapter_is_discovering() * @see bt_adapter_start_device_discovery() * @see bt_adapter_set_device_discovery_state_changed_cb() @@ -282,152 +263,144 @@ int bt_adapter_start_device_discovery(void); */ int bt_adapter_stop_device_discovery(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Checks for the device discovery is in progress or not. + * @brief Checks if the device discovery is in progress or not. * @since_tizen 2.3 - * * @remarks If Bluetooth discovery is in progress, other operations are not allowed and - * you have to either stop the discovery operation, or wait for it to be finished, - * before performing other operations. - - * @param[out] is_discovering The discovering status: (@c true = in progress , @c false = not in progress ) - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * you have to either stop the discovery operation, or wait for it to be finished, + * before performing other operations. + * @param[out] is_discovering The discovering status: (@c true = in progress , @c false = not in progress ) + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * * @see bt_adapter_start_device_discovery() * @see bt_adapter_stop_device_discovery() */ int bt_adapter_is_discovering(bool *is_discovering); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Get the service mask from the uuid list. + * @brief Gets the service mask from the UUID list. * @since_tizen 2.3 - * - * @param[in] uuids The UUID list of the device. - * @param[in] no_of_service The number of the UUID list count. - * @param[out] service_mask_list Service mask list converted from the given UUID list. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] uuids The UUID list of the device + * @param[in] no_of_service The number of the UUID list count + * @param[out] service_mask_list Service mask list converted from the given UUID list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_service_class_t */ int bt_device_get_service_mask_from_uuid_list(char **uuids, int no_of_service, bt_service_class_t *service_mask_list); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Retrieves the device information of all bonded devices. * @since_tizen 2.3 - * - * @param [in] callback The callback function to invoke - * @param [in] user_data The user data passed from the foreach function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data passed from the foreach function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post This function invokes bt_adapter_bonded_device_cb(). - * * @see bt_adapter_bonded_device_cb() */ int bt_adapter_foreach_bonded_device(bt_adapter_bonded_device_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the device information of a bonded device. * @since_tizen 2.3 - * @remarks The @a device_info must be released with bt_adapter_free_device_info() by you . - * - * @param [in] remote_address The address of remote device - * @param [out] device_info The bonded device information - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a device_info must be released with bt_adapter_free_device_info() by you. + * @param[in] remote_address The address of remote device + * @param[out] device_info The bonded device information + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post This function invokes bt_adapter_bonded_device_cb(). - * * @see bt_adapter_bonded_device_cb() */ int bt_adapter_get_bonded_device_info(const char *remote_address, bt_device_info_s **device_info); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Frees device info. * @since_tizen 2.3 - * - * @param [in] device_info The bonded device information - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] device_info The bonded device information + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_adapter_get_bonded_device_info() */ int bt_adapter_free_device_info(bt_device_info_s *device_info); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Checks whether the UUID of service is used or not + * @brief Checks whether the UUID of service is used or not. * @since_tizen 2.3 * @param[in] service_uuid The UUID of service * @param[out] used Indicates whether the service is used or not - * @return true on success, otherwise false. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c true on success, + * otherwise @c false + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_adapter_is_service_used(const char *service_uuid, bool *used); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked when the Bluetooth adapter state changes. + * @brief Registers a callback function to be invoked when the Bluetooth adapter state changes. * @since_tizen 2.3 - * - * @param[in] callback The callback function to invoke - * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] callback The callback function to invoke + * @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 #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_adapter_state_changed_cb() will be invoked. - * * @see bt_initialize() * @see bt_adapter_state_changed_cb() * @see bt_adapter_set_state_changed_cb() @@ -435,159 +408,151 @@ int bt_adapter_is_service_used(const char *service_uuid, bool *used); */ int bt_adapter_set_state_changed_cb(bt_adapter_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_initialize() * @see bt_adapter_set_state_changed_cb() */ int bt_adapter_unset_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked when the name of Bluetooth adapter changes. + * @brief Registers a callback function to be invoked when the name of Bluetooth adapter changes. * @since_tizen 2.3 - * * @param[in] callback The callback function to invoke * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_adapter_name_changed_cb() will be invoked. - * + * @post bt_adapter_name_changed_cb() will be invoked. * @see bt_initialize() * @see bt_adapter_name_changed_cb() * @see bt_adapter_unset_name_changed_cb() */ int bt_adapter_set_name_changed_cb(bt_adapter_name_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_initialize() * @see bt_adapter_set_name_changed_cb() */ int bt_adapter_unset_name_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked when the visibility mode changes. + * @brief Registers a callback function to be invoked when the visibility mode changes. * @since_tizen 2.3 - * * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_adapter_visibility_mode_changed_cb() will be invoked. - * * @see bt_initialize() * @see bt_adapter_visibility_mode_changed_cb() * @see bt_adapter_unset_visibility_mode_changed_cb() */ int bt_adapter_set_visibility_mode_changed_cb(bt_adapter_visibility_mode_changed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. + * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE + * @brief Unregisters the callback function. * @since_tizen 2.3 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized with bt_initialize(). - * - * @see bt_initialize() - * @see bt_adapter_set_visibility_mode_changed_cb() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized with bt_initialize(). + * @see bt_initialize() + * @see bt_adapter_set_visibility_mode_changed_cb() */ int bt_adapter_unset_visibility_mode_changed_cb(void); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked every second \n - * until the visibility mode is changed from #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE \n - * to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. + * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE + * @brief Registers a callback function to be invoked every second. + * Until the visibility mode is changed from #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. + * @details When you set visibility mode as #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE, + * @a callback will be called every second until visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. * @since_tizen 2.3 - * @details When you set visibility mode as #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE, - * @a callback will be called every second until visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized by bt_initialize(). - * @post bt_adapter_visibility_duration_changed_cb() will be invoked. - * @see bt_initialize() - * @see bt_adapter_visibility_duration_changed_cb() - * @see bt_adapter_unset_visibility_duration_changed_cb() + * @param[in] callback The callback function to register + * @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 #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized by bt_initialize(). + * @post bt_adapter_visibility_duration_changed_cb() will be invoked. + * @see bt_initialize() + * @see bt_adapter_visibility_duration_changed_cb() + * @see bt_adapter_unset_visibility_duration_changed_cb() */ int bt_adapter_set_visibility_duration_changed_cb(bt_adapter_visibility_duration_changed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. + * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE + * @brief Unregisters the callback function. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized with bt_initialize(). - * @see bt_initialize() - * @see bt_adapter_set_visibility_duration_changed_cb() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized with bt_initialize(). + * @see bt_initialize() + * @see bt_adapter_set_visibility_duration_changed_cb() */ int bt_adapter_unset_visibility_duration_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked when the device discovery state changes. + * @brief Registers a callback function to be invoked when the device discovery state changes. * @since_tizen 2.3 - * * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_adapter_device_discovery_state_changed_cb() will be invoked. - * * @see bt_initialize() * @see bt_adapter_device_discovery_state_changed_cb() * @see bt_adapter_set_device_discovery_state_changed_cb() @@ -595,40 +560,39 @@ int bt_adapter_unset_visibility_duration_changed_cb(void); */ int bt_adapter_set_device_discovery_state_changed_cb(bt_adapter_device_discovery_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_initialize() * @see bt_adapter_set_device_discovery_state_changed_cb() */ int bt_adapter_unset_device_discovery_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Get the Hash and Randmoizer value, synchronously. + * @brief Gets the Hash and Randmoizer value, synchronously. * @since_tizen 2.3 - * * @param[out] hash The hash value received from the controller - * @param[out] randomizer The hash value received from the controller + * @param[out] randomizer The randomizer value received from the controller * @param[out] hash_len The length of the hash value * @param[out] randomizer_len The length of the randomizer value - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() @@ -636,27 +600,27 @@ int bt_adapter_unset_device_discovery_state_changed_cb(void); int bt_adapter_get_local_oob_data(unsigned char **hash, unsigned char **randomizer, int *hash_len, int *randomizer_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Sets the Hash and Randmoizer value, synchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address Remote device address * @param[in] hash The hash value received from the controller - * @param[in] randomizer The hash value received from the controller + * @param[in] randomizer The randomizer value received from the controller * @param[in] hash_len The length of the hash value. Allowed value is 16 * @param[in] randomizer_len The length of the randomizer value. Allowed value is 16 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() @@ -665,15 +629,14 @@ int bt_adapter_set_remote_oob_data(const char *remote_address, unsigned char *hash, unsigned char *randomizer, int hash_len, int randomizer_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the Hash and Randmoizer value, synchronously. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @remarks The @a hash192, randomizer192, hash256 and randomizer256 must be released using free() - * + * @remarks The @a hash192, randomizer192, hash256 and randomizer256 must be released using free(). * @param[out] hash192 The hash value derived from the P-192 public key * @param[out] randomizer192 The randomizer value associated with the P-192 public key * @param[out] hash192_len The length of @a hash192 @@ -682,14 +645,14 @@ int bt_adapter_set_remote_oob_data(const char *remote_address, * @param[out] randomizer256 The randomizer value associated with the P-256 public key * @param[out] hash256_len The length of @a hash256 * @param[out] randomizer256_len The length of @a randomizer256 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() @@ -699,13 +662,13 @@ int bt_adapter_get_local_oob_ext_data(unsigned char **hash192, unsigned char **r unsigned char **hash256, unsigned char **randomizer256, int *hash256_len, int *randomizer256_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Sets the Hash and Randmoizer value, synchronously. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address Remote device address * @param[in] hash192 The P-192 hash value received via OOB from remote device * @param[in] randomizer192 The P-192 randomizer value received via OOB from remote device @@ -715,15 +678,15 @@ int bt_adapter_get_local_oob_ext_data(unsigned char **hash192, unsigned char **r * @param[in] randomizer256 The P-256 randomizer value received via OOB from remote device * @param[in] hash256_len The length of @a hash256 * @param[in] randomizer256_len The length of @a randomizer256 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() @@ -734,56 +697,53 @@ int bt_adapter_set_remote_oob_ext_data(const char *remote_address, const unsigned char *hash256, const unsigned char *randomizer256, int hash256_len, int randomizer256_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Deletes the Hash and Randomizer value, synchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address Remote device address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() */ int bt_adapter_remove_remote_oob_data(const char *remote_address); + /** * @deprecated Deprecated since 2.3.1 * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Starts the LE device discovery. + * @details If a LE device is discovered, bt_adapter_le_device_discovery_state_changed_cb() + * will be invoked with #BT_ADAPTER_LE_DEVICE_DISCOVERY_FOUND, and then bt_adapter_le_device_discovery_state_changed_cb() + * will be called with #BT_ADAPTER_LE_DEVICE_DISCOVERY_FINISHED in case of the completion or cancellation of the discovery. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @details If a LE device is discovered, bt_adapter_le_device_discovery_state_changed_cb() -* will be invoked with #BT_ADAPTER_LE_DEVICE_DISCOVERY_FOUND, and then bt_adapter_le_device_discovery_state_changed_cb() - * will be called with #BT_ADAPTER_LE_DEVICE_DISCOVERY_FINISHED in case of the completion or cancellation of the discovery. - * * @remarks To connect to peer Bluetooth device, you need to know its Bluetooth address. \n - * The device discovery can be stopped by bt_adapter_le_stop_device_discovery(). - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * The device discovery can be stopped by bt_adapter_le_stop_device_discovery(). + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post This function invokes bt_adapter_le_device_discovery_state_changed_cb(). - * * @see bt_adapter_le_is_discovering() * @see bt_adapter_le_device_discovery_state_changed_cb() * @see bt_adapter_le_set_device_discovery_state_changed_cb() @@ -791,6 +751,7 @@ int bt_adapter_remove_remote_oob_data(const char *remote_address); */ int bt_adapter_le_start_device_discovery(void) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1 * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE @@ -798,19 +759,17 @@ int bt_adapter_le_start_device_discovery(void) TIZEN_DEPRECATED_API; * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The device discovery must be in progress with bt_adapter_le_start_device_discovery(). * @post This function invokes bt_adapter_le_device_discovery_state_changed_cb(). - * * @see bt_adapter_le_is_discovering() * @see bt_adapter_le_start_device_discovery() * @see bt_adapter_le_set_device_discovery_state_changed_cb() @@ -819,794 +778,714 @@ int bt_adapter_le_start_device_discovery(void) TIZEN_DEPRECATED_API; */ int bt_adapter_le_stop_device_discovery(void) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1 * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Checks for the LE device discovery is in progress or not. + * @brief Checks if the LE device discovery is in progress or not. * @since_tizen 2.3 - * * @remarks If Bluetooth LE discovery is in progress, other operations are not allowed and - * you have to either stop the LE discovery operation, or wait for it to be finished, - * before performing other operations. - - * @param[out] is_discovering The discovering status: (@c true = in progress , @c false = not in progress ) - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * you have to either stop the LE discovery operation, or wait for it to be finished, + * before performing other operations. + * @param[out] is_discovering The discovering status: (@c true = in progress , @c false = not in progress ) + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * * @see bt_adapter_le_start_device_discovery() * @see bt_adapter_le_stop_device_discovery() */ int bt_adapter_le_is_discovering(bool *is_discovering) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1 * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Registers a callback function to be invoked when the LE device discovery state changes. + * @brief Registers a callback function to be invoked when the LE device discovery state changes. * @since_tizen 2.3 - * * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_adapter_le_device_discovery_state_changed_cb() will be invoked. - * * @see bt_initialize() * @see bt_adapter_le_device_discovery_state_changed_cb() * @see bt_adapter_le_unset_device_discovery_state_changed_cb() */ int bt_adapter_le_set_device_discovery_state_changed_cb(bt_adapter_le_device_discovery_state_changed_cb callback, void *user_data) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1 * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_initialize() * @see bt_adapter_le_set_device_discovery_state_changed_cb() */ int bt_adapter_le_unset_device_discovery_state_changed_cb(void) TIZEN_DEPRECATED_API; + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Starts the LE scan to find LE advertisement. + * @details If a LE advertisement is found, bt_adapter_le_scan_result_cb() will be invoked. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @details If a LE advertisement is found, bt_adapter_le_scan_result_cb() will be invoked. - * * @param[in] cb The callback to report the result of this function * @param[in] user_data The user data to be passed when callback is called - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post This function invokes bt_adapter_le_scan_result_cb(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_start_scan(bt_adapter_le_scan_result_cb cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Stops the LE scan. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The LE scan must be in progress with bt_adapter_le_start_scan(). - * * @see bt_adapter_le_start_scan() */ int bt_adapter_le_stop_scan(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the service UUID list from the scan result information + * @brief Gets the service UUID list from the scan result information. * @since_tizen 2.3.1 - * * @remarks The @a uuids must be iterated as count and each pointed data must be released with free(). - * Then uuids must be released with free(). \n - * 16-bit service UUID or 128-bit service UUID is supported. (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) - * + * Then UUIDs must be released with free(). \n + * 16-bit service UUID or 128-bit service UUID is supported. (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB). * @param[in] info The scan result information * @param[in] pkt_type The packet type - * @param[out] uuids The list of string of the service uuid + * @param[out] uuids The list of string of the service UUID * @param[out] count The count of the service UUIDs - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_service_uuids(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, char ***uuids, int *count); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Gets the device name from the scan result information * @since_tizen 2.3.1 - * * @remarks The @a name must be released with free() by you. - * * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] name The device name - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_device_name(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, char **name); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the transmission power level from the scan result information + * @brief Gets the transmission power level from the scan result information. * @since_tizen 2.3.1 - * * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] power_level The transmission power level in dBm - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_tx_power_level(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, int *power_level); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the service solicitation UUID list from the scan result information + * @brief Gets the service solicitation UUID list from the scan result information. * @since_tizen 2.3.1 - * * @remarks The @a uuids must be iterated as count and each pointed data must be released with free(). - * Then uuids must be released with free(). \n - * 16-bit service solicitation UUID or 128-bit service solicitation UUID is supported. - * (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) - * + * Then UUIDs must be released with free(). \n + * 16-bit service solicitation UUID or 128-bit service solicitation UUID is supported. + * (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB). * @param[in] info The scan result information * @param[in] pkt_type The packet type - * @param[out] uuids The list of string of the service solicitation uuid + * @param[out] uuids The list of string of the service solicitation UUID * @param[out] count The count of the service UUIDs - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_service_solicitation_uuids(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, char ***uuids, int *count); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the service data list from the scan result information + * @brief Gets the service data list from the scan result information. * @since_tizen 2.3.1 - * - * @remarks The @a data_list must be released with bt_adapter_le_free_service_data_list() by you . - * + * @remarks The @a data_list must be released with bt_adapter_le_free_service_data_list() by you. * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] data_list The list of the service data * @param[out] count The count of the service data list - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_service_data_list(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, bt_adapter_le_service_data_s **data_list, int *count); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Frees service data list. * @since_tizen 2.3.1 - * * @param[in] data_list The list of the service data * @param[in] count The count of the service data list - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_adapter_le_get_scan_result_service_data_list() */ int bt_adapter_le_free_service_data_list(bt_adapter_le_service_data_s *data_list, int count); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the appearance from the scan result information + * @brief Gets the appearance from the scan result information. * @since_tizen 2.3.1 - * * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] appearance The appearance - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_appearance(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, int *appearance); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the manufacturer data from the scan result information + * @brief Gets the manufacturer data from the scan result information. * @since_tizen 2.3.1 - * * @remarks The @a manufacturer_data must be released with free() by you. - * * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] manufacturer_id The manufacturer ID * @param[out] manufacturer_data The manufacturer data (byte array) * @param[out] manufacturer_data_len The length of manufacturer data - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_manufacturer_data(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, int *manufacturer_id, char **manufacturer_data, int *manufacturer_data_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Create advertiser to advertise device's existence or respond to LE scanning request. + * @brief Creates advertiser to advertise device's existence or respond to LE scanning request. * @since_tizen 2.3 - * * @param[out] advertiser The handle of advertiser - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_destroy_advertiser() */ int bt_adapter_le_create_advertiser(bt_advertiser_h *advertiser); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Destroy advertiser. + * @brief Destroys advertiser. * @since_tizen 2.3 - * * @param[out] advertiser The handle of advertiser - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_create_advertiser() */ int bt_adapter_le_destroy_advertiser(bt_advertiser_h advertiser); + /** * @deprecated Deprecated since 2.3.1 * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set the data to be advertised or responded to scan request from LE scanning device. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Sets the data to be advertised or responded to scan request from LE scanning device. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3 - * * @remarks In case the data_type is local name or tx power level, you don't need to input data - * because the data value is written automatically by system. - * + * because the data value is written automatically by system. * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] data_type The data type that is included in packet * @param[in] data The data to be advertised or be responded to scan request from LE scanning device, no need in case of LOCAL_NAME or TX_POWER_LEVEL - * @param[in] data_size The size of data to be set. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] data_size The size of data to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_add_advertising_data(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, bt_adapter_le_packet_data_type_e data_type, void *data, unsigned int data_size) TIZEN_DEPRECATED_API; + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add a service UUID to advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Adds a service UUID to advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * * @remarks 16-bit UUID or 128-bit UUID is supported. (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type - * @param[in] uuid The string of the service UUID. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] uuid The string of the service UUID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_add_advertising_service_uuid(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, const char *uuid); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add a service solicitation UUID to advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Adds a service solicitation UUID to advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * - * @remarks 16-bit service solicitation UUID or 128-bit service solicitation UUID is supported. - * (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) - * + * @remarks 16-bit service solicitation UUID or 128-bit service solicitation UUID is supported (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type - * @param[in] uuid The string of the service solicitation UUID. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] uuid The string of the service solicitation UUID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_add_advertising_service_solicitation_uuid(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, const char *uuid); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add service data to advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Adds service data to advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * - * @remarks 16-bit UUID is supported. (e.g. 180F) - * + * @remarks 16-bit UUID is supported (e.g. 180F) * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] uuid 16-bit UUID of the service * @param[in] service_data The service data * @param[in] service_data_len The data length of service data - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_add_advertising_service_data(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, const char *uuid, const char *service_data, int service_data_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Sets the external appearance of this device to advertise or scan response data. * Please refer to the adopted Bluetooth specification for the the appearance. * @since_tizen 2.3.1 - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] appearance The external appearance of device - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_set_advertising_appearance(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, int appearance); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add manufacturer specific data to advertise or scan response data. + * @brief Adds manufacturer specific data to advertise or scan response data. * Please refer to the Bluetooth Assigned Numbers provided by the Bluetooth SIG for a list of existing company identifiers. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] manufacturer_id Manufacturer identifier * @param[in] manufacturer_data The manufacturer specific data * @param[in] manufacturer_data_len The data length of manufacturer data - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_add_advertising_manufacturer_data(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, int manufacturer_id, const char *manufacturer_data, int manufacturer_data_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set whether the device name should be included in advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Sets whether the device name should be included in advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] include_name Whether the device name should be included - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_set_advertising_device_name(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, bool include_name); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set whether the transmission power level should be included in advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Sets whether the transmission power level should be included in advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] include_tx_power Whether the transmission power level should be included - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_set_advertising_tx_power_level(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, bool include_tx_power); + /** * @deprecated Deprecated since 2.3.1 * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Unset the data to be advertised or responded to scan request from LE scanning device. + * @brief Unsets the data to be advertised or responded to scan request from LE scanning device. * @since_tizen 2.3 - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] data_type The data type to be removed from selected packet - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_add_advertising_data() * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_remove_advertising_data(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, bt_adapter_le_packet_data_type_e data_type) TIZEN_DEPRECATED_API; + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Clear all data to be advertised or responded to scan request from LE scanning device. + * @brief Clears all data to be advertised or responded to scan request from LE scanning device. * @since_tizen 2.3 - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type to be cleared - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_add_advertising_data() */ int bt_adapter_le_clear_advertising_data(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type); + /** * @deprecated Deprecated since 2.3.1 * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Start advertising with passed advertiser and advertising parameters. + * @brief Starts advertising with passed advertiser and advertising parameters. + * @details Once Bluetooth advertising is started, nearby Bluetooth LE(Low Energy) supported devices can know this device's existence. + * And one of them can make a connection request, if it is allowed. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @details Once Bluetooth advertising is started, nearby Bluetooth LE(Low Energy) supported - * devices can know this device's existence. And one of them can make a connection request, - * if it is allowed. - * * @param[in] advertiser The handle of advertiser * @param[in] adv_params The parameters of advertising \n - * If NULL is passed, default values which are defined in driver / controller are used. + * If NULL is passed, default values which are defined in driver / controller are used * @param[in] cb The callback to report the result of this function * @param[in] user_data The user data to be passed when callback is called - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post This function invokes bt_adapter_le_advertising_state_changed_cb(). - * * @see bt_adapter_le_stop_advertising() * @see bt_adapter_le_advertising_state_changed_cb() */ int bt_adapter_le_start_advertising(bt_advertiser_h advertiser, bt_adapter_le_advertising_params_s *adv_params, bt_adapter_le_advertising_state_changed_cb cb, void *user_data) TIZEN_DEPRECATED_API; + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Stops the advertising. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] advertiser The handle of advertiser - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The advertising must be going on with bt_adapter_le_start_advertising_new(). * @post This function invokes bt_adapter_le_advertising_state_changed_cb(). - * * @see bt_adapter_le_start_advertising_new() * @see bt_adapter_le_advertising_state_changed_cb() */ int bt_adapter_le_stop_advertising(bt_advertiser_h advertiser); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Start advertising with passed advertiser and advertising parameters. + * @brief Starts advertising with passed advertiser and advertising parameters. + * @details Once Bluetooth advertising is started, nearby Bluetooth LE(Low Energy) supported devices can know this device's existence. + * And one of them can make a connection request, if it is allowed. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @details Once Bluetooth advertising is started, nearby Bluetooth LE(Low Energy) supported - * devices can know this device's existence. And one of them can make a connection request, - * if it is allowed. - * * @param[in] advertiser The handle of advertiser * @param[in] cb The callback to report the result of this function * @param[in] user_data The user data to be passed when callback is called - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post This function invokes bt_adapter_le_advertising_state_changed_cb(). - * * @see bt_adapter_le_stop_advertising() * @see bt_adapter_le_advertising_state_changed_cb() */ int bt_adapter_le_start_advertising_new(bt_advertiser_h advertiser, bt_adapter_le_advertising_state_changed_cb cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set advertising mode to control the advertising power and latency. + * @brief Sets advertising mode to control the advertising power and latency. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] advertiser The handle of advertiser * @param[in] mode The mode of advertising - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_start_advertising_new() */ int bt_adapter_le_set_advertising_mode(bt_advertiser_h advertiser, bt_adapter_le_advertising_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set whether the advertising type should be connectable or non-connectable + * @brief Sets whether the advertising type should be connectable or non-connectable. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] advertiser The handle of advertiser * @param[in] connectable The type of advertising - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_start_advertising_new() */ int bt_adapter_le_set_advertising_connectable(bt_advertiser_h advertiser, bool connectable); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Sets Bluetooth LE scan mode + * @brief Sets Bluetooth LE scan mode. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] scan_mode The scan mode - * - * @return 0 on success, otherwise a negative error value. + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_ENABLED Adapter is not enabled - * @retval #BT_ERROR_INVALID_PARAM Parameter is invalid + * @retval #BT_ERROR_INVALID_PARAMETER Parameter is invalid * @retval #BT_ERROR_PERMISSION_DENIED Permission denied * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local bluetooth must be #BT_ADAPTER_ENABLED. @@ -1615,32 +1494,29 @@ int bt_adapter_le_set_advertising_connectable(bt_advertiser_h advertiser, bool c */ int bt_adapter_le_set_scan_mode(bt_adapter_le_scan_mode_e scan_mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Creates a bond with a remote Bluetooth device, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks A bond can be destroyed by bt_device_destroy_bond().\n - * The bonding request can be cancelled by bt_device_cancel_bonding(). - * + * The bonding request can be cancelled by bt_device_cancel_bonding(). * @param[in] remote_address The address of the remote Bluetooth device with which the bond should be created - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The remote device must be discoverable with bt_adapter_start_device_discovery(). * @post This function invokes bt_device_bond_created_cb(). - * * @see bt_adapter_start_device_discovery() * @see bt_device_bond_created_cb() * @see bt_device_cancel_bonding() @@ -1650,26 +1526,24 @@ int bt_adapter_le_set_scan_mode(bt_adapter_le_scan_mode_e scan_mode); */ int bt_device_create_bond(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Cancels the bonding process. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks Use this function when the remote Bluetooth device is not responding to the - * bond request or you wish to cancel the bonding request. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_IN_PROGRESS Operation not in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * bond request or you wish to cancel the bonding request. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_IN_PROGRESS Operation not in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The creating a bond must be in progress by bt_device_create_bond(). - * * @see bt_device_create_bond() * @see bt_device_bond_created_cb() * @see bt_device_set_bond_created_cb() @@ -1677,30 +1551,28 @@ int bt_device_create_bond(const char *remote_address); */ int bt_device_cancel_bonding(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Destroys the bond, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address The address of the remote Bluetooth device to remove bonding - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The bond with the remote device must be created with bt_device_create_bond(). * @post This function invokes bt_device_bond_destroyed_cb(). - * * @see bt_device_create_bond() * @see bt_device_bond_destroyed_cb() * @see bt_device_set_bond_destroyed_cb() @@ -1708,59 +1580,54 @@ int bt_device_cancel_bonding(void); */ int bt_device_destroy_bond(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Sets an alias for the bonded device. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address The address of the remote Bluetooth device * @param[in] alias The alias of the remote Bluetooth device - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The bond with the remote device must be created with bt_device_create_bond(). - * * @see bt_device_create_bond() */ int bt_device_set_alias(const char *remote_address, const char *alias); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Sets the authorization of a bonded device, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks Once a device is authorized, you don't need to receive a confirmation. - * * @param[in] remote_address The address of the remote Bluetooth device to authorize * @param[in] authorization_state The Bluetooth authorization state - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The bond with the remote device must be created with bt_device_create_bond(). * @post bt_device_authorization_changed_cb() will be invoked. - * * @see bt_device_create_bond() * @see bt_device_authorization_changed_cb() * @see bt_device_set_authorization_changed_cb() @@ -1768,34 +1635,31 @@ int bt_device_set_alias(const char *remote_address, const char *alias); */ int bt_device_set_authorization(const char *remote_address, bt_device_authorization_e authorization_state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Starts the search for services supported by the specified device, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks If creating a bond succeeds, which means bt_device_bond_created_cb() is called with result #BT_ERROR_NONE, - * then you don't need to run this function.\n - * The service search takes a couple of seconds to complete normally. \n - * + * then you don't need to run this function.\n + * The service search takes a couple of seconds to complete normally. * @param[in] remote_address The address of the remote Bluetooth device whose services need to be checked - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_SERVICE_SEARCH_FAILED Service search failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_SERVICE_SEARCH_FAILED Service search failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The remote device must be discoverable with bt_adapter_start_device_discovery(). * @pre The bond with the remote device must be created with bt_device_create_bond(). * @post This function invokes bt_device_service_searched_cb(). - * * @see bt_adapter_start_device_discovery() * @see bt_device_create_bond() * @see bt_device_bond_created_cb() @@ -1805,6 +1669,7 @@ int bt_device_set_authorization(const char *remote_address, bt_device_authorizat */ int bt_device_start_service_search(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Gets the connected profiles. @@ -1812,19 +1677,20 @@ int bt_device_start_service_search(const char *remote_address); * @param[in] remote_address The address of the remote device * @param[in] callback The callback function to invoke * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post bt_device_connected_profile() will be invoked. * @see bt_device_connected_profile() */ int bt_device_foreach_connected_profiles(const char *remote_address, bt_device_connected_profile callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Gets the profile connected status. @@ -1832,125 +1698,130 @@ int bt_device_foreach_connected_profiles(const char *remote_address, bt_device_c * @param[in] remote_address The address of the remote device * @param[in] bt_profile Wish to know bt_profile * @param[out] connected_status The connected status - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. */ int bt_device_is_profile_connected(const char *remote_address, bt_profile_e bt_profile, bool *connected_status); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Updates a LE connection mode + * @brief Updates a LE connection mode. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address The address of the remote Bluetooth device * @param[in] mode The LE connection mode - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_device_update_le_connection_mode(const char *remote_address, bt_device_le_connection_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the bond creates. + * @brief Registers a callback function to be invoked when the bond creates. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_device_bond_created_cb() will be invoked. + * @post bt_device_bond_created_cb() will be invoked. * @see bt_initialize() * @see bt_device_bond_created_cb() * @see bt_device_unset_bond_created_cb() */ int bt_device_set_bond_created_cb(bt_device_bond_created_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_bond_created_cb() */ int bt_device_unset_bond_created_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the bond destroys. + * @brief Registers a callback function to be invoked when the bond destroys. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_device_bond_destroyed_cb() will be invoked. + * @post bt_device_bond_destroyed_cb() will be invoked. * @see bt_initialize() * @see bt_device_bond_destroyed_cb() * @see bt_device_unset_bond_destroyed_cb() */ int bt_device_set_bond_destroyed_cb(bt_device_bond_destroyed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_bond_destroyed_cb() */ int bt_device_unset_bond_destroyed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the authorization of device changes. + * @brief Registers a callback function to be invoked when the authorization of device changes. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_device_authorization_changed_cb() will be invoked. + * @post bt_device_authorization_changed_cb() will be invoked. * @see bt_initialize() * @see bt_device_authorization_changed_cb() * @see bt_device_set_authorization_changed_cb() @@ -1958,68 +1829,72 @@ int bt_device_unset_bond_destroyed_cb(void); */ int bt_device_set_authorization_changed_cb(bt_device_authorization_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_authorization_changed_cb() */ int bt_device_unset_authorization_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the process of service search finishes. + * @brief Registers a callback function to be invoked when the process of service search finishes. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_device_service_searched_cb() will be invoked. + * @post bt_device_service_searched_cb() will be invoked. * @see bt_initialize() * @see bt_device_service_searched_cb() * @see bt_device_unset_service_searched_cb() */ int bt_device_set_service_searched_cb(bt_device_service_searched_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_service_searched_cb() */ int bt_device_unset_service_searched_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the connection state is changed. + * @brief Registers a callback function to be invoked when the connection state is changed. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_device_connection_state_changed_cb() will be invoked. * @see bt_initialize() @@ -2028,71 +1903,69 @@ int bt_device_unset_service_searched_cb(void); */ int bt_device_set_connection_state_changed_cb(bt_device_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function to be invoked when the connection state is changed. + * @brief Unregisters the callback function to be invoked when the connection state is changed. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_connection_state_changed_cb() */ int bt_device_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Registers a rfcomm server socket with a specific UUID. + * @brief Registers a RFCOMM server socket with a specific UUID. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks A socket can be destroyed by bt_socket_destroy_rfcomm(). - * * @param[in] service_uuid The UUID of service to provide * @param[out] socket_fd The file descriptor of socket to listen - * @return 0 on success, otherwise a negative error value. - * - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * * @see bt_socket_listen_and_accept_rfcomm() * @see bt_socket_destroy_rfcomm() */ int bt_socket_create_rfcomm(const char *service_uuid, int *socket_fd); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Removes the rfcomm server socket which was created using bt_socket_create_rfcomm(). + * @brief Removes the RFCOMM server socket which was created using bt_socket_create_rfcomm(). * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @remarks If callback function bt_socket_connection_state_changed_cb() is set and the remote Bluetooth device is connected, - * then bt_socket_connection_state_changed_cb() will be called when this function is finished successfully. - * + * then bt_socket_connection_state_changed_cb() will be called when this function is finished successfully. * @param[in] socket_fd The file descriptor of socket (which was created using bt_socket_create_rfcomm()) to destroy - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The socket must be created with bt_socket_create_rfcomm(). * @post If callback function bt_socket_connection_state_changed_cb() is set and the remote Bluetooth device is connected, - * then bt_socket_connection_state_changed_cb() will be called. + * then bt_socket_connection_state_changed_cb() will be called. * @see bt_socket_create_rfcomm() * @see bt_socket_connection_state_changed_cb() * @see bt_socket_set_connection_state_changed_cb() @@ -2100,29 +1973,30 @@ int bt_socket_create_rfcomm(const char *service_uuid, int *socket_fd); */ int bt_socket_destroy_rfcomm(int socket_fd); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Starts listening on passed rfcomm socket and accepts connection requests. + * @brief Starts listening on passed RFCOMM socket and accepts connection requests. + * @details Pop-up is shown automatically when a RFCOMM connection is requested. + * bt_socket_connection_state_changed_cb() will be called with + * #BT_SOCKET_CONNECTED if you click "yes" and connection is finished successfully. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details Pop-up is shown automatically when a RFCOMM connection is requested. - * bt_socket_connection_state_changed_cb() will be called with - * #BT_SOCKET_CONNECTED if you click "yes" and connection is finished successfully. * @param[in] socket_fd The file descriptor of socket on which start to listen * @param[in] max_pending_connections The maximum number of pending connections - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The socket must be created with bt_socket_create_rfcomm(). * @post If callback function bt_socket_connection_state_changed_cb() is set, - * then bt_socket_connection_state_changed_cb() will be called when the remote Bluetooth device is connected. + * then bt_socket_connection_state_changed_cb() will be called when the remote Bluetooth device is connected. * @see bt_socket_create_rfcomm() * @see bt_socket_connection_state_changed_cb() * @see bt_socket_set_connection_state_changed_cb() @@ -2130,32 +2004,29 @@ int bt_socket_destroy_rfcomm(int socket_fd); */ int bt_socket_listen_and_accept_rfcomm(int socket_fd, int max_pending_connections); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE * @brief Connects to a specific RFCOMM based service on a remote Bluetooth device UUID, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks A connection can be disconnected by bt_socket_disconnect_rfcomm(). - * * @param[in] remote_address The address of the remote Bluetooth device * @param[in] service_uuid The UUID of service provided by the remote Bluetooth device - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The remote device must be discoverable with bt_adapter_start_device_discovery(). * @pre The bond with the remote device must be created with bt_device_create_bond(). * @post This function invokes bt_socket_connection_state_changed_cb(). - * * @see bt_device_create_bond() * @see bt_adapter_start_device_discovery() * @see bt_device_start_service_search() @@ -2166,70 +2037,68 @@ int bt_socket_listen_and_accept_rfcomm(int socket_fd, int max_pending_connection */ int bt_socket_connect_rfcomm(const char *remote_address, const char *service_uuid); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE * @brief Disconnects the RFCOMM connection with the given file descriptor of connected socket. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] socket_fd The file descriptor of socket to close which was received using bt_socket_connection_state_changed_cb(). - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] socket_fd The file descriptor of socket to close which was received using bt_socket_connection_state_changed_cb() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The connection must be established. - * * @see bt_socket_connection_state_changed_cb() * @see bt_socket_set_connection_state_changed_cb() * @see bt_socket_unset_connection_state_changed_cb() */ int bt_socket_disconnect_rfcomm(int socket_fd); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE * @brief Sends data to the connected device. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @remark The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. * @param[in] socket_fd The file descriptor of connected socket which was received using bt_socket_connection_state_changed_cb() * @param[in] data The data to be sent * @param[in] length The length of data to be sent - * - * @return the number of bytes written (zero indicates nothing was written). - * @retval On error, -1 is returned, and errno is set appropriately. See write 2 man page. - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * @exception BT_ERROR_PERMISSION_DENIED Permission denied - * @exception BT_ERROR_AGAIN Resource temporarily unavailable - * + * @return The number of bytes written (zero indicates nothing was written) + * @retval On error, @c -1 is returned, and errno is set appropriately. See write 2 man page. + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @exception BT_ERROR_PERMISSION_DENIED Permission denied + * @exception BT_ERROR_AGAIN Resource temporarily unavailable * @pre The connection must be established. - * * @see bt_socket_connection_state_changed_cb() * @see bt_socket_set_connection_state_changed_cb() * @see bt_socket_unset_connection_state_changed_cb() */ int bt_socket_send_data(int socket_fd, const char *data, int length); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Register a callback function that will be invoked when you receive data. + * @brief Registers a callback function that will be invoked when you receive data. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_socket_data_received_cb() will be invoked. + * @post bt_socket_data_received_cb() will be invoked. * @see bt_initialize() * @see bt_socket_data_received_cb() * @see bt_socket_set_data_received_cb() @@ -2237,15 +2106,16 @@ int bt_socket_send_data(int socket_fd, const char *data, int length); */ int bt_socket_set_data_received_cb(bt_socket_data_received_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_socket_data_received_cb() @@ -2253,18 +2123,19 @@ int bt_socket_set_data_received_cb(bt_socket_data_received_cb callback, void *us */ int bt_socket_unset_data_received_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Register a callback function that will be invoked when a RFCOMM connection is requested. + * @brief Registers a callback function that will be invoked when a RFCOMM connection is requested. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_socket_connection_requested_cb() will be invoked. * @see bt_initialize() @@ -2272,34 +2143,36 @@ int bt_socket_unset_data_received_cb(void); */ int bt_socket_set_connection_requested_cb(bt_socket_connection_requested_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Unregisters the callback function. + * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE + * @brief Unregisters the callback function. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized with bt_initialize(). - * @see bt_initialize() - * @see bt_socket_set_connection_requested_cb() - * @see bt_socket_connection_requested_cb() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized with bt_initialize(). + * @see bt_initialize() + * @see bt_socket_set_connection_requested_cb() + * @see bt_socket_connection_requested_cb() */ int bt_socket_unset_connection_requested_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Register a callback function that will be invoked when the connection state changes. + * @brief Registers a callback function that will be invoked when the connection state changes. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_socket_connection_state_changed_cb() will be invoked. * @see bt_initialize() @@ -2308,15 +2181,16 @@ int bt_socket_unset_connection_requested_cb(void); */ int bt_socket_set_connection_state_changed_cb(bt_socket_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_socket_connection_state_changed_cb() @@ -2324,49 +2198,52 @@ int bt_socket_set_connection_state_changed_cb(bt_socket_connection_state_changed */ int bt_socket_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Initializes the Bluetooth OPP server requested by bt_opp_server_connection_requested_cb(). - * @since_tizen 2.3 * @details No popup appears when an OPP connection is requested from a remote device. - * Instead, @a connection_requested_cb() will be called. - * At that time, you can call either bt_opp_server_accept() or bt_opp_server_reject(). + * Instead, @a connection_requested_cb() will be called. + * At that time, you can call either bt_opp_server_accept() or bt_opp_server_reject(). + * @since_tizen 2.3 * @remarks This function must be called to start Bluetooth OPP server. \n - * You must free all resources of the Bluetooth service by calling bt_opp_server_deinitialize() if Bluetooth OPP service is no longer needed. - * @param[in] destination The destination path - * @param[in] connection_requested_cb The callback called when an OPP connection is requested + * You must free all resources of the Bluetooth service by calling bt_opp_server_deinitialize() if Bluetooth OPP service is no longer needed. + * @param[in] destination The destination path + * @param[in] connection_requested_cb The callback called when an OPP connection is requested * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_connection_requested_cb() - * @see bt_opp_server_deinitialize() - * @see bt_opp_server_accept() - * @see bt_opp_server_reject() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_connection_requested_cb() + * @see bt_opp_server_deinitialize() + * @see bt_opp_server_accept() + * @see bt_opp_server_reject() */ int bt_opp_server_initialize_by_connection_request(const char *destination, bt_opp_server_connection_requested_cb connection_requested_cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Deinitializes the Bluetooth OPP server. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_deinitialize() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_deinitialize() */ int bt_opp_server_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Accepts the push request from the remote device. @@ -2374,184 +2251,191 @@ int bt_opp_server_deinitialize(void); * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @remarks If you initialize OPP server by bt_opp_server_initialize_by_connection_request(), then name is ignored. - * You can cancel the pushes by bt_opp_server_cancel_transfer() with transfer_id. - * @param[in] progress_cb The callback called when a file is being transferred - * @param[in] finished_cb The callback called when a transfer is finished - * @param[in] name The name to store. This can be NULL if you initialize OPP server by bt_opp_server_initialize_by_connection_request(). + * You can cancel the pushes by bt_opp_server_cancel_transfer() with transfer_id. + * @param[in] progress_cb The callback called when a file is being transferred + * @param[in] finished_cb The callback called when a transfer is finished + * @param[in] name The name to store. This can be NULL if you initialize OPP server by bt_opp_server_initialize_by_connection_request() * @param[in] user_data The user data to be passed to the callback function - * @param[out] transfer_id The ID of transfer - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_reject() + * @param[out] transfer_id The ID of transfer + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_reject() */ int bt_opp_server_accept(bt_opp_server_transfer_progress_cb progress_cb, bt_opp_server_transfer_finished_cb finished_cb, const char *name, void *user_data, int *transfer_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Rejects the push request from the remote device. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_accept() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_accept() */ int bt_opp_server_reject(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Cancels the transfer. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] transfer_id The ID of transfer - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_accept() + * @param[in] transfer_id The ID of transfer + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_accept() */ int bt_opp_server_cancel_transfer(int transfer_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Sets the destination path of file to be pushed. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] destination The destination path of file to be pushed - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @param[in] destination The destination path of file to be pushed + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_opp_server_set_destination(const char *destination); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Initializes the Bluetooth OPP client. * @since_tizen 2.3 * @remarks This function must be called before Bluetooth OPP client starts. \n - * You must free all resources of the Bluetooth service by calling bt_opp_client_deinitialize() - * if Bluetooth OPP service is no longer needed. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_client_deinitialize() + * You must free all resources of the Bluetooth service by calling bt_opp_client_deinitialize() + * if Bluetooth OPP service is no longer needed. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_client_deinitialize() */ int bt_opp_client_initialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Deinitializes the Bluetooth OPP client. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_client_initialize() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_client_initialize() */ int bt_opp_client_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Adds file to be pushed. * @since_tizen 2.3 - * @param[in] file The path of file to be pushed - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_client_clear_files() - * @see bt_opp_client_push_files() + * @param[in] file The path of file to be pushed + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_client_clear_files() + * @see bt_opp_client_push_files() */ int bt_opp_client_add_file(const char *file); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Adds file to be pushed. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_client_add_file() - * @see bt_opp_client_push_files() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_client_add_file() + * @see bt_opp_client_push_files() */ int bt_opp_client_clear_files(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Pushes the file to the remote device, asynchronously. + * @details At first, bt_opp_client_push_responded_cb() will be called when OPP server responds to the push request. + * After connection is established, bt_opp_client_push_progress_cb() will be called repeatedly until a file is transferred completely. + * If you send several files, then bt_opp_client_push_progress_cb() with another file will be called repeatedly until the file is transferred completely. + * bt_opp_client_push_finished_cb() will be called when the push request is finished. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details At first, bt_opp_client_push_responded_cb() will be called when OPP server responds to the push request. - * After connection is established, bt_opp_client_push_progress_cb() will be called repeatedly until a file is transferred completely. - * If you send several files, then bt_opp_client_push_progress_cb() with another file will be called repeatedly until the file is transferred completely. - * bt_opp_client_push_finished_cb() will be called when the push request is finished. * @param[in] remote_address The remote address - * @param[in] responded_cb The callback called when OPP server responds to the push request - * @param[in] progress_cb The callback called when each file is being transferred - * @param[in] finished_cb The callback called when the push request is finished + * @param[in] responded_cb The callback called when OPP server responds to the push request + * @param[in] progress_cb The callback called when each file is being transferred + * @param[in] finished_cb The callback called when the push request is finished * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_opp_client_initialize() * @see bt_opp_client_cancel_push */ -int bt_opp_client_push_files(const char *remote_address, - bt_opp_client_push_responded_cb responded_cb, - bt_opp_client_push_progress_cb progress_cb, - bt_opp_client_push_finished_cb finished_cb, - void *user_data); +int bt_opp_client_push_files(const char *remote_address, bt_opp_client_push_responded_cb responded_cb, + bt_opp_client_push_progress_cb progress_cb, bt_opp_client_push_finished_cb finished_cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE @@ -2559,75 +2443,76 @@ int bt_opp_client_push_files(const char *remote_address, * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre bt_opp_client_push_files() must be called. - * @post bt_opp_client_push_finished_cb() will be invoked with result #BT_ERROR_CANCELLED, - * which is a parameter of bt_opp_client_push_files(). + * @post bt_opp_client_push_finished_cb() will be invoked with result #BT_ERROR_CANCELLED, which is a parameter of bt_opp_client_push_files(). * @see bt_opp_client_initialize() * @see bt_opp_client_push_files() */ int bt_opp_client_cancel_push(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * @brief Initializes the Bluetooth HID(Human Interface Device) Host. * @since_tizen 2.3 * @remarks This function must be called before Bluetooth HID Host starts. \n - * You must free all resources of the Bluetooth service by calling bt_hid_host_deinitialize() - * if Bluetooth HID Host service is no longer needed. - * @param[in] connection_cb The callback called when the connection state is changed + * You must free all resources of the Bluetooth service by calling bt_hid_host_deinitialize() if Bluetooth HID Host service is no longer needed. + * @param[in] connection_cb The callback called when the connection state is changed * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() - * @see bt_hid_host_deinitialize() + * @see bt_hid_host_deinitialize() */ int bt_hid_host_initialize(bt_hid_host_connection_state_changed_cb connection_cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * @brief Deinitializes the Bluetooth HID(Human Interface Device) Host. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth HID service must be initialized with bt_hid_host_initialize(). - * @see bt_hid_host_initialize() + * @see bt_hid_host_initialize() */ int bt_hid_host_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * @brief Connects the remote device with the HID(Human Interface Device) service, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The local device must be bonded with the remote device by bt_device_create_bond(). * @pre The Bluetooth HID service must be initialized with bt_hid_host_initialize(). * @post bt_hid_host_connection_state_changed_cb() will be invoked. @@ -2636,23 +2521,24 @@ int bt_hid_host_deinitialize(void); */ int bt_hid_host_connect(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * @brief Disconnects the remote device with the HID(Human Interface Device) service, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected by bt_hid_host_connect(). * @post bt_hid_host_connection_state_changed_cb() will be invoked. * @see bt_hid_host_connect() @@ -2660,59 +2546,61 @@ int bt_hid_host_connect(const char *remote_address); */ int bt_hid_host_disconnect(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Initializes the Bluetooth profiles related with audio. * @since_tizen 2.3 * @remarks This function must be called before Bluetooth profiles related with audio starts. \n - * You must free all resources of the this service by calling bt_audio_deinitialize() - * if Bluetooth profiles related with audio service is no longer needed. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * You must free all resources of the this service by calling bt_audio_deinitialize() if Bluetooth profiles related with audio service is no longer needed. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_audio_deinitialize() */ int bt_audio_initialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Deinitializes the Bluetooth profiles related with audio. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_audio_initialize(). * @see bt_audio_initialize() */ int bt_audio_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Connects the remote device with the given audio profile, asynchronously. + * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and connection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice + * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is connected and #BT_AUDIO_PROFILE_TYPE_A2DP is connected. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and connection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice - * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is connected and #BT_AUDIO_PROFILE_TYPE_A2DP is connected. - * @param[in] remote_address The remote address - * @param[in] type The type of audio profile - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - + * @param[in] remote_address The remote address + * @param[in] type The type of audio profile + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_audio_initialize(). * @pre The local device must be bonded with the remote device by bt_device_create_bond(). * @post bt_audio_connection_state_changed_cb() will be invoked. @@ -2721,25 +2609,26 @@ int bt_audio_deinitialize(void); */ int bt_audio_connect(const char *remote_address, bt_audio_profile_type_e type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Disconnects the remote device with the given audio profile, asynchronously. + * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and disconnection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice + * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is disconnected and #BT_AUDIO_PROFILE_TYPE_A2DP is disconnected. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and disconnection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice - * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is disconnected and #BT_AUDIO_PROFILE_TYPE_A2DP is disconnected. - * @param[in] remote_address The remote address - * @param[in] type The type of audio profile - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @param[in] type The type of audio profile + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected by bt_audio_connect(). * @post bt_audio_connection_state_changed_cb() will be invoked. * @see bt_audio_connect() @@ -2747,33 +2636,35 @@ int bt_audio_connect(const char *remote_address, bt_audio_profile_type_e type); */ int bt_audio_disconnect(const char *remote_address, bt_audio_profile_type_e type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE - * @brief Registers a callback function that will be invoked when the connection state is changed. + * @brief Registers a callback function that will be invoked when the connection state is changed. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_audio_initialize(). * @see bt_audio_initialize() * @see bt_audio_connection_state_changed_cb() */ int bt_audio_set_connection_state_changed_cb(bt_audio_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE - * @brief Unregisters a callback function that will be invoked when the connection state is changed. + * @brief Unregisters a callback function that will be invoked when the connection state is changed. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_audio_initialize(). * @see bt_audio_initialize() * @see bt_audio_connection_state_changed_cb() @@ -2781,183 +2672,191 @@ int bt_audio_set_connection_state_changed_cb(bt_audio_connection_state_changed_c */ int bt_audio_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE * @brief Initializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service. * @since_tizen 2.4 * @remarks This function must be called before any other AVRCP target functions are called. \n - * You must free all resources of the this service by calling bt_avrcp_target_deinitialize() - * if Bluetooth AVRCP service is no longer needed. + * You must free all resources of the this service by calling bt_avrcp_target_deinitialize() if Bluetooth AVRCP service is no longer needed. * @param[in] callback The callback function called when the connection state is changed * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_avrcp_target_deinitialize() */ int bt_avrcp_target_initialize(bt_avrcp_target_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE * @brief Deinitializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service. * @since_tizen 2.4 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_target_initialize(). * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the equalizer state to the remote device. + * @brief Notifies the equalizer state to the remote device. * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] state The state of equalizer - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_equalizer_state(bt_avrcp_equalizer_state_e state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the repeat mode to the remote device. + * @brief Notifies the repeat mode to the remote device. * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The repeat mode - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_repeat_mode(bt_avrcp_repeat_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the shuffle mode to the remote device. + * @brief Notifies the shuffle mode to the remote device. * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The repeat mode - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_shuffle_mode(bt_avrcp_shuffle_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the scan mode to the remote device. + * @brief Notifies the scan mode to the remote device. * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The scan mode - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_scan_mode(bt_avrcp_scan_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the player state to the remote device. + * @brief Notifies the player state to the remote device. * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] state The player state - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_player_state(bt_avrcp_player_state_e state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the current position of song to the remote device. + * @brief Notifies the current position of song to the remote device. * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] position The current position in milliseconds - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_position(unsigned int position); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the track to the remote device. + * @brief Notifies the track to the remote device. * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -2968,34 +2867,35 @@ int bt_avrcp_target_notify_position(unsigned int position); * @param[in] track_num The track number * @param[in] total_tracks The number of all tracks * @param[in] duration The duration of track in milliseconds - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_track(const char *title, const char *artist, const char *album, const char *genre, unsigned int track_num, unsigned int total_tracks, unsigned int duration); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the equalizer state is changed by the remote control device. + * @brief Registers a callback function that will be invoked when the equalizer state is changed. * @since_tizen 2.4 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3003,15 +2903,16 @@ int bt_avrcp_target_notify_track(const char *title, const char *artist, const ch */ int bt_avrcp_set_equalizer_state_changed_cb(bt_avrcp_equalizer_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the equalizer state is changed by the remote control device. + * @brief Unregisters a callback function that will be invoked when the equalizer state is changed. * @since_tizen 2.4 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3019,18 +2920,19 @@ int bt_avrcp_set_equalizer_state_changed_cb(bt_avrcp_equalizer_state_changed_cb */ int bt_avrcp_unset_equalizer_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the repeat mode is changed by the remote control device. + * @brief Registers a callback function that will be invoked when the repeat mode is changed. * @since_tizen 2.4 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3038,15 +2940,16 @@ int bt_avrcp_unset_equalizer_state_changed_cb(void); */ int bt_avrcp_set_repeat_mode_changed_cb(bt_avrcp_repeat_mode_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the repeat mode is changed by the remote control device. + * @brief Unregisters a callback function that will be invoked when the repeat mode is changed. * @since_tizen 2.4 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3054,18 +2957,19 @@ int bt_avrcp_set_repeat_mode_changed_cb(bt_avrcp_repeat_mode_changed_cb callback */ int bt_avrcp_unset_repeat_mode_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the shuffle mode is changed by the remote control device. + * @brief Registers a callback function that will be invoked when the shuffle mode is changed. * @since_tizen 2.4 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3073,15 +2977,16 @@ int bt_avrcp_unset_repeat_mode_changed_cb(void); */ int bt_avrcp_set_shuffle_mode_changed_cb(bt_avrcp_shuffle_mode_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed by the remote control device. + * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed. * @since_tizen 2.4 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3089,18 +2994,19 @@ int bt_avrcp_set_shuffle_mode_changed_cb(bt_avrcp_shuffle_mode_changed_cb callba */ int bt_avrcp_unset_shuffle_mode_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the scan mode is changed by the remote control device. + * @brief Registers a callback function that will be invoked when the scan mode is changed. * @since_tizen 2.4 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3108,15 +3014,16 @@ int bt_avrcp_unset_shuffle_mode_changed_cb(void); */ int bt_avrcp_set_scan_mode_changed_cb(bt_avrcp_scan_mode_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the scan mode is changed by the remote control device. + * @brief Unregisters a callback function that will be invoked when the scan mode is changed. * @since_tizen 2.4 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3124,34 +3031,36 @@ int bt_avrcp_set_scan_mode_changed_cb(bt_avrcp_scan_mode_changed_cb callback, vo */ int bt_avrcp_unset_scan_mode_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the song position is changed by the remote target device. + * @brief Registers a callback function that will be invoked when the song position is changed. * @since_tizen 3.0 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() - * @see bt_avrcp_unset_position_changed_cb() + * @see bt_avrcp_set_position_changed_cb() */ int bt_avrcp_set_position_changed_cb(bt_avrcp_position_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the song position is changed by the remote target device. + * @brief Unregisters a callback function that will be invoked when the song position is changed. * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3159,18 +3068,19 @@ int bt_avrcp_set_position_changed_cb(bt_avrcp_position_changed_cb callback, void */ int bt_avrcp_unset_position_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the Play status is changed by the remote target device. + * @brief Registers a callback function that will be invoked when the Play status is changed. * @since_tizen 3.0 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3178,33 +3088,36 @@ int bt_avrcp_unset_position_changed_cb(void); */ int bt_avrcp_set_play_status_changed_cb(bt_avrcp_play_status_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the Play status is changed by the remote target device. + * @brief Unregisters a callback function that will be invoked when the Play status is changed. * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized by bt_initialize(). - * @see bt_initialize() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). + * @see bt_avrcp_target_initialize() + * @see bt_avrcp_control_initialize() * @see bt_avrcp_unset_play_status_changed_cb() */ int bt_avrcp_unset_play_status_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the track metadata is changed by the remote target device. + * @brief Registers a callback function that will be invoked when the track metadata is changed. * @since_tizen 3.0 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3212,15 +3125,16 @@ int bt_avrcp_unset_play_status_changed_cb(void); */ int bt_avrcp_set_track_info_changed_cb(bt_avrcp_track_info_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the track metadata is changed by the remote target device. + * @brief Unregisters a callback function that will be invoked when the track metadata is changed. * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3228,344 +3142,368 @@ int bt_avrcp_set_track_info_changed_cb(bt_avrcp_track_info_changed_cb callback, */ int bt_avrcp_unset_track_info_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Initializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) controller service. * @since_tizen 3.0 * @remarks This function must be called before any other AVRCP controller functions are called. \n - * You must free all resources of the this service by calling bt_avrcp_control_deinitialize() - * if Bluetooth AVRCP service is no longer needed. + * You must free all resources of the this service by calling bt_avrcp_control_deinitialize() + * if Bluetooth AVRCP service is no longer needed. * @param[in] callback The callback function called when the connection state is changed * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_avrcp_control_deinitialize() */ int bt_avrcp_control_initialize(bt_avrcp_control_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Deinitializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) controller service. * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() */ int bt_avrcp_control_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Connects the AVRCP (Audio/Video Remote Control Profile) target device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @param[in] remote_address The remote address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() */ int bt_avrcp_control_connect(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Disconnects from the AVRCP (Audio/Video Remote Control Profile) target device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @param[in] remote_address The remote address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() * @see bt_avrcp_control_connect() */ int bt_avrcp_control_disconnect(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Sends a command to the target device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] cmd The commands, one of: Play, Pause, Next, Rewind. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @param[in] cmd The commands, one of: Play, Pause, Next, Rewind + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() * @see bt_avrcp_control_connect() */ int bt_avrcp_control_send_player_command(bt_avrcp_player_command_e cmd); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Sends the equalizer state change request to the remote device. + * @brief Sends the equalizer state change request to the remote device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] state The new equalizer state, one of: ON, OFF - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_set_equalizer_state(bt_avrcp_equalizer_state_e state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the the equalizer state of the remote device. + * @brief Gets the the equalizer state of the remote device. * @since_tizen 3.0 * @param[out] state The equalizer state, one of: ON, OFF - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_equalizer_state(bt_avrcp_equalizer_state_e *state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Sends the repeat change request to the remote device. + * @brief Sends the repeat change request to the remote device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The new repeat mode, one of: OFF, SINGLE, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_set_repeat_mode(bt_avrcp_repeat_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the repeat state of the remote device. + * @brief Gets the repeat state of the remote device. * @since_tizen 3.0 * @param[out] mode The repeat mode, one of: OFF, SINGLE, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_repeat_mode(bt_avrcp_repeat_mode_e *mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Sends the shuffle mode change request to the remote device. + * @brief Sends the shuffle mode change request to the remote device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The new shuffle mode, one of: OFF, GROUP, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_set_shuffle_mode(bt_avrcp_shuffle_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the shuffle modee of the remote device. + * @brief Gets the shuffle mode of the remote device. * @since_tizen 3.0 * @param[out] mode The shuffle mode, one of: OFF, GROUP, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_shuffle_mode(bt_avrcp_shuffle_mode_e *mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Sends the scan mode change request to the remote device. + * @brief Sends the scan mode change request to the remote device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The new scan mode, one of: OFF, GROUP, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_set_scan_mode(bt_avrcp_scan_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the scan mode of the remote device. + * @brief Gets the scan mode of the remote device. * @since_tizen 3.0 * @param[out] mode The scan mode, one of: OFF, GROUP, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_scan_mode(bt_avrcp_scan_mode_e *mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the position of the song played by the remote device. + * @brief Gets the position of the song played by the remote device. * @since_tizen 3.0 - * @param[out] mode The position, in milliseconds - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[out] position The position, in milliseconds + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_position(unsigned int *position); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the play status of the remote device. + * @brief Gets the play status of the remote device. * @since_tizen 3.0 * @param[out] status The play status, one of: PLAYING, STOPPED... - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_play_status(bt_avrcp_player_state_e *status); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the metadata of the track played by the remote device. + * @brief Gets the metadata of the track played by the remote device. * @since_tizen 3.0 - * @remarks The @a track must be released using bt_avrcp_control_free_track_info() - * @param[out] track The track metadata. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a track must be released using bt_avrcp_control_free_track_info(). + * @param[out] track The track metadata + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_track_info(bt_avrcp_metadata_attributes_info_s **track); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Frees the track metadata. + * @brief Frees the track metadata. * @since_tizen 3.0 - * @param[in] track The track metadata. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * @pre track should point to valid metadata address. + * @param[in] track The track metadata + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre Track should point to valid metadata address. * @see bt_avrcp_control_get_track_info() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_free_track_info(bt_avrcp_metadata_attributes_info_s *track); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Registers an application that acts as the @a Sink role of HDP(Health Device Profile). @@ -3573,59 +3511,61 @@ int bt_avrcp_control_free_track_info(bt_avrcp_metadata_attributes_info_s *track) * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @remarks The @a app_id must be released with free() by you. - * @param[in] data_type The data type of MDEP. This value is defined in ISO/IEEE 11073-20601 spec. - * For example, pulse oximeter is 0x1004 and blood pressure monitor is 0x1007. - * @param[out] app_id The ID of application - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] data_type The data type of MDEP. This value is defined in ISO/IEEE 11073-20601 spec. + * For example, pulse oximeter is 0x1004 and blood pressure monitor is 0x1007 + * @param[out] app_id The ID of application + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @see bt_hdp_unregister_sink_app() */ int bt_hdp_register_sink_app(unsigned short data_type, char **app_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Unregisters the given application that acts as the @a Sink role of HDP(Health Device Profile). * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] app_id The ID of application - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] app_id The ID of application + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_hdp_register_sink_app() */ int bt_hdp_unregister_sink_app(const char *app_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Connects the remote device which acts as @a Source role, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @param[in] app_id The ID of application - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @param[in] app_id The ID of application + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Sink role of HDP must be registered with bt_hdp_register_sink_app(). * @pre The local device must be bonded with the remote device by bt_device_create_bond(). * @post bt_hdp_connected_cb() will be invoked. @@ -3635,25 +3575,26 @@ int bt_hdp_unregister_sink_app(const char *app_id); */ int bt_hdp_connect_to_source(const char *remote_address, const char *app_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Disconnects the remote device, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @param[in] channel The connected data channel - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @param[in] channel The connected data channel + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @post bt_hdp_disconnected_cb() will be invoked. * @see bt_hdp_set_connection_state_changed_cb() @@ -3661,24 +3602,25 @@ int bt_hdp_connect_to_source(const char *remote_address, const char *app_id); */ int bt_hdp_disconnect(const char *remote_address, unsigned int channel); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Sends the data to the remote device. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] channel The connected data channel - * @param[in] data The data to send - * @param[in] size The size of data to send (byte) - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] channel The connected data channel + * @param[in] data The data to send + * @param[in] size The size of data to send (byte) + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_hdp_data_received_cb() * @see bt_hdp_set_data_received_cb() @@ -3686,875 +3628,891 @@ int bt_hdp_disconnect(const char *remote_address, unsigned int channel); */ int bt_hdp_send_data(unsigned int channel, const char *data, unsigned int size); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Registers a callback function that will be invoked when the connection state is changed. + * @brief Registers a callback function that will be invoked when the connection state is changed. * @since_tizen 2.3 * @param[in] connected_cb The callback function called when a connection is established * @param[in] disconnected_cb The callback function called when a connection is disconnected * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_hdp_unset_connection_state_changed_cb() */ int bt_hdp_set_connection_state_changed_cb(bt_hdp_connected_cb connected_cb, bt_hdp_disconnected_cb disconnected_cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Unregisters a callback function that will be invoked when the connection state is changed. + * @brief Unregisters a callback function that will be invoked when the connection state is changed. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_hdp_set_connection_state_changed_cb() */ int bt_hdp_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Registers a callback function that will be invoked when you receive the data. + * @brief Registers a callback function that will be invoked when you receive the data. * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_hdp_unset_data_received_cb() */ int bt_hdp_set_data_received_cb(bt_hdp_data_received_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Unregisters a callback function that will be invoked when you receive the data. + * @brief Unregisters a callback function that will be invoked when you receive the data. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_hdp_set_data_received_cb() */ int bt_hdp_unset_data_received_cb(void); + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_client_foreach_services or bt_gatt_client_get_service instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the primary services of GATT(Generic Attribute Profile). + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Gets the primary services of GATT(Generic Attribute Profile). * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The address of the remote device - * @param[in] callback The callback function to invoke - * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @post @a callback will be called if there are primary services. - * @see bt_gatt_primary_service_cb() + * @param[in] remote_address The address of the remote device + * @param[in] callback The callback function to invoke + * @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 #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @post @a callback will be called if there are primary services. + * @see bt_gatt_primary_service_cb() */ int bt_gatt_foreach_primary_services(const char *remote_address, bt_gatt_primary_service_cb callback, void *user_data) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. This function call is not required because characteristic discovery is happened automatically. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Discovers the characteristics in service, asynchronously. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Discovers the characteristics in service, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] service The attribute handle of service - * @param[in] callback The result callback - * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @post @a callback will be called. - * @see bt_gatt_characteristics_discovered_cb() + * @param[in] service The attribute handle of service + * @param[in] callback The result callback + * @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 #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @post @a callback will be called. + * @see bt_gatt_characteristics_discovered_cb() */ int bt_gatt_discover_characteristics(bt_gatt_attribute_h service, bt_gatt_characteristics_discovered_cb callback, void *user_data) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_get_uuid instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the UUID of service. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Gets the UUID of service. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @remarks @a uuid must be released with free() by you. - * @param[in] service The attribute handle of service - * @param[out] uuid The UUID of service - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @remarks @a uuid must be released with free() by you. + * @param[in] service The attribute handle of service + * @param[out] uuid The UUID of service + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. */ int bt_gatt_get_service_uuid(bt_gatt_attribute_h service, char **uuid) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_service_foreach_included_services or bt_gatt_service_get_included_service instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the included services in service. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Gets the included services in service. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] service The attribute handle of service - * @param[in] callback The callback function to invoke - * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @post @a callback will be called if there are included services. - * @see bt_gatt_included_service_cb() + * @param[in] service The attribute handle of service + * @param[in] callback The callback function to invoke + * @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 #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @post @a callback will be called if there are included services. + * @see bt_gatt_included_service_cb() */ int bt_gatt_foreach_included_services(bt_gatt_attribute_h service, bt_gatt_included_service_cb callback, void *user_data) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_client_set_characteristic_value_changed_cb instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Registers a callback function that will be invoked when a characteristic value is changed. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Registers a callback function that will be invoked when a characteristic value is changed. * @since_tizen 2.3 - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized with bt_initialize(). - * @see bt_gatt_unset_characteristic_changed_cb() + * @param[in] callback The callback function to register + * @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 #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized with bt_initialize(). + * @see bt_gatt_unset_characteristic_changed_cb() */ int bt_gatt_set_characteristic_changed_cb(bt_gatt_characteristic_changed_cb callback, void *user_data) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_client_unset_characteristic_value_changed_cb instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Unregisters a callback function that will be invoked when a characteristic is changed. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Unregisters a callback function that will be invoked when a characteristic is changed. * @since_tizen 2.3 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_gatt_set_characteristic_changed_cb() */ int bt_gatt_unset_characteristic_changed_cb(void) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_client_set_characteristic_value_changed_cb instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Watches all the characteristic value changes of the service. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Watches all the characteristic value changes of the service. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] service The attribute handle of service - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized with bt_initialize(). - * @see bt_gatt_unset_characteristic_changed_cb() + * @param[in] service The attribute handle of service + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized with bt_initialize(). + * @see bt_gatt_unset_characteristic_changed_cb() */ int bt_gatt_watch_characteristic_changes(bt_gatt_attribute_h service) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_client_unset_characteristic_value_changed_cb instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Remove watching of all the characteristic value changes of the service. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Removes watching of all the characteristic value changes of the service. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] service The attribute handle of service - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] service The attribute handle of service + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_gatt_set_characteristic_changed_cb() */ int bt_gatt_unwatch_characteristic_changes(bt_gatt_attribute_h service) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_get_value or bt_gatt_get_uuid after bt_gatt_client_read_value instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the characteristic declaration. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Gets the characteristic declaration. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @remarks @a uuid and @a value must be released with free() by you. - * @param[in] characteristic The attribute handle of characteristic - * @param[out] uuid The UUID of service - * @param[out] value The value of characteristic (byte array) - * @param[out] value_length The length of value - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @see bt_gatt_set_characteristic_value() + * @remarks @a uuid and @a value must be released with free() by you. + * @param[in] characteristic The attribute handle of characteristic + * @param[out] uuid The UUID of service + * @param[out] value The value of characteristic (byte array) + * @param[out] value_length The length of value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @see bt_gatt_set_characteristic_value() */ int bt_gatt_get_characteristic_declaration(bt_gatt_attribute_h characteristic, char **uuid, unsigned char **value, int *value_length) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_set_value and bt_gatt_client_write_value instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Sets the value of characteristic. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Sets the value of characteristic. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] characteristic The attribute handle of characteristic - * @param[in] value The value of characteristic (byte array) - * @param[in] value_length The length of value - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @see bt_gatt_get_characteristic_declaration() + * @param[in] characteristic The attribute handle of characteristic + * @param[in] value The value of characteristic (byte array) + * @param[in] value_length The length of value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @see bt_gatt_get_characteristic_declaration() */ int bt_gatt_set_characteristic_value(bt_gatt_attribute_h characteristic, const unsigned char *value, int value_length) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use bt_gatt_set_value and bt_gatt_client_write_value instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Sets the value of characteristic request. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Sets the value of characteristic. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] characteristic The attribute handle of characteristic - * @param[in] value The value of characteristic (byte array) - * @param[in] value_length The length of value - * @param[in] callback The result callback - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @see bt_gatt_get_characteristic_declaration() + * @param[in] characteristic The attribute handle of characteristic + * @param[in] value The value of characteristic (byte array) + * @param[in] value_length The length of value + * @param[in] callback The result callback + * @return @c 0 on success, + * otherwise a negative error value. + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @see bt_gatt_get_characteristic_declaration() */ int bt_gatt_set_characteristic_value_request(bt_gatt_attribute_h characteristic, const unsigned char *value, int value_length, bt_gatt_characteristic_write_cb callback) TIZEN_DEPRECATED_API; + /** -* @deprecated Deprecated since 2.3.1. GATT handle clone is not allowed. Instead, all handles for client role must be got from GATT client handle. -* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE -* @brief Clones the attribute handle. -* @since_tizen 2.3 -* @remarks @a clone must be released with bt_gatt_destroy_attribute_handle(). -* @param[out] clone The cloned attribute handle -* @param[in] origin The origin attribute handle -* @return 0 on success, otherwise negative error value. -* @retval #BT_ERROR_NONE Successful -* @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter -* @retval #BT_ERROR_OUT_OF_MEMORY Out of memory -* @retval #BT_ERROR_NOT_SUPPORTED Not supported -* -* @see bt_gatt_destroy_attribute_handle() -*/ -int bt_gatt_clone_attribute_handle(bt_gatt_attribute_h *clone, - bt_gatt_attribute_h origin) TIZEN_DEPRECATED_API; - -/** -* @deprecated Deprecated since 2.3.1. GATT handle clone and destroy are not allowed. -* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE -* @brief Destroys the attribute handle. -* @since_tizen 2.3 -* @param[in] handle The attribute handle -* @return 0 on success, otherwise negative error value. -* @retval #BT_ERROR_NONE Successful -* @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter -* @retval #BT_ERROR_NOT_SUPPORTED Not supported -* -* @see bt_gatt_clone_attribute_handle() -*/ + * @deprecated Deprecated since 2.3.1. GATT handle clone is not allowed. Instead, all handles for client role must be got from GATT client handle. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Clones the attribute handle. + * @since_tizen 2.3 + * @remarks @a clone must be released with bt_gatt_destroy_attribute_handle(). + * @param[out] clone The cloned attribute handle + * @param[in] origin The origin attribute handle + * @return @c 0 on success, + * otherwise negative error value. + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_gatt_destroy_attribute_handle() + */ +int bt_gatt_clone_attribute_handle(bt_gatt_attribute_h *clone, bt_gatt_attribute_h origin) TIZEN_DEPRECATED_API; + + +/** + * @deprecated Deprecated since 2.3.1. GATT handle clone and destroy are not allowed. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Destroys the attribute handle. + * @since_tizen 2.3 + * @param[in] handle The attribute handle + * @return @c 0 on success, + * otherwise negative error value. + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_gatt_clone_attribute_handle() + */ int bt_gatt_destroy_attribute_handle(bt_gatt_attribute_h handle) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. Use gatt_client_read_value instead. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Reads the value of characteristic from remote device. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Reads the value of characteristic from remote device. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] char_handle The attribute handle of characteristic - * @param[in] callback The result callback - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @see bt_gatt_get_characteristic_declaration() + * @param[in] char_handle The attribute handle of characteristic + * @param[in] callback The result callback + * @return @c 0 on success, + * otherwise a negative error value. + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @see bt_gatt_get_characteristic_declaration() */ int bt_gatt_read_characteristic_value(bt_gatt_attribute_h char_handle, bt_gatt_characteristic_read_cb callback) TIZEN_DEPRECATED_API; + /** * @deprecated Deprecated since 2.3.1. This function call is not required because descriptor discovery is happened automatically. - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Discovers the characteristic descriptors of a characteristic within its definition, asynchronously. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Discovers the characteristic descriptors of a characteristic within its definition, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] characteristic_handle The attribute handle of characteristic - * @param[in] callback The result callback - * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @post @a callback will be called. - * @see bt_gatt_characteristic_descriptor_discovered_cb() + * @param[in] characteristic_handle The attribute handle of characteristic + * @param[in] callback The result callback + * @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 #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @post @a callback will be called. + * @see bt_gatt_characteristic_descriptor_discovered_cb() */ int bt_gatt_discover_characteristic_descriptor(bt_gatt_attribute_h characteristic_handle, bt_gatt_characteristic_descriptor_discovered_cb callback, void *user_data) TIZEN_DEPRECATED_API; + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the value of a characteristic or descriptor's GATT handle. + * @brief Gets the value of a characteristic or descriptor's GATT handle. * @since_tizen 2.3.1 - * * @remarks @a value must be released using free(). \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n - * in order to get the remote device's current value. - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n + * in order to get the remote device's current value. * @param[in] gatt_handle The handle of a characteristic or descriptor - * @param[out] value The value of @a gatt_handle. It is a byte stream type. + * @param[out] value The value of @a gatt_handle. It is a byte stream type * @param[out] value_length The length of @a value - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_value(bt_gatt_h gatt_handle, char **value, int *value_length); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the value of a characteristic or descriptor's GATT handle as an integer type. + * @brief Gets the value of a characteristic or descriptor's GATT handle as an integer type. * @since_tizen 2.3.1 - * * @remarks This function returns a locally saved value in @a gatt_handle. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n - * in order to get the remote device's current value. - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n + * in order to get the remote device's current value. * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type The type of a saved value in @a gatt_handle * @param[in] offset The offset from where a value will be read from @a gatt_handle as an integer type * @param[out] value The integer type's value of @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_int_value(bt_gatt_h gatt_handle, bt_data_type_int_e type, int offset, int *value); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the value of a characteristic or descriptor's GATT handle as a float type. + * @brief Gets the value of a characteristic or descriptor's GATT handle as a float type. * @since_tizen 2.3.1 - * * @remarks This function returns a locally saved value in @a gatt_handle. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n - * in order to get the remote device's current value. - * - * @param[in] gatt_handle The handle of a characteristic or descriptor + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n + * in order to get the remote device's current value. + * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type The type of a saved value in @a gatt_handle * @param[in] offset The offset from where a value will be read from @a gatt_handle as an integer type * @param[out] value The float type's value of @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_float_value(bt_gatt_h gatt_handle, bt_data_type_float_e type, int offset, float *value); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Updates the value of a characteristic or descriptor's GATT handle. + * @brief Updates the value of a characteristic or descriptor's GATT handle. * @since_tizen 2.3.1 - * * @remarks This function updates a value of @a gatt_handle locally. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n - * in order to update the remote device's value. \n - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n + * in order to update the remote device's value. * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] value The value to be updated * @param[in] value_length The length of @a value - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_set_value(bt_gatt_h gatt_handle, const char *value, int value_length); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Updates the value of a characteristic or descriptor's GATT handle using a integer type's value. + * @brief Updates the value of a characteristic or descriptor's GATT handle using a integer type's value. * @since_tizen 2.3.1 - * * @remarks This function updates a value of @a gatt_handle locally. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n - * in order to update the remote device's value. \n - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n + * in order to update the remote device's value. * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type @a value will be saved in @a gatt_handle as this type * @param[in] value The integer type's value to be updated * @param[in] offset The offset from where @a value will be saved in @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_set_int_value(bt_gatt_h gatt_handle, bt_data_type_int_e type, int value, int offset); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Updates the value of a characteristic or descriptor's GATT handle using a float type's value. + * @brief Updates the value of a characteristic or descriptor's GATT handle using a float type's value. * @since_tizen 2.3.1 - * * @remarks This function updates a value of @a gatt_handle locally. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n - * in order to update the remote device's value. \n - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n + * in order to update the remote device's value. * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type @a mantissa and @a exponent will be saved in @a gatt_handle as this type * @param[in] mantissa The mantissa of float type's value to be updated * @param[in] exponent The exponent of float type's value to be updated * @param[in] offset The offset from where @a mantissa and @a exponent will be saved in @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_set_float_value(bt_gatt_h gatt_handle, bt_data_type_float_e type, int mantissa, int exponent, int offset); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the UUID of a service, characteristic or descriptor's GATT handle. + * @brief Gets the UUID of a service, characteristic or descriptor's GATT handle. * @since_tizen 2.3.1 - * * @remarks @a uuid must be released using free(). \n - * 16-bit UUID or 128-bit UUID is supported. (e.g. 2A19, 00002A19-0000-1000-8000-00805F9B34FB) - * + * 16-bit UUID or 128-bit UUID is supported. (e.g. 2A19, 00002A19-0000-1000-8000-00805F9B34FB). * @param[in] gatt_handle The handle of a service, characteristic or descriptor * @param[out] uuid The string of the UUID of @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_uuid(bt_gatt_h gatt_handle, char **uuid); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the type of GATT handle. + * @brief Gets the type of GATT handle. * @since_tizen 2.3.1 - * * @param[in] gatt_handle The GATT handle * @param[out] gatt_type The type of @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_type(bt_gatt_h gatt_handle, bt_gatt_type_e *gatt_type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the GATT client handle which the specified service belongs to. + * @brief Gets the GATT client handle which the specified service belongs to. * @since_tizen 2.3.1 - * - * @remark This function doesn't allocate new memory for GATT client handle. - * The returned GATT client handle is the same one which was got from bt_gatt_client_create(). - * So if it is destroyed by bt_gatt_client_destroy(), all related GATT handles are freed also. - * + * @remarks This function doesn't allocate new memory for GATT client handle. + * The returned GATT client handle is the same one which was got from bt_gatt_client_create(). + * So if it is destroyed by bt_gatt_client_destroy(), all related GATT handles are freed also. * @param[in] service The service's GATT handle * @param[out] client The GATT client handle which @a service belongs to - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() */ int bt_gatt_service_get_client(bt_gatt_h service, bt_gatt_client_h *client); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets a characteristic's GATT handle which has specific UUID. + * @brief Gets a characteristic's GATT handle which has specific UUID. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * If there are multiple characteristics which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * If there are multiple characteristics which have same UUID, only the first matched one will be returned. * @param[in] service The service's GATT handle * @param[in] uuid The characteristic's GATT handle which has this UUID will be returned if it exists * @param[out] characteristic The characteristic's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_service_get_characteristic(bt_gatt_h service, const char *uuid, bt_gatt_h *characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Invokes @a callback function on each characteristic that belongs to the specified service. + * @brief Invokes @a callback function on each characteristic that belongs to the specified service. * @since_tizen 2.3.1 - * * @param[in] service The service's GATT handle * @param[in] callback The function to be invoked on each characteristic * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_service_foreach_characteristics(bt_gatt_h service, bt_gatt_foreach_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets an included service's GATT handle which has specific UUID. + * @brief Gets an included service's GATT handle which has specific UUID. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * If there are multiple included services which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * If there are multiple included services which have same UUID, only the first matched one will be returned. * @param[in] service The service's GATT handle * @param[in] uuid The included service's GATT handle which has this UUID will be returned if it exists * @param[out] included_service The included service's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_service_get_included_service(bt_gatt_h service, const char *uuid, bt_gatt_h *included_service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Invokes @a callback function on each included service that belongs to the specified service. + * @brief Invokes @a callback function on each included service that belongs to the specified service. * @since_tizen 2.3.1 - * * @param[in] service The service's GATT handle * @param[in] callback The function to be invoked on each included service * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_service_foreach_included_services(bt_gatt_h service, bt_gatt_foreach_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the service's GATT handle which the specified characteristic belongs to. + * @brief Gets the service's GATT handle which the specified characteristic belongs to. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). * @param[in] characteristic The characteristic's GATT handle * @param[out] service The service's GATT handle which @a characteristic belongs to - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_characteristic_get_service(bt_gatt_h characteristic, bt_gatt_h *service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the properties which a characteristic's GATT handle has. + * @brief Gets the properties which a characteristic's GATT handle has. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[out] properties The properties which a characteristic's GATT handle has - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_property_e */ int bt_gatt_characteristic_get_properties(bt_gatt_h characteristic, int *properties); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE * @brief Gets the write type of the specified characteristic. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[out] write_type The write type of the specified characteristic - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_write_type_e */ int bt_gatt_characteristic_get_write_type(bt_gatt_h characteristic, bt_gatt_write_type_e *write_type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Updates the write type of the specified characteristic. + * @brief Updates the write type of the specified characteristic. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[in] write_type The write type to be updated - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_write_value() * @see bt_gatt_write_type_e */ int bt_gatt_characteristic_set_write_type(bt_gatt_h characteristic, bt_gatt_write_type_e write_type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets a descriptor's GATT handle which has specific UUID. + * @brief Gets a descriptor's GATT handle which has specific UUID. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * If there are multiple descriptors which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * If there are multiple descriptors which have same UUID, only the first matched one will be returned. * @param[in] characteristic The characteristic's GATT handle * @param[in] uuid The descriptor's GATT handle which has this UUID will be returned if it exists * @param[out] descriptor The descriptor's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_characteristic_get_descriptor(bt_gatt_h characteristic, const char *uuid, bt_gatt_h *descriptor); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Invokes @a callback function on each descriptor that belongs to the specified characteristic. + * @brief Invokes @a callback function on each descriptor that belongs to the specified characteristic. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[in] callback The function to be invoked on each descriptor * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_characteristic_foreach_descriptors(bt_gatt_h characteristic, bt_gatt_foreach_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the characteristic's GATT handle which the specified descriptor belongs to. + * @brief Gets the characteristic's GATT handle which the specified descriptor belongs to. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). * @param[in] descriptor The descriptor's GATT handle * @param[out] characteristic The characteristic's GATT handle which @a descriptor belongs to - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_descriptor_get_characteristic(bt_gatt_h descriptor, bt_gatt_h *characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Creates the GATT client handle. + * @brief Creates the GATT client handle. * @since_tizen 2.3.1 - * - * @remark The GATT client handle must be freed by bt_gatt_client_destroy() after use - * + * @remarks The GATT client handle must be freed by bt_gatt_client_destroy() after use. * @param[in] remote_address The address of the remote device * @param[out] client The created GATT client's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_ALREADY_DONE Operation is already done - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_ALREADY_DONE Operation is already done + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_destroy() */ int bt_gatt_client_create(const char *remote_address, bt_gatt_client_h *client); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Destroys the GATT client's handle. + * @brief Destroys the GATT client's handle. * @since_tizen 2.3.1 - * - * @remark All related service, characteristic and descriptor's GATT handles are freed also - * + * @remarks All related service, characteristic and descriptor's GATT handles are freed also. * @param[in] client The GATT client's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() */ int bt_gatt_client_destroy(bt_gatt_client_h client); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the address of remote device. + * @brief Gets the address of remote device. * @since_tizen 2.3.1 - * * @param[in] client The created GATT client's handle * @param[out] remote_address The address of the remote device which is associated with @a client - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() */ int bt_gatt_client_get_remote_address(bt_gatt_client_h client, char **remote_address); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Reads the value of a characteristic or descriptor from the remote device asynchronously. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Reads the value of a characteristic or descriptor from the remote device asynchronously. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] gatt_handle The GATT handle of a characteristic or descriptor * @param[in] callback When a read request is completed, this callback function will be called * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() * @see bt_gatt_client_request_completed_cb() */ int bt_gatt_client_read_value(bt_gatt_h gatt_handle, bt_gatt_client_request_completed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Writes the value of a characteristic or descriptor to the remote device asynchronously. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Writes the value of a characteristic or descriptor to the remote device asynchronously. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] gatt_handle The GATT handle of a characteristic or descriptor * @param[in] callback When a write request is completed, this callback function will be called * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() * @see bt_gatt_characteristic_set_write_type() * @see bt_gatt_set_value() @@ -4565,20 +4523,20 @@ int bt_gatt_client_read_value(bt_gatt_h gatt_handle, int bt_gatt_client_write_value(bt_gatt_h gatt_handle, bt_gatt_client_request_completed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Registers a callback function to be invoked when the characteristic value is changed on the remote device. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Registers a callback function to be invoked when the characteristic value is changed on the remote device. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[in] callback The callback to be invoked when the value is changed and it is informed * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_characteristic_value_changed_cb() * @see bt_gatt_client_unset_characteristic_value_change() */ @@ -4586,119 +4544,116 @@ int bt_gatt_client_set_characteristic_value_changed_cb(bt_gatt_h characteristic, bt_gatt_client_characteristic_value_changed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Unregisters a callback function to be invoked when the characteristic value is changed on the remote device. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Unregisters a callback function to be invoked when the characteristic value is changed on the remote device. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle, whose value change will not be informed - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_set_characteristic_value_changed_cb() */ int bt_gatt_client_unset_characteristic_value_changed_cb(bt_gatt_h characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets a service's GATT handle which has specific UUID. + * @brief Gets a service's GATT handle which has specific UUID. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * If there are multiple services which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * If there are multiple services which have same UUID, only the first matched one will be returned. * @param[in] client The GATT client's handle * @param[in] uuid The service's GATT handle which has this UUID will be returned if it exists * @param[out] service The service's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_client_get_service(bt_gatt_client_h client, const char *uuid, bt_gatt_h *service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Invokes @a callback function on each service that belongs to the specified GATT client. + * @brief Invokes @a callback function on each service that belongs to the specified GATT client. * @since_tizen 2.3.1 - * * @param[in] client The GATT client's handle * @param[in] callback The function to be invoked on each service * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_client_foreach_services(bt_gatt_client_h client, bt_gatt_foreach_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Registers a callback function to be invoked when service is changed from a remote device(GATT server). + * @brief Registers a callback function to be invoked when service is changed from a remote device(GATT server). * @since_tizen 3.0 - * * @param[in] client The GATT client's handle * @param[in] callback The callback to be invoked * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_unset_service_changed_cb() */ int bt_gatt_client_set_service_changed_cb(bt_gatt_client_h client, bt_gatt_client_service_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Unregisters a callback function + * @brief Unregisters a callback function. * @since_tizen 3.0 - * * @param[in] client The GATT client's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_set_service_changed_cb() */ int bt_gatt_client_unset_service_changed_cb(bt_gatt_client_h client); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Connect to a specific LE based service on a remote bluetooth device address, asynchronously. + * @brief Connects to a specific LE based service on a remote bluetooth device address, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks A connection can be disconnected by bt_gatt_disconnect(). - * - * @param[in] address The address of the remote Bluetooth device. - * @param[in] auto_connect The flag of the auto connection. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @param[in] address The address of the remote Bluetooth device + * @param[in] auto_connect The flag of the auto connection + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @pre The remote device must support le connection. * @post This function invokes bt_gatt_connection_state_changed_cb(). - * * @see bt_initialize() * @see bt_gatt_disconnect() * @see bt_gatt_set_connection_state_changed_cb() @@ -4707,27 +4662,25 @@ int bt_gatt_client_unset_service_changed_cb(bt_gatt_client_h client); */ int bt_gatt_connect(const char *address, bool auto_connect); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Disconnect to LE connection with the given remote Bluetooth device address, asynchronously. + * @brief Disconnects to LE connection with the given remote Bluetooth device address, asynchronously. * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] address The address of the remote Bluetooth device - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The connection must be established. * @post This function invokes bt_gatt_connection_state_changed_cb(). - * * @see bt_initialize() * @see bt_gatt_connect() * @see bt_gatt_set_connection_state_changed_cb() @@ -4736,349 +4689,340 @@ int bt_gatt_connect(const char *address, bool auto_connect); */ int bt_gatt_disconnect(const char *address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE * @brief Registers a callback function that will be invoked when the connection state is changed. * @since_tizen 2.3 - * - * @param[in] callback The callback function to register. - * @param[in] user_data The user data to be passed to the callback function. - * - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_connect() * @see bt_gatt_disconnect() * @see bt_gatt_unset_connection_state_changed_cb() */ int bt_gatt_set_connection_state_changed_cb(bt_gatt_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE * @brief Unregisters a callback function that will be invoked when the connection state is changed. * @since_tizen 2.3 - * - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_connect() * @see bt_gatt_disconnect() * @see bt_gatt_connection_state_changed_cb() */ int bt_gatt_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Destroys the GATT handle of service. * @since_tizen 3.0 - * * @param[in] gatt_handle The handle of service - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_service_create() */ int bt_gatt_service_destroy(bt_gatt_h gatt_handle); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Destroys the GATT handle of characteristic. * @since_tizen 3.0 - * * @param[in] gatt_handle The handle of characteristic - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_characteristic_create() */ int bt_gatt_characteristic_destroy(bt_gatt_h gatt_handle); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Destroys the GATT handle of descriptor. * @since_tizen 3.0 - * * @param[in] gatt_handle The handle of descriptor - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_descriptor_create() */ int bt_gatt_descriptor_destroy(bt_gatt_h gatt_handle); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Gets the permissions which a characteristic's GATT handle has. + * @brief Gets the permissions which a characteristic's GATT handle has. * @since_tizen 3.0 - * * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. - * * @param[in] gatt_handle The handle of a characteristic * @param[out] permissions The permissions which a characteristic's GATT handle has - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_characteristic_create() * @see bt_gatt_permission_e */ int bt_gatt_characteristic_get_permissions(bt_gatt_h gatt_handle, int *permissions); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Gets the permissions which a descriptor's GATT handle has. + * @brief Gets the permissions which a descriptor's GATT handle has. * @since_tizen 3.0 - * * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. - * * @param[in] gatt_handle The handle of a descriptor * @param[out] permissions The permissions which a descriptor's GATT handle has - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_descriptor_create() * @see bt_gatt_permission_e */ int bt_gatt_descriptor_get_permissions(bt_gatt_h gatt_handle, int *permissions); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Creates the GATT service. + * @brief Creates the GATT service. * @since_tizen 3.0 - * - * @remarks The @a service should be destroyed by using bt_gatt_service_destroy() - * + * @remarks The @a service should be destroyed by using bt_gatt_service_destroy(). * @param[in] uuid The UUID of the service * @param[in] type The type of the service * @param[out] service The GATT handle of the created service - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_service_destroy() */ int bt_gatt_service_create(const char *uuid, bt_gatt_service_type_e type, bt_gatt_h *service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Adds a characteristic to a specified service. + * @brief Adds a characteristic to a specified service. * @since_tizen 3.0 - * * @param[in] service The service's GATT handle * @param[in] characteristic The characteristic's GATT handle to be added - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_service_create() * @see bt_gatt_characteristic_create() */ int bt_gatt_service_add_characteristic(bt_gatt_h service, bt_gatt_h characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Adds a service to a specified service as included service. + * @brief Adds a service to a specified service as included service. * @since_tizen 3.0 - * * @param[in] service The service's GATT handle * @param[in] included_service The service's GATT handle to be added as included service - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_service_create() */ int bt_gatt_service_add_included_service(bt_gatt_h service, bt_gatt_h included_service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Gets the GATT server handle to which the specified service belongs. + * @brief Gets the GATT server handle to which the specified service belongs. * @since_tizen 3.0 - * * @remarks The returned Server handle must not be freed by application. - * * @param[in] service The service's GATT handle * @param[out] server The GATT server handle to which @a service belongs - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_create() * @see bt_gatt_service_create() * @see bt_gatt_server_register_service() */ int bt_gatt_service_get_server(bt_gatt_h service, bt_gatt_server_h *server); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Creates the GATT characteristic. + * @brief Creates the GATT characteristic. * @since_tizen 3.0 - * * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. * @remarks The @a properties can be one or more values of #bt_gatt_property_e, combined with bitwise 'or'. * @remarks The @a characteristic should be destroyed by using bt_gatt_characteristic_destroy(). - * * @param[in] uuid The UUID of the characteristic - * @param[in] permissions the permissions of the characteristic + * @param[in] permissions The permissions of the characteristic * @param[in] properties The properties of the characteristic * @param[in] value The value(byte stream) of the characteristic * @param[in] value_length The length of @a value * @param[out] characteristic The GATT handle of the created characteristic - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_characteristic_destroy() */ int bt_gatt_characteristic_create(const char *uuid, int permissions, int properties, const char *value, int value_length, bt_gatt_h *characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Adds a descriptor to a specified characteristic. + * @brief Adds a descriptor to a specified characteristic. * @since_tizen 3.0 - * * @param[in] characteristic The GATT handle of the characteristic * @param[in] descriptor The descriptor's GATT handle to be added - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_characteristic_create() * @see bt_gatt_descriptor_create() */ int bt_gatt_characteristic_add_descriptor(bt_gatt_h characteristic, bt_gatt_h descriptor); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Creates the GATT characteristic descriptor. + * @brief Creates the GATT characteristic descriptor. * @since_tizen 3.0 - * * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. - * @remarks The @a descriptor should be destroyed by using bt_gatt_descriptor_destroy() - * + * @remarks The @a descriptor should be destroyed by using bt_gatt_descriptor_destroy(). * @param[in] uuid The UUID of the descriptor * @param[in] permissions The permissions of the descriptor * @param[in] value The value(byte stream) associated with the descriptor * @param[in] value_length The length of @a value * @param[out] descriptor The GATT handle of the created characteristic descriptor - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_descriptor_destroy() */ int bt_gatt_descriptor_create(const char *uuid, int permissions, const char *value, int value_length, bt_gatt_h *descriptor); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Initializes the GATT Server. * @since_tizen 3.0 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @see bt_gatt_server_deinitialize() */ int bt_gatt_server_initialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief DeInitializes the GATT server. * @since_tizen 3.0 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @see bt_gatt_server_initialize() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @see bt_gatt_server_initialize() */ int bt_gatt_server_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Creates the GATT server's handle. + * @brief Creates the GATT server's handle. * @since_tizen 3.0 - * + * @remarks The @a server handle should be destroyed by using bt_gatt_server_destroy(). * @param[out] server The GATT server's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_destroy() */ int bt_gatt_server_create(bt_gatt_server_h *server); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Destroys the GATT server's handle. + * @brief Destroys the GATT server's handle. * @since_tizen 3.0 - * - * @remarks All registered services to GATT server are unregistered - * + * @remarks All registered services to GATT server are unregistered. * @param[in] server The GATT server's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_create() */ int bt_gatt_server_destroy(bt_gatt_server_h server); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers a callback function to be invoked when a read request for a specified characteristic or descriptor is issued from a remote device(GATT client). + * @brief Registers a callback function to be invoked when a read request for a specified characteristic or descriptor is issued from a remote device(GATT client). * @since_tizen 3.0 - * * @param[in] gatt_handle The GATT handle of a characteristic or descriptor * @param[in] callback The callback to be invoked * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_read_value_requested_cb() * @see bt_gatt_server_send_response() */ @@ -5086,61 +5030,61 @@ int bt_gatt_server_set_read_value_requested_cb(bt_gatt_h gatt_handle, bt_gatt_server_read_value_requested_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers a callback function to be invoked when the remote device enables or disables the Notification/Indication for particular characteristics. + * @brief Registers a callback function to be invoked when the remote device enables or disables the Notification/Indication for particular characteristics. * @since_tizen 3.0 - * * @param[in] gatt_handle The GATT handle of a characteristic * @param[in] callback The callback to be invoked * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_characteristic_notification_state_changed_cb() */ int bt_gatt_server_set_characteristic_notification_state_change_cb(bt_gatt_h gatt_handle, bt_gatt_server_characteristic_notification_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers a callback function to be invoked when a value of a characteristic or descriptor has been changed by a remote device(GATT client)'s request. + * @brief Registers a callback function to be invoked when a value of a characteristic or descriptor has been changed by a remote device(GATT client)'s request. * @since_tizen 3.0 - * * @param[in] gatt_handle The GATT handle of a characteristic or descriptor * @param[in] callback The callback to be invoked * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_write_value_requested_cb() */ int bt_gatt_server_set_write_value_requested_cb(bt_gatt_h gatt_handle, bt_gatt_server_write_value_requested_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers a specified service to the specified GATT server that the local device is hosting. + * @brief Registers a specified service to the specified GATT server that the local device is hosting. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] server The GATT server that local device is hosting * @param[in] service The service, which needs to be registered in @a server - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed * @retval #BT_ERROR_ALREADY_DONE Operation is already done - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_create() * @see bt_gatt_service_create() * @see bt_gatt_server_start() @@ -5148,59 +5092,59 @@ int bt_gatt_server_set_write_value_requested_cb(bt_gatt_h gatt_handle, */ int bt_gatt_server_register_service(bt_gatt_server_h server, bt_gatt_h service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Unregisters a specified service from the specified GATT server that the local device is hosting. + * @brief Unregisters a specified service from the specified GATT server that the local device is hosting. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] server The GATT server that local device is hosting * @param[in] service The service, which needs to be unregistered from @a server - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_SERVICE_NOT_FOUND Service not found - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_SERVICE_NOT_FOUND Service not found + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_register_service() */ int bt_gatt_server_unregister_service(bt_gatt_server_h server, bt_gatt_h service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Unregisters all services from the specified GATT server that the local device is hosting. + * @brief Unregisters all services from the specified GATT server that the local device is hosting. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] server The GATT server that local device is hosting - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_register_service() */ int bt_gatt_server_unregister_all_services(bt_gatt_server_h server); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers the application along with the GATT services of the application it is hosting. + * @brief Registers the application along with the GATT services of the application it is hosting. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed * @retval #BT_ERROR_ALREADY_DONE Operation is already done - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_initialize() * @see bt_gatt_server_create() * @see bt_gatt_service_create() @@ -5208,91 +5152,91 @@ int bt_gatt_server_unregister_all_services(bt_gatt_server_h server); */ int bt_gatt_server_start(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Sends a response to the remote device as a result of a read/write request. + * @brief Sends a response to the remote device as a result of a read/write request. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks Until this function is called, a read/write request is not finished. - * * @param[in] request_id The identification of a read/write request * @param[in] request_type The request type for read/write * @param[in] offset The offset from where a value is read - * @param[in] resp_status The application error if any occurred or BT_ERROR_NONE for successful. - * @param[in] value The value to be sent. It will be sent from @a offset. If it is NULL, a requested GATT handle's value will be sent from @a offset. + * @param[in] resp_status The application error if any occurred or BT_ERROR_NONE for successful + * @param[in] value The value to be sent. It will be sent from @a offset. If it is NULL, a requested GATT handle's value will be sent from @a offset * @param[in] value_length Value Length - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_read_value_requested_cb() */ int bt_gatt_server_send_response(int request_id, bt_gatt_att_request_type_e request_type, int offset, int resp_status, char *value, int value_length); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Notifies value change of the characteristic to the remote devices which enable a Client Characteristic Configuration Descriptor. + * @brief Notifies value change of the characteristic to the remote devices which enable a Client Characteristic Configuration Descriptor. * @since_tizen 3.0 - * * @param[in] characteristic The characteristic which has a changed value * @param[in] callback The function to be invoked on each remote device when a sending operation is done - * @param[in] device_address Remote device address to send notify or indicate and if set to NULL then notify/indicate all is enabled. + * @param[in] device_address Remote device address to send notify or indicate and if set to NULL then notify/indicate all is enabled * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_notification_sent_cb() */ int bt_gatt_server_notify_characteristic_changed_value(bt_gatt_h characteristic, bt_gatt_server_notification_sent_cb callback, const char *device_address, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Gets a service's GATT handle which has specific UUID. + * @brief Gets a service's GATT handle which has specific UUID. * @since_tizen 3.0 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated server is destroyed by bt_gatt_server_destroy(). - * If there are multiple services which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated server is destroyed by bt_gatt_server_destroy(). + * If there are multiple services which have same UUID, only the first matched one will be returned. * @param[in] server The GATT server's handle * @param[in] uuid The service's GATT handle which has this UUID will be returned if it exists * @param[out] service The service's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_server_get_service(bt_gatt_server_h server, const char *uuid, bt_gatt_h *service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Invokes @a callback function on each service that belongs to the specified GATT server. + * @brief Invokes @a callback function on each service that belongs to the specified GATT server. * @since_tizen 3.0 - * * @param[in] server The GATT server's handle * @param[in] callback The function to be invoked on each service * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_server_foreach_services(bt_gatt_server_h server, bt_gatt_foreach_cb callback, void *user_data); + /** * @} */ @@ -5302,4 +5246,6 @@ int bt_gatt_server_foreach_services(bt_gatt_server_h server, } #endif /* __cplusplus */ + #endif /* __TIZEN_NETWORK_BLUETOOTH_H__ */ + diff --git a/include/wearable/bluetooth.h b/include/wearable/bluetooth.h index d612aa5..8df9b87 100644 --- a/include/wearable/bluetooth.h +++ b/include/wearable/bluetooth.h @@ -18,6 +18,7 @@ #ifndef __TIZEN_NETWORK_BLUETOOTH_H__ #define __TIZEN_NETWORK_BLUETOOTH_H__ + #include <stdlib.h> #include <unistd.h> #include <stdbool.h> @@ -35,10 +36,11 @@ extern "C" { #endif /* __cplusplus */ + /** - * @file bluetooth.h - * @brief API to control the Bluetooth adapter and devices and communications. - * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE + * @file bluetooth.h + * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE + * @brief API to control the Bluetooth adapter, devices, and communications. */ @@ -51,17 +53,15 @@ extern "C" /** * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE * @brief Initializes the Bluetooth API. - * @since_tizen 2.3.1 - * + * @since_tizen 2.3 * @remarks This function must be called before Bluetooth API starts. \n - * You must free all resources of the Bluetooth service by calling bt_deinitialize() if Bluetooth service is no longer needed. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_deinitialize() + * You must free all resources of the Bluetooth service by calling bt_deinitialize() if Bluetooth service is no longer needed. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_deinitialize() */ int bt_initialize(void); @@ -69,131 +69,116 @@ int bt_initialize(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE * @brief Releases all resources of the Bluetooth API. - * @since_tizen 2.3.1 - * + * @since_tizen 2.3 * @remarks This function must be called if Bluetooth API is no longer needed. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre Bluetooth API must be initialized with bt_initialize(). - * * @see bt_initialize() */ int bt_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE * @brief Gets the specification name for the given UUID. * @since_tizen 3.0 - * * @remarks The @a name must be released using free(). - * * @param[in] uuid The UUID * @param[out] name The specification name defined at www.bluetooth.com - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value. + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_get_uuid() */ int bt_get_uuid_name(const char *uuid, char **name); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the current state of local Bluetooth adapter. - * @since_tizen 2.3.1 - * + * @since_tizen 2.3 * @param[out] adapter_state The current adapter state - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre Bluetooth service must be initialized with bt_initialize(). - * * @see bt_initialize() */ int bt_adapter_get_state(bt_adapter_state_e *adapter_state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the address of local Bluetooth adapter. - * @since_tizen 2.3.1 - * + * @since_tizen 2.3 * @remarks The @a local_address must be released with free() by you. - * * @param[out] local_address The device address of local Bluetooth adapter - * - * @return 0 on success, otherwise a negative error value. + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @see bt_adapter_get_name() */ int bt_adapter_get_address(char **local_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the name of local Bluetooth adapter. - * @since_tizen 2.3.1 - * - * @details Use this function to get the friendly name associated with Bluetooth - * device, retrieved by the remote Bluetooth devices. - * + * @details Use this function to get the friendly name associated with Bluetooth device, retrieved by the remote Bluetooth devices. + * @since_tizen 2.3 * @remarks The @a local_name must be released with free() by you. - * - * @param[out] local_name The local device name - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[out] local_name The local device name + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * * @see bt_adapter_set_name() */ int bt_adapter_get_name(char **local_name); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Sets the name of local Bluetooth adapter. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] local_name The name of the Bluetooth device. \n - * The maximum length is 248 characters. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled + * The maximum length is 248 characters + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post bt_adapter_name_changed_cb() will be invoked if this function returns #BT_ERROR_NONE. - * * @see bt_adapter_get_name() * @see bt_adapter_name_changed_cb() * @see bt_adapter_set_name_changed_cb() @@ -201,51 +186,49 @@ int bt_adapter_get_name(char **local_name); */ int bt_adapter_set_name(const char *local_name); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Gets the visibility mode of local Bluetooth adapter. - * @since_tizen 2.3.1 - * @param[out] mode The visibility mode of the Bluetooth device - * @param[out] duration The duration until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE (in seconds). - * @a duration is valid only if @a mode is #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE. This value can be NULL. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE + * @brief Gets the visibility mode of local Bluetooth adapter. + * @since_tizen 2.3 + * @param[out] mode The visibility mode of the Bluetooth device + * @param[out] duration The duration until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE (in seconds). + * @a duration is valid only if @a mode is #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE. This value can be NULL + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. */ int bt_adapter_get_visibility(bt_adapter_visibility_mode_e *mode, int *duration); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Starts the device discovery, asynchronously. - * @since_tizen 2.3.1 + * @details If a device is discovered, bt_adapter_device_discovery_state_changed_cb() will be invoked + * with #BT_ADAPTER_DEVICE_DISCOVERY_FOUND, and then bt_adapter_device_discovery_state_changed_cb() + * will be called with #BT_ADAPTER_DEVICE_DISCOVERY_FINISHED in case of the completion or cancellation of the discovery. + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @details If a device is discovered, bt_adapter_device_discovery_state_changed_cb() will be invoked - * with #BT_ADAPTER_DEVICE_DISCOVERY_FOUND, and then bt_adapter_device_discovery_state_changed_cb() - * will be called with #BT_ADAPTER_DEVICE_DISCOVERY_FINISHED in case of the completion or cancellation of the discovery. - * * @remarks To connect to peer Bluetooth device, you need to know its Bluetooth address. \n - * The device discovery can be stopped by bt_adapter_stop_device_discovery(). - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * The device discovery can be stopped by bt_adapter_stop_device_discovery(). + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post This function invokes bt_adapter_device_discovery_state_changed_cb(). - * * @see bt_adapter_is_discovering() * @see bt_adapter_stop_device_discovery() * @see bt_adapter_device_discovery_state_changed_cb() @@ -254,26 +237,25 @@ int bt_adapter_get_visibility(bt_adapter_visibility_mode_e *mode, int *duration) */ int bt_adapter_start_device_discovery(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Stops the device discovery, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @remarks The device discovery process will take 10 ~ 20 seconds to get all the devices in vicinity. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The device discovery must be in progress with bt_adapter_start_device_discovery(). * @post This function invokes bt_adapter_device_discovery_state_changed_cb(). - * * @see bt_adapter_is_discovering() * @see bt_adapter_start_device_discovery() * @see bt_adapter_set_device_discovery_state_changed_cb() @@ -282,152 +264,144 @@ int bt_adapter_start_device_discovery(void); */ int bt_adapter_stop_device_discovery(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Checks for the device discovery is in progress or not. - * @since_tizen 2.3.1 - * + * @brief Checks if the device discovery is in progress or not. + * @since_tizen 2.3 * @remarks If Bluetooth discovery is in progress, other operations are not allowed and - * you have to either stop the discovery operation, or wait for it to be finished, - * before performing other operations. - - * @param[out] is_discovering The discovering status: (@c true = in progress , @c false = not in progress ) - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * you have to either stop the discovery operation, or wait for it to be finished, + * before performing other operations. + * @param[out] is_discovering The discovering status: (@c true = in progress , @c false = not in progress ) + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * * @see bt_adapter_start_device_discovery() * @see bt_adapter_stop_device_discovery() */ int bt_adapter_is_discovering(bool *is_discovering); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Get the service mask from the uuid list. - * @since_tizen 2.3.1 - * - * @param[in] uuids The UUID list of the device. - * @param[in] no_of_service The number of the UUID list count. - * @param[out] service_mask_list Service mask list converted from the given UUID list. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Gets the service mask from the UUID list. + * @since_tizen 2.3 + * @param[in] uuids The UUID list of the device + * @param[in] no_of_service The number of the UUID list count + * @param[out] service_mask_list Service mask list converted from the given UUID list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_service_class_t */ int bt_device_get_service_mask_from_uuid_list(char **uuids, int no_of_service, bt_service_class_t *service_mask_list); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Retrieves the device information of all bonded devices. - * @since_tizen 2.3.1 - * - * @param [in] callback The callback function to invoke - * @param [in] user_data The user data passed from the foreach function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @since_tizen 2.3 + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data passed from the foreach function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post This function invokes bt_adapter_bonded_device_cb(). - * * @see bt_adapter_bonded_device_cb() */ int bt_adapter_foreach_bonded_device(bt_adapter_bonded_device_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the device information of a bonded device. - * @since_tizen 2.3.1 - * @remarks The @a device_info must be released with bt_adapter_free_device_info() by you . - * - * @param [in] remote_address The address of remote device - * @param [out] device_info The bonded device information - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @since_tizen 2.3 + * @remarks The @a device_info must be released with bt_adapter_free_device_info() by you. + * @param[in] remote_address The address of remote device + * @param[out] device_info The bonded device information + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post This function invokes bt_adapter_bonded_device_cb(). - * * @see bt_adapter_bonded_device_cb() */ int bt_adapter_get_bonded_device_info(const char *remote_address, bt_device_info_s **device_info); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Frees device info. - * @since_tizen 2.3.1 - * - * @param [in] device_info The bonded device information - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @since_tizen 2.3 + * @param[in] device_info The bonded device information + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_adapter_get_bonded_device_info() */ int bt_adapter_free_device_info(bt_device_info_s *device_info); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Checks whether the UUID of service is used or not - * @since_tizen 2.3.1 + * @brief Checks whether the UUID of service is used or not. + * @since_tizen 2.3 * @param[in] service_uuid The UUID of service * @param[out] used Indicates whether the service is used or not - * @return true on success, otherwise false. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c true on success, + * otherwise @c false + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_adapter_is_service_used(const char *service_uuid, bool *used); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked when the Bluetooth adapter state changes. - * @since_tizen 2.3.1 - * - * @param[in] callback The callback function to invoke - * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Registers a callback function to be invoked when the Bluetooth adapter state changes. + * @since_tizen 2.3 + * @param[in] callback The callback function to invoke + * @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 #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_adapter_state_changed_cb() will be invoked. - * * @see bt_initialize() * @see bt_adapter_state_changed_cb() * @see bt_adapter_set_state_changed_cb() @@ -435,159 +409,151 @@ int bt_adapter_is_service_used(const char *service_uuid, bool *used); */ int bt_adapter_set_state_changed_cb(bt_adapter_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_initialize() * @see bt_adapter_set_state_changed_cb() */ int bt_adapter_unset_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked when the name of Bluetooth adapter changes. - * @since_tizen 2.3.1 - * + * @brief Registers a callback function to be invoked when the name of Bluetooth adapter changes. + * @since_tizen 2.3 * @param[in] callback The callback function to invoke * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_adapter_name_changed_cb() will be invoked. - * + * @post bt_adapter_name_changed_cb() will be invoked. * @see bt_initialize() * @see bt_adapter_name_changed_cb() * @see bt_adapter_unset_name_changed_cb() */ int bt_adapter_set_name_changed_cb(bt_adapter_name_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_initialize() * @see bt_adapter_set_name_changed_cb() */ int bt_adapter_unset_name_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked when the visibility mode changes. - * @since_tizen 2.3.1 - * + * @brief Registers a callback function to be invoked when the visibility mode changes. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_adapter_visibility_mode_changed_cb() will be invoked. - * * @see bt_initialize() * @see bt_adapter_visibility_mode_changed_cb() * @see bt_adapter_unset_visibility_mode_changed_cb() */ int bt_adapter_set_visibility_mode_changed_cb(bt_adapter_visibility_mode_changed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized with bt_initialize(). - * - * @see bt_initialize() - * @see bt_adapter_set_visibility_mode_changed_cb() + * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized with bt_initialize(). + * @see bt_initialize() + * @see bt_adapter_set_visibility_mode_changed_cb() */ int bt_adapter_unset_visibility_mode_changed_cb(void); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked every second \n - * until the visibility mode is changed from #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE \n - * to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. - * @since_tizen 2.3.1 - * @details When you set visibility mode as #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE, - * @a callback will be called every second until visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized by bt_initialize(). - * @post bt_adapter_visibility_duration_changed_cb() will be invoked. - * @see bt_initialize() - * @see bt_adapter_visibility_duration_changed_cb() - * @see bt_adapter_unset_visibility_duration_changed_cb() + * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE + * @brief Registers a callback function to be invoked every second. + * Until the visibility mode is changed from #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. + * @details When you set visibility mode as #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE, + * @a callback will be called every second until visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. + * @since_tizen 2.3 + * @param[in] callback The callback function to register + * @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 #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized by bt_initialize(). + * @post bt_adapter_visibility_duration_changed_cb() will be invoked. + * @see bt_initialize() + * @see bt_adapter_visibility_duration_changed_cb() + * @see bt_adapter_unset_visibility_duration_changed_cb() */ int bt_adapter_set_visibility_duration_changed_cb(bt_adapter_visibility_duration_changed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized with bt_initialize(). - * @see bt_initialize() - * @see bt_adapter_set_visibility_duration_changed_cb() + * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized with bt_initialize(). + * @see bt_initialize() + * @see bt_adapter_set_visibility_duration_changed_cb() */ int bt_adapter_unset_visibility_duration_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked when the device discovery state changes. - * @since_tizen 2.3.1 - * + * @brief Registers a callback function to be invoked when the device discovery state changes. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_adapter_device_discovery_state_changed_cb() will be invoked. - * * @see bt_initialize() * @see bt_adapter_device_discovery_state_changed_cb() * @see bt_adapter_set_device_discovery_state_changed_cb() @@ -595,40 +561,39 @@ int bt_adapter_unset_visibility_duration_changed_cb(void); */ int bt_adapter_set_device_discovery_state_changed_cb(bt_adapter_device_discovery_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_initialize() * @see bt_adapter_set_device_discovery_state_changed_cb() */ int bt_adapter_unset_device_discovery_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Get the Hash and Randmoizer value, synchronously. - * @since_tizen 2.3.1 - * + * @brief Gets the Hash and Randmoizer value, synchronously. + * @since_tizen 2.3 * @param[out] hash The hash value received from the controller - * @param[out] randomizer The hash value received from the controller + * @param[out] randomizer The randomizer value received from the controller * @param[out] hash_len The length of the hash value * @param[out] randomizer_len The length of the randomizer value - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() @@ -636,27 +601,27 @@ int bt_adapter_unset_device_discovery_state_changed_cb(void); int bt_adapter_get_local_oob_data(unsigned char **hash, unsigned char **randomizer, int *hash_len, int *randomizer_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Sets the Hash and Randmoizer value, synchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address Remote device address * @param[in] hash The hash value received from the controller - * @param[in] randomizer The hash value received from the controller + * @param[in] randomizer The randomizer value received from the controller * @param[in] hash_len The length of the hash value. Allowed value is 16 * @param[in] randomizer_len The length of the randomizer value. Allowed value is 16 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() @@ -665,15 +630,14 @@ int bt_adapter_set_remote_oob_data(const char *remote_address, unsigned char *hash, unsigned char *randomizer, int hash_len, int randomizer_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the Hash and Randmoizer value, synchronously. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @remarks The @a hash192, randomizer192, hash256 and randomizer256 must be released using free() - * + * @remarks The @a hash192, randomizer192, hash256 and randomizer256 must be released using free(). * @param[out] hash192 The hash value derived from the P-192 public key * @param[out] randomizer192 The randomizer value associated with the P-192 public key * @param[out] hash192_len The length of @a hash192 @@ -682,14 +646,14 @@ int bt_adapter_set_remote_oob_data(const char *remote_address, * @param[out] randomizer256 The randomizer value associated with the P-256 public key * @param[out] hash256_len The length of @a hash256 * @param[out] randomizer256_len The length of @a randomizer256 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() @@ -699,13 +663,13 @@ int bt_adapter_get_local_oob_ext_data(unsigned char **hash192, unsigned char **r unsigned char **hash256, unsigned char **randomizer256, int *hash256_len, int *randomizer256_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Sets the Hash and Randmoizer value, synchronously. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address Remote device address * @param[in] hash192 The P-192 hash value received via OOB from remote device * @param[in] randomizer192 The P-192 randomizer value received via OOB from remote device @@ -715,15 +679,15 @@ int bt_adapter_get_local_oob_ext_data(unsigned char **hash192, unsigned char **r * @param[in] randomizer256 The P-256 randomizer value received via OOB from remote device * @param[in] hash256_len The length of @a hash256 * @param[in] randomizer256_len The length of @a randomizer256 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() @@ -734,23 +698,23 @@ int bt_adapter_set_remote_oob_ext_data(const char *remote_address, const unsigned char *hash256, const unsigned char *randomizer256, int hash256_len, int randomizer256_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Deletes the Hash and Randomizer value, synchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address Remote device address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() @@ -760,500 +724,446 @@ int bt_adapter_remove_remote_oob_data(const char *remote_address); /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Starts the LE scan to find LE advertisement. + * @details If a LE advertisement is found, bt_adapter_le_scan_result_cb() will be invoked. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @details If a LE advertisement is found, bt_adapter_le_scan_result_cb() will be invoked. - * * @param[in] cb The callback to report the result of this function * @param[in] user_data The user data to be passed when callback is called - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post This function invokes bt_adapter_le_scan_result_cb(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_start_scan(bt_adapter_le_scan_result_cb cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Stops the LE scan. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The LE scan must be in progress with bt_adapter_le_start_scan(). - * * @see bt_adapter_le_start_scan() */ int bt_adapter_le_stop_scan(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the service UUID list from the scan result information + * @brief Gets the service UUID list from the scan result information. * @since_tizen 2.3.1 - * * @remarks The @a uuids must be iterated as count and each pointed data must be released with free(). - * Then uuids must be released with free(). \n - * 16-bit service UUID or 128-bit service UUID is supported. (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) - * + * Then UUIDs must be released with free(). \n + * 16-bit service UUID or 128-bit service UUID is supported. (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB). * @param[in] info The scan result information * @param[in] pkt_type The packet type - * @param[out] uuids The list of string of the service uuid + * @param[out] uuids The list of string of the service UUID * @param[out] count The count of the service UUIDs - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_service_uuids(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, char ***uuids, int *count); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Gets the device name from the scan result information * @since_tizen 2.3.1 - * * @remarks The @a name must be released with free() by you. - * * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] name The device name - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_device_name(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, char **name); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the transmission power level from the scan result information + * @brief Gets the transmission power level from the scan result information. * @since_tizen 2.3.1 - * * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] power_level The transmission power level in dBm - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_tx_power_level(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, int *power_level); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the service solicitation UUID list from the scan result information + * @brief Gets the service solicitation UUID list from the scan result information. * @since_tizen 2.3.1 - * * @remarks The @a uuids must be iterated as count and each pointed data must be released with free(). - * Then uuids must be released with free(). \n - * 16-bit service solicitation UUID or 128-bit service solicitation UUID is supported. - * (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) - * + * Then UUIDs must be released with free(). \n + * 16-bit service solicitation UUID or 128-bit service solicitation UUID is supported. + * (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB). * @param[in] info The scan result information * @param[in] pkt_type The packet type - * @param[out] uuids The list of string of the service solicitation uuid + * @param[out] uuids The list of string of the service solicitation UUID * @param[out] count The count of the service UUIDs - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_service_solicitation_uuids(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, char ***uuids, int *count); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the service data list from the scan result information + * @brief Gets the service data list from the scan result information. * @since_tizen 2.3.1 - * - * @remarks The @a data_list must be released with bt_adapter_le_free_service_data_list() by you . - * + * @remarks The @a data_list must be released with bt_adapter_le_free_service_data_list() by you. * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] data_list The list of the service data * @param[out] count The count of the service data list - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_service_data_list(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, bt_adapter_le_service_data_s **data_list, int *count); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Frees service data list. * @since_tizen 2.3.1 - * * @param[in] data_list The list of the service data * @param[in] count The count of the service data list - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_adapter_le_get_scan_result_service_data_list() */ int bt_adapter_le_free_service_data_list(bt_adapter_le_service_data_s *data_list, int count); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the appearance from the scan result information + * @brief Gets the appearance from the scan result information. * @since_tizen 2.3.1 - * * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] appearance The appearance - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_appearance(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, int *appearance); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the manufacturer data from the scan result information + * @brief Gets the manufacturer data from the scan result information. * @since_tizen 2.3.1 - * * @remarks The @a manufacturer_data must be released with free() by you. - * * @param[in] info The scan result information * @param[in] pkt_type The packet type * @param[out] manufacturer_id The manufacturer ID * @param[out] manufacturer_data The manufacturer data (byte array) * @param[out] manufacturer_data_len The length of manufacturer data - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_scan_result_cb() */ int bt_adapter_le_get_scan_result_manufacturer_data(const bt_adapter_le_device_scan_result_info_s *info, bt_adapter_le_packet_type_e pkt_type, int *manufacturer_id, char **manufacturer_data, int *manufacturer_data_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Create advertiser to advertise device's existence or respond to LE scanning request. - * @since_tizen 2.3.1 - * + * @brief Creates advertiser to advertise device's existence or respond to LE scanning request. + * @since_tizen 2.3 * @param[out] advertiser The handle of advertiser - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_destroy_advertiser() */ int bt_adapter_le_create_advertiser(bt_advertiser_h *advertiser); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Destroy advertiser. - * @since_tizen 2.3.1 - * + * @brief Destroys advertiser. + * @since_tizen 2.3 * @param[out] advertiser The handle of advertiser - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_create_advertiser() */ int bt_adapter_le_destroy_advertiser(bt_advertiser_h advertiser); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add a service UUID to advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Adds a service UUID to advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * * @remarks 16-bit UUID or 128-bit UUID is supported. (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type - * @param[in] uuid The string of the service UUID. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] uuid The string of the service UUID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_add_advertising_service_uuid(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, const char *uuid); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add a service solicitation UUID to advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Adds a service solicitation UUID to advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * - * @remarks 16-bit service solicitation UUID or 128-bit service solicitation UUID is supported. - * (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) - * + * @remarks 16-bit service solicitation UUID or 128-bit service solicitation UUID is supported (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type - * @param[in] uuid The string of the service solicitation UUID. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] uuid The string of the service solicitation UUID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_add_advertising_service_solicitation_uuid(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, const char *uuid); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add service data to advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Adds service data to advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * - * @remarks 16-bit UUID is supported. (e.g. 180F) - * + * @remarks 16-bit UUID is supported (e.g. 180F) * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] uuid 16-bit UUID of the service * @param[in] service_data The service data * @param[in] service_data_len The data length of service data - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_add_advertising_service_data(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, const char *uuid, const char *service_data, int service_data_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Sets the external appearance of this device to advertise or scan response data. * Please refer to the adopted Bluetooth specification for the the appearance. * @since_tizen 2.3.1 - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] appearance The external appearance of device - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_set_advertising_appearance(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, int appearance); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add manufacturer specific data to advertise or scan response data. + * @brief Adds manufacturer specific data to advertise or scan response data. * Please refer to the Bluetooth Assigned Numbers provided by the Bluetooth SIG for a list of existing company identifiers. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] manufacturer_id Manufacturer identifier * @param[in] manufacturer_data The manufacturer specific data * @param[in] manufacturer_data_len The data length of manufacturer data - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_add_advertising_manufacturer_data(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, int manufacturer_id, const char *manufacturer_data, int manufacturer_data_len); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set whether the device name should be included in advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Sets whether the device name should be included in advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] include_name Whether the device name should be included - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_set_advertising_device_name(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, bool include_name); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set whether the transmission power level should be included in advertise or scan response data. - * The maximum advertised or responded data size is 31 bytes - * including data type and system wide data. + * @brief Sets whether the transmission power level should be included in advertise or scan response data. + * The maximum advertised or responded data size is 31 bytes including data type and system wide data. * @since_tizen 2.3.1 - * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type * @param[in] include_tx_power Whether the transmission power level should be included - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_QUOTA_EXCEEDED Quota exceeded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_clear_advertising_data() */ int bt_adapter_le_set_advertising_tx_power_level(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type, bool include_tx_power); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Clear all data to be advertised or responded to scan request from LE scanning device. - * @since_tizen 2.3.1 - * + * @brief Clears all data to be advertised or responded to scan request from LE scanning device. + * @since_tizen 2.3 * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type to be cleared - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). + * @see bt_adapter_le_add_advertising_data() */ int bt_adapter_le_clear_advertising_data(bt_advertiser_h advertiser, bt_adapter_le_packet_type_e pkt_type); @@ -1261,122 +1171,112 @@ int bt_adapter_le_clear_advertising_data(bt_advertiser_h advertiser, bt_adapter_ /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Stops the advertising. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] advertiser The handle of advertiser - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_IN_PROGRESS Operation is not in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The advertising must be going on with bt_adapter_le_start_advertising_new(). * @post This function invokes bt_adapter_le_advertising_state_changed_cb(). - * * @see bt_adapter_le_start_advertising_new() * @see bt_adapter_le_advertising_state_changed_cb() */ int bt_adapter_le_stop_advertising(bt_advertiser_h advertiser); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Start advertising with passed advertiser and advertising parameters. + * @brief Starts advertising with passed advertiser and advertising parameters. + * @details Once Bluetooth advertising is started, nearby Bluetooth LE(Low Energy) supported devices can know this device's existence. + * And one of them can make a connection request, if it is allowed. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @details Once Bluetooth advertising is started, nearby Bluetooth LE(Low Energy) supported - * devices can know this device's existence. And one of them can make a connection request, - * if it is allowed. - * * @param[in] advertiser The handle of advertiser * @param[in] cb The callback to report the result of this function * @param[in] user_data The user data to be passed when callback is called - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post This function invokes bt_adapter_le_advertising_state_changed_cb(). - * * @see bt_adapter_le_stop_advertising() * @see bt_adapter_le_advertising_state_changed_cb() */ int bt_adapter_le_start_advertising_new(bt_advertiser_h advertiser, bt_adapter_le_advertising_state_changed_cb cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set advertising mode to control the advertising power and latency. + * @brief Sets advertising mode to control the advertising power and latency. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] advertiser The handle of advertiser * @param[in] mode The mode of advertising - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_start_advertising_new() */ int bt_adapter_le_set_advertising_mode(bt_advertiser_h advertiser, bt_adapter_le_advertising_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set whether the advertising type should be connectable or non-connectable + * @brief Sets whether the advertising type should be connectable or non-connectable. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] advertiser The handle of advertiser * @param[in] connectable The type of advertising - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation is now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * * @see bt_adapter_le_start_advertising_new() */ int bt_adapter_le_set_advertising_connectable(bt_advertiser_h advertiser, bool connectable); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Sets Bluetooth LE scan mode + * @brief Sets Bluetooth LE scan mode. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] scan_mode The scan mode - * - * @return 0 on success, otherwise a negative error value. + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_ENABLED Adapter is not enabled * @retval #BT_ERROR_INVALID_PARAMETER Parameter is invalid @@ -1388,32 +1288,29 @@ int bt_adapter_le_set_advertising_connectable(bt_advertiser_h advertiser, bool c */ int bt_adapter_le_set_scan_mode(bt_adapter_le_scan_mode_e scan_mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Creates a bond with a remote Bluetooth device, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks A bond can be destroyed by bt_device_destroy_bond().\n - * The bonding request can be cancelled by bt_device_cancel_bonding(). - * + * The bonding request can be cancelled by bt_device_cancel_bonding(). * @param[in] remote_address The address of the remote Bluetooth device with which the bond should be created - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The remote device must be discoverable with bt_adapter_start_device_discovery(). * @post This function invokes bt_device_bond_created_cb(). - * * @see bt_adapter_start_device_discovery() * @see bt_device_bond_created_cb() * @see bt_device_cancel_bonding() @@ -1423,26 +1320,24 @@ int bt_adapter_le_set_scan_mode(bt_adapter_le_scan_mode_e scan_mode); */ int bt_device_create_bond(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Cancels the bonding process. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks Use this function when the remote Bluetooth device is not responding to the - * bond request or you wish to cancel the bonding request. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_IN_PROGRESS Operation not in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * bond request or you wish to cancel the bonding request. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_IN_PROGRESS Operation not in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The creating a bond must be in progress by bt_device_create_bond(). - * * @see bt_device_create_bond() * @see bt_device_bond_created_cb() * @see bt_device_set_bond_created_cb() @@ -1450,30 +1345,28 @@ int bt_device_create_bond(const char *remote_address); */ int bt_device_cancel_bonding(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Destroys the bond, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address The address of the remote Bluetooth device to remove bonding - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The bond with the remote device must be created with bt_device_create_bond(). * @post This function invokes bt_device_bond_destroyed_cb(). - * * @see bt_device_create_bond() * @see bt_device_bond_destroyed_cb() * @see bt_device_set_bond_destroyed_cb() @@ -1481,59 +1374,54 @@ int bt_device_cancel_bonding(void); */ int bt_device_destroy_bond(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Sets an alias for the bonded device. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address The address of the remote Bluetooth device * @param[in] alias The alias of the remote Bluetooth device - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The bond with the remote device must be created with bt_device_create_bond(). - * * @see bt_device_create_bond() */ int bt_device_set_alias(const char *remote_address, const char *alias); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Sets the authorization of a bonded device, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks Once a device is authorized, you don't need to receive a confirmation. - * * @param[in] remote_address The address of the remote Bluetooth device to authorize * @param[in] authorization_state The Bluetooth authorization state - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The bond with the remote device must be created with bt_device_create_bond(). * @post bt_device_authorization_changed_cb() will be invoked. - * * @see bt_device_create_bond() * @see bt_device_authorization_changed_cb() * @see bt_device_set_authorization_changed_cb() @@ -1541,34 +1429,31 @@ int bt_device_set_alias(const char *remote_address, const char *alias); */ int bt_device_set_authorization(const char *remote_address, bt_device_authorization_e authorization_state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Starts the search for services supported by the specified device, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks If creating a bond succeeds, which means bt_device_bond_created_cb() is called with result #BT_ERROR_NONE, - * then you don't need to run this function.\n - * The service search takes a couple of seconds to complete normally. \n - * + * then you don't need to run this function.\n + * The service search takes a couple of seconds to complete normally. * @param[in] remote_address The address of the remote Bluetooth device whose services need to be checked - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_SERVICE_SEARCH_FAILED Service search failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_SERVICE_SEARCH_FAILED Service search failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The remote device must be discoverable with bt_adapter_start_device_discovery(). * @pre The bond with the remote device must be created with bt_device_create_bond(). * @post This function invokes bt_device_service_searched_cb(). - * * @see bt_adapter_start_device_discovery() * @see bt_device_create_bond() * @see bt_device_bond_created_cb() @@ -1578,152 +1463,159 @@ int bt_device_set_authorization(const char *remote_address, bt_device_authorizat */ int bt_device_start_service_search(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Gets the connected profiles. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @param[in] remote_address The address of the remote device * @param[in] callback The callback function to invoke * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @post bt_device_connected_profile() will be invoked. * @see bt_device_connected_profile() */ int bt_device_foreach_connected_profiles(const char *remote_address, bt_device_connected_profile callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Gets the profile connected status. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @param[in] remote_address The address of the remote device * @param[in] bt_profile Wish to know bt_profile * @param[out] connected_status The connected status - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_BONDED Remote device not bonded + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. */ int bt_device_is_profile_connected(const char *remote_address, bt_profile_e bt_profile, bool *connected_status); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Updates a LE connection mode + * @brief Updates a LE connection mode. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] remote_address The address of the remote Bluetooth device * @param[in] mode The LE connection mode - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_device_update_le_connection_mode(const char *remote_address, bt_device_le_connection_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the bond creates. - * @since_tizen 2.3.1 + * @brief Registers a callback function to be invoked when the bond creates. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_device_bond_created_cb() will be invoked. + * @post bt_device_bond_created_cb() will be invoked. * @see bt_initialize() * @see bt_device_bond_created_cb() * @see bt_device_unset_bond_created_cb() */ int bt_device_set_bond_created_cb(bt_device_bond_created_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_bond_created_cb() */ int bt_device_unset_bond_created_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the bond destroys. - * @since_tizen 2.3.1 + * @brief Registers a callback function to be invoked when the bond destroys. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_device_bond_destroyed_cb() will be invoked. + * @post bt_device_bond_destroyed_cb() will be invoked. * @see bt_initialize() * @see bt_device_bond_destroyed_cb() * @see bt_device_unset_bond_destroyed_cb() */ int bt_device_set_bond_destroyed_cb(bt_device_bond_destroyed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_bond_destroyed_cb() */ int bt_device_unset_bond_destroyed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the authorization of device changes. - * @since_tizen 2.3.1 + * @brief Registers a callback function to be invoked when the authorization of device changes. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_device_authorization_changed_cb() will be invoked. + * @post bt_device_authorization_changed_cb() will be invoked. * @see bt_initialize() * @see bt_device_authorization_changed_cb() * @see bt_device_set_authorization_changed_cb() @@ -1731,68 +1623,72 @@ int bt_device_unset_bond_destroyed_cb(void); */ int bt_device_set_authorization_changed_cb(bt_device_authorization_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_authorization_changed_cb() */ int bt_device_unset_authorization_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the process of service search finishes. - * @since_tizen 2.3.1 + * @brief Registers a callback function to be invoked when the process of service search finishes. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_device_service_searched_cb() will be invoked. + * @post bt_device_service_searched_cb() will be invoked. * @see bt_initialize() * @see bt_device_service_searched_cb() * @see bt_device_unset_service_searched_cb() */ int bt_device_set_service_searched_cb(bt_device_service_searched_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_service_searched_cb() */ int bt_device_unset_service_searched_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Registers a callback function to be invoked when the connection state is changed. - * @since_tizen 2.3.1 + * @brief Registers a callback function to be invoked when the connection state is changed. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_device_connection_state_changed_cb() will be invoked. * @see bt_initialize() @@ -1801,71 +1697,69 @@ int bt_device_unset_service_searched_cb(void); */ int bt_device_set_connection_state_changed_cb(bt_device_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Unregisters the callback function to be invoked when the connection state is changed. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function to be invoked when the connection state is changed. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_device_set_connection_state_changed_cb() */ int bt_device_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Registers a rfcomm server socket with a specific UUID. - * @since_tizen 2.3.1 + * @brief Registers a RFCOMM server socket with a specific UUID. + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks A socket can be destroyed by bt_socket_destroy_rfcomm(). - * * @param[in] service_uuid The UUID of service to provide * @param[out] socket_fd The file descriptor of socket to listen - * @return 0 on success, otherwise a negative error value. - * - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * * @see bt_socket_listen_and_accept_rfcomm() * @see bt_socket_destroy_rfcomm() */ int bt_socket_create_rfcomm(const char *service_uuid, int *socket_fd); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Removes the rfcomm server socket which was created using bt_socket_create_rfcomm(). - * @since_tizen 2.3.1 + * @brief Removes the RFCOMM server socket which was created using bt_socket_create_rfcomm(). + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @remarks If callback function bt_socket_connection_state_changed_cb() is set and the remote Bluetooth device is connected, - * then bt_socket_connection_state_changed_cb() will be called when this function is finished successfully. - * + * then bt_socket_connection_state_changed_cb() will be called when this function is finished successfully. * @param[in] socket_fd The file descriptor of socket (which was created using bt_socket_create_rfcomm()) to destroy - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The socket must be created with bt_socket_create_rfcomm(). * @post If callback function bt_socket_connection_state_changed_cb() is set and the remote Bluetooth device is connected, - * then bt_socket_connection_state_changed_cb() will be called. + * then bt_socket_connection_state_changed_cb() will be called. * @see bt_socket_create_rfcomm() * @see bt_socket_connection_state_changed_cb() * @see bt_socket_set_connection_state_changed_cb() @@ -1873,29 +1767,30 @@ int bt_socket_create_rfcomm(const char *service_uuid, int *socket_fd); */ int bt_socket_destroy_rfcomm(int socket_fd); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Starts listening on passed rfcomm socket and accepts connection requests. - * @since_tizen 2.3.1 + * @brief Starts listening on passed RFCOMM socket and accepts connection requests. + * @details Pop-up is shown automatically when a RFCOMM connection is requested. + * bt_socket_connection_state_changed_cb() will be called with + * #BT_SOCKET_CONNECTED if you click "yes" and connection is finished successfully. + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details Pop-up is shown automatically when a RFCOMM connection is requested. - * bt_socket_connection_state_changed_cb() will be called with - * #BT_SOCKET_CONNECTED if you click "yes" and connection is finished successfully. * @param[in] socket_fd The file descriptor of socket on which start to listen * @param[in] max_pending_connections The maximum number of pending connections - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The socket must be created with bt_socket_create_rfcomm(). * @post If callback function bt_socket_connection_state_changed_cb() is set, - * then bt_socket_connection_state_changed_cb() will be called when the remote Bluetooth device is connected. + * then bt_socket_connection_state_changed_cb() will be called when the remote Bluetooth device is connected. * @see bt_socket_create_rfcomm() * @see bt_socket_connection_state_changed_cb() * @see bt_socket_set_connection_state_changed_cb() @@ -1903,32 +1798,29 @@ int bt_socket_destroy_rfcomm(int socket_fd); */ int bt_socket_listen_and_accept_rfcomm(int socket_fd, int max_pending_connections); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE * @brief Connects to a specific RFCOMM based service on a remote Bluetooth device UUID, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks A connection can be disconnected by bt_socket_disconnect_rfcomm(). - * * @param[in] remote_address The address of the remote Bluetooth device * @param[in] service_uuid The UUID of service provided by the remote Bluetooth device - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @pre The remote device must be discoverable with bt_adapter_start_device_discovery(). * @pre The bond with the remote device must be created with bt_device_create_bond(). * @post This function invokes bt_socket_connection_state_changed_cb(). - * * @see bt_device_create_bond() * @see bt_adapter_start_device_discovery() * @see bt_device_start_service_search() @@ -1939,70 +1831,68 @@ int bt_socket_listen_and_accept_rfcomm(int socket_fd, int max_pending_connection */ int bt_socket_connect_rfcomm(const char *remote_address, const char *service_uuid); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE * @brief Disconnects the RFCOMM connection with the given file descriptor of connected socket. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] socket_fd The file descriptor of socket to close which was received using bt_socket_connection_state_changed_cb(). - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] socket_fd The file descriptor of socket to close which was received using bt_socket_connection_state_changed_cb() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The connection must be established. - * * @see bt_socket_connection_state_changed_cb() * @see bt_socket_set_connection_state_changed_cb() * @see bt_socket_unset_connection_state_changed_cb() */ int bt_socket_disconnect_rfcomm(int socket_fd); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE * @brief Sends data to the connected device. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @remark The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. * @param[in] socket_fd The file descriptor of connected socket which was received using bt_socket_connection_state_changed_cb() * @param[in] data The data to be sent * @param[in] length The length of data to be sent - * - * @return the number of bytes written (zero indicates nothing was written). - * @retval On error, -1 is returned, and errno is set appropriately. See write 2 man page. - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * @exception BT_ERROR_PERMISSION_DENIED Permission denied - * @exception BT_ERROR_AGAIN Resource temporarily unavailable - * + * @return The number of bytes written (zero indicates nothing was written) + * @retval On error, @c -1 is returned, and errno is set appropriately. See write 2 man page. + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @exception BT_ERROR_PERMISSION_DENIED Permission denied + * @exception BT_ERROR_AGAIN Resource temporarily unavailable * @pre The connection must be established. - * * @see bt_socket_connection_state_changed_cb() * @see bt_socket_set_connection_state_changed_cb() * @see bt_socket_unset_connection_state_changed_cb() */ int bt_socket_send_data(int socket_fd, const char *data, int length); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Register a callback function that will be invoked when you receive data. - * @since_tizen 2.3.1 + * @brief Registers a callback function that will be invoked when you receive data. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). - * @post bt_socket_data_received_cb() will be invoked. + * @post bt_socket_data_received_cb() will be invoked. * @see bt_initialize() * @see bt_socket_data_received_cb() * @see bt_socket_set_data_received_cb() @@ -2010,15 +1900,16 @@ int bt_socket_send_data(int socket_fd, const char *data, int length); */ int bt_socket_set_data_received_cb(bt_socket_data_received_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_socket_data_received_cb() @@ -2026,18 +1917,19 @@ int bt_socket_set_data_received_cb(bt_socket_data_received_cb callback, void *us */ int bt_socket_unset_data_received_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Register a callback function that will be invoked when a RFCOMM connection is requested. - * @since_tizen 2.3.1 + * @brief Registers a callback function that will be invoked when a RFCOMM connection is requested. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_socket_connection_requested_cb() will be invoked. * @see bt_initialize() @@ -2045,34 +1937,36 @@ int bt_socket_unset_data_received_cb(void); */ int bt_socket_set_connection_requested_cb(bt_socket_connection_requested_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The Bluetooth service must be initialized with bt_initialize(). - * @see bt_initialize() - * @see bt_socket_set_connection_requested_cb() - * @see bt_socket_connection_requested_cb() + * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The Bluetooth service must be initialized with bt_initialize(). + * @see bt_initialize() + * @see bt_socket_set_connection_requested_cb() + * @see bt_socket_connection_requested_cb() */ int bt_socket_unset_connection_requested_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Register a callback function that will be invoked when the connection state changes. - * @since_tizen 2.3.1 + * @brief Registers a callback function that will be invoked when the connection state changes. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @post bt_socket_connection_state_changed_cb() will be invoked. * @see bt_initialize() @@ -2081,15 +1975,16 @@ int bt_socket_unset_connection_requested_cb(void); */ int bt_socket_set_connection_state_changed_cb(bt_socket_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Unregisters the callback function. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters the callback function. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_socket_connection_state_changed_cb() @@ -2097,306 +1992,321 @@ int bt_socket_set_connection_state_changed_cb(bt_socket_connection_state_changed */ int bt_socket_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Initializes the Bluetooth OPP server requested by bt_opp_server_connection_requested_cb(). - * @since_tizen 2.3.1 * @details No popup appears when an OPP connection is requested from a remote device. - * Instead, @a connection_requested_cb() will be called. - * At that time, you can call either bt_opp_server_accept() or bt_opp_server_reject(). + * Instead, @a connection_requested_cb() will be called. + * At that time, you can call either bt_opp_server_accept() or bt_opp_server_reject(). + * @since_tizen 2.3 * @remarks This function must be called to start Bluetooth OPP server. \n - * You must free all resources of the Bluetooth service by calling bt_opp_server_deinitialize() if Bluetooth OPP service is no longer needed. - * @param[in] destination The destination path - * @param[in] connection_requested_cb The callback called when an OPP connection is requested + * You must free all resources of the Bluetooth service by calling bt_opp_server_deinitialize() if Bluetooth OPP service is no longer needed. + * @param[in] destination The destination path + * @param[in] connection_requested_cb The callback called when an OPP connection is requested * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_connection_requested_cb() - * @see bt_opp_server_deinitialize() - * @see bt_opp_server_accept() - * @see bt_opp_server_reject() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_connection_requested_cb() + * @see bt_opp_server_deinitialize() + * @see bt_opp_server_accept() + * @see bt_opp_server_reject() */ int bt_opp_server_initialize_by_connection_request(const char *destination, bt_opp_server_connection_requested_cb connection_requested_cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Deinitializes the Bluetooth OPP server. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_deinitialize() + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_deinitialize() */ int bt_opp_server_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Accepts the push request from the remote device. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @remarks If you initialize OPP server by bt_opp_server_initialize_by_connection_request(), then name is ignored. - * You can cancel the pushes by bt_opp_server_cancel_transfer() with transfer_id. - * @param[in] progress_cb The callback called when a file is being transferred - * @param[in] finished_cb The callback called when a transfer is finished - * @param[in] name The name to store. This can be NULL if you initialize OPP server by bt_opp_server_initialize_by_connection_request(). + * You can cancel the pushes by bt_opp_server_cancel_transfer() with transfer_id. + * @param[in] progress_cb The callback called when a file is being transferred + * @param[in] finished_cb The callback called when a transfer is finished + * @param[in] name The name to store. This can be NULL if you initialize OPP server by bt_opp_server_initialize_by_connection_request() * @param[in] user_data The user data to be passed to the callback function - * @param[out] transfer_id The ID of transfer - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_reject() + * @param[out] transfer_id The ID of transfer + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_reject() */ -int bt_opp_server_accept(bt_opp_server_transfer_progress_cb progress_cb, bt_opp_server_transfer_finished_cb finished_cb, const char *name, +int bt_opp_server_accept(bt_opp_server_transfer_progress_cb progress_cb, + bt_opp_server_transfer_finished_cb finished_cb, const char *name, void *user_data, int *transfer_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Rejects the push request from the remote device. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_accept() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_accept() */ int bt_opp_server_reject(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Cancels the transfer. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] transfer_id The ID of transfer - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_server_accept() + * @param[in] transfer_id The ID of transfer + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_server_accept() */ int bt_opp_server_cancel_transfer(int transfer_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Sets the destination path of file to be pushed. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] destination The destination path of file to be pushed - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @param[in] destination The destination path of file to be pushed + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_opp_server_set_destination(const char *destination); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Initializes the Bluetooth OPP client. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @remarks This function must be called before Bluetooth OPP client starts. \n - * You must free all resources of the Bluetooth service by calling bt_opp_client_deinitialize() - * if Bluetooth OPP service is no longer needed. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_client_deinitialize() + * You must free all resources of the Bluetooth service by calling bt_opp_client_deinitialize() + * if Bluetooth OPP service is no longer needed. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_RESOURCE_BUSY Device or resource busy + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_client_deinitialize() */ int bt_opp_client_initialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Deinitializes the Bluetooth OPP client. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_client_initialize() + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_client_initialize() */ int bt_opp_client_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Adds file to be pushed. - * @since_tizen 2.3.1 - * @param[in] file The path of file to be pushed - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_client_clear_files() - * @see bt_opp_client_push_files() + * @since_tizen 2.3 + * @param[in] file The path of file to be pushed + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_client_clear_files() + * @see bt_opp_client_push_files() */ int bt_opp_client_add_file(const char *file); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Adds file to be pushed. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @see bt_opp_client_add_file() - * @see bt_opp_client_push_files() + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @see bt_opp_client_add_file() + * @see bt_opp_client_push_files() */ int bt_opp_client_clear_files(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Pushes the file to the remote device, asynchronously. - * @since_tizen 2.3.1 + * @details At first, bt_opp_client_push_responded_cb() will be called when OPP server responds to the push request. + * After connection is established, bt_opp_client_push_progress_cb() will be called repeatedly until a file is transferred completely. + * If you send several files, then bt_opp_client_push_progress_cb() with another file will be called repeatedly until the file is transferred completely. + * bt_opp_client_push_finished_cb() will be called when the push request is finished. + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details At first, bt_opp_client_push_responded_cb() will be called when OPP server responds to the push request. - * After connection is established, bt_opp_client_push_progress_cb() will be called repeatedly until a file is transferred completely. - * If you send several files, then bt_opp_client_push_progress_cb() with another file will be called repeatedly until the file is transferred completely. - * bt_opp_client_push_finished_cb() will be called when the push request is finished. * @param[in] remote_address The remote address - * @param[in] responded_cb The callback called when OPP server responds to the push request - * @param[in] progress_cb The callback called when each file is being transferred - * @param[in] finished_cb The callback called when the push request is finished + * @param[in] responded_cb The callback called when OPP server responds to the push request + * @param[in] progress_cb The callback called when each file is being transferred + * @param[in] finished_cb The callback called when the push request is finished * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_opp_client_initialize() * @see bt_opp_client_cancel_push */ int bt_opp_client_push_files(const char *remote_address, bt_opp_client_push_responded_cb responded_cb, bt_opp_client_push_progress_cb progress_cb, bt_opp_client_push_finished_cb finished_cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Cancels the push request in progress, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre bt_opp_client_push_files() must be called. - * @post bt_opp_client_push_finished_cb() will be invoked with result #BT_ERROR_CANCELLED, - * which is a parameter of bt_opp_client_push_files(). + * @post bt_opp_client_push_finished_cb() will be invoked with result #BT_ERROR_CANCELLED, which is a parameter of bt_opp_client_push_files(). * @see bt_opp_client_initialize() * @see bt_opp_client_push_files() */ int bt_opp_client_cancel_push(void); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE + * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * @brief Initializes the Bluetooth HID(Human Interface Device) Host. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @remarks This function must be called before Bluetooth HID Host starts. \n - * You must free all resources of the Bluetooth service by calling bt_hid_host_deinitialize() - * if Bluetooth HID Host service is no longer needed. - * @param[in] connection_cb The callback called when the connection state is changed + * You must free all resources of the Bluetooth service by calling bt_hid_host_deinitialize() if Bluetooth HID Host service is no longer needed. + * @param[in] connection_cb The callback called when the connection state is changed * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() - * @see bt_hid_host_deinitialize() + * @see bt_hid_host_deinitialize() */ int bt_hid_host_initialize(bt_hid_host_connection_state_changed_cb connection_cb, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE + * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * @brief Deinitializes the Bluetooth HID(Human Interface Device) Host. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth HID service must be initialized with bt_hid_host_initialize(). - * @see bt_hid_host_initialize() + * @see bt_hid_host_initialize() */ int bt_hid_host_deinitialize(void); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE + * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * @brief Connects the remote device with the HID(Human Interface Device) service, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The local device must be bonded with the remote device by bt_device_create_bond(). * @pre The Bluetooth HID service must be initialized with bt_hid_host_initialize(). * @post bt_hid_host_connection_state_changed_cb() will be invoked. @@ -2405,23 +2315,24 @@ int bt_hid_host_deinitialize(void); */ int bt_hid_host_connect(const char *remote_address); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE + * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * @brief Disconnects the remote device with the HID(Human Interface Device) service, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected by bt_hid_host_connect(). * @post bt_hid_host_connection_state_changed_cb() will be invoked. * @see bt_hid_host_connect() @@ -2639,56 +2550,57 @@ int bt_hid_device_reply_to_report(const char *remote_address, /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Initializes the Bluetooth profiles related with audio. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @remarks This function must be called before Bluetooth profiles related with audio starts. \n - * You must free all resources of the this service by calling bt_audio_deinitialize() - * if Bluetooth profiles related with audio service is no longer needed. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * You must free all resources of the this service by calling bt_audio_deinitialize() if Bluetooth profiles related with audio service is no longer needed. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_audio_deinitialize() */ int bt_audio_initialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Deinitializes the Bluetooth profiles related with audio. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_audio_initialize(). * @see bt_audio_initialize() */ int bt_audio_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Connects the remote device with the given audio profile, asynchronously. - * @since_tizen 2.3.1 + * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and connection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice + * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is connected and #BT_AUDIO_PROFILE_TYPE_A2DP is connected. + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and connection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice - * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is connected and #BT_AUDIO_PROFILE_TYPE_A2DP is connected. - * @param[in] remote_address The remote address - * @param[in] type The type of audio profile - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - + * @param[in] remote_address The remote address + * @param[in] type The type of audio profile + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_audio_initialize(). * @pre The local device must be bonded with the remote device by bt_device_create_bond(). * @post bt_audio_connection_state_changed_cb() will be invoked. @@ -2697,25 +2609,26 @@ int bt_audio_deinitialize(void); */ int bt_audio_connect(const char *remote_address, bt_audio_profile_type_e type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Disconnects the remote device with the given audio profile, asynchronously. - * @since_tizen 2.3.1 + * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and disconnection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice + * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is disconnected and #BT_AUDIO_PROFILE_TYPE_A2DP is disconnected. + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and disconnection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice - * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is disconnected and #BT_AUDIO_PROFILE_TYPE_A2DP is disconnected. - * @param[in] remote_address The remote address - * @param[in] type The type of audio profile - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @param[in] type The type of audio profile + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected by bt_audio_connect(). * @post bt_audio_connection_state_changed_cb() will be invoked. * @see bt_audio_connect() @@ -2723,33 +2636,35 @@ int bt_audio_connect(const char *remote_address, bt_audio_profile_type_e type); */ int bt_audio_disconnect(const char *remote_address, bt_audio_profile_type_e type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE - * @brief Registers a callback function that will be invoked when the connection state is changed. - * @since_tizen 2.3.1 + * @brief Registers a callback function that will be invoked when the connection state is changed. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_audio_initialize(). * @see bt_audio_initialize() * @see bt_audio_connection_state_changed_cb() */ int bt_audio_set_connection_state_changed_cb(bt_audio_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE - * @brief Unregisters a callback function that will be invoked when the connection state is changed. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters a callback function that will be invoked when the connection state is changed. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_audio_initialize(). * @see bt_audio_initialize() * @see bt_audio_connection_state_changed_cb() @@ -2757,184 +2672,192 @@ int bt_audio_set_connection_state_changed_cb(bt_audio_connection_state_changed_c */ int bt_audio_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE * @brief Initializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service. - * @since_tizen 3.0 + * @since_tizen 2.4 * @remarks This function must be called before any other AVRCP target functions are called. \n - * You must free all resources of the this service by calling bt_avrcp_target_deinitialize() - * if Bluetooth AVRCP service is no longer needed. + * You must free all resources of the this service by calling bt_avrcp_target_deinitialize() if Bluetooth AVRCP service is no longer needed. * @param[in] callback The callback function called when the connection state is changed * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_avrcp_target_deinitialize() */ int bt_avrcp_target_initialize(bt_avrcp_target_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE * @brief Deinitializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service. - * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @since_tizen 2.4 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_target_initialize(). * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the equalizer state to the remote device. - * @since_tizen 3.0 + * @brief Notifies the equalizer state to the remote device. + * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] state The state of equalizer - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_equalizer_state(bt_avrcp_equalizer_state_e state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the repeat mode to the remote device. - * @since_tizen 3.0 + * @brief Notifies the repeat mode to the remote device. + * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The repeat mode - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_repeat_mode(bt_avrcp_repeat_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the shuffle mode to the remote device. - * @since_tizen 3.0 + * @brief Notifies the shuffle mode to the remote device. + * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The repeat mode - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_shuffle_mode(bt_avrcp_shuffle_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the scan mode to the remote device. - * @since_tizen 3.0 + * @brief Notifies the scan mode to the remote device. + * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The scan mode - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_scan_mode(bt_avrcp_scan_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the player state to the remote device. - * @since_tizen 3.0 + * @brief Notifies the player state to the remote device. + * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] state The player state - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_player_state(bt_avrcp_player_state_e state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the current position of song to the remote device. - * @since_tizen 3.0 + * @brief Notifies the current position of song to the remote device. + * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] position The current position in milliseconds - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_position(unsigned int position); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE - * @brief Notifies the track to the remote device. - * @since_tizen 3.0 + * @brief Notifies the track to the remote device. + * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] title The title of track @@ -2944,34 +2867,35 @@ int bt_avrcp_target_notify_position(unsigned int position); * @param[in] track_num The track number * @param[in] total_tracks The number of all tracks * @param[in] duration The duration of track in milliseconds - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_target_notify_track(const char *title, const char *artist, const char *album, const char *genre, unsigned int track_num, unsigned int total_tracks, unsigned int duration); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the equalizer state is changed by the remote control device. - * @since_tizen 3.0 + * @brief Registers a callback function that will be invoked when the equalizer state is changed. + * @since_tizen 2.4 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -2979,15 +2903,16 @@ int bt_avrcp_target_notify_track(const char *title, const char *artist, const ch */ int bt_avrcp_set_equalizer_state_changed_cb(bt_avrcp_equalizer_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the equalizer state is changed by the remote control device. - * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters a callback function that will be invoked when the equalizer state is changed. + * @since_tizen 2.4 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -2995,18 +2920,19 @@ int bt_avrcp_set_equalizer_state_changed_cb(bt_avrcp_equalizer_state_changed_cb */ int bt_avrcp_unset_equalizer_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the repeat mode is changed by the remote control device. - * @since_tizen 3.0 + * @brief Registers a callback function that will be invoked when the repeat mode is changed. + * @since_tizen 2.4 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3014,15 +2940,16 @@ int bt_avrcp_unset_equalizer_state_changed_cb(void); */ int bt_avrcp_set_repeat_mode_changed_cb(bt_avrcp_repeat_mode_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the repeat mode is changed by the remote control device. - * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters a callback function that will be invoked when the repeat mode is changed. + * @since_tizen 2.4 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3030,18 +2957,19 @@ int bt_avrcp_set_repeat_mode_changed_cb(bt_avrcp_repeat_mode_changed_cb callback */ int bt_avrcp_unset_repeat_mode_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the shuffle mode is changed by the remote control device. - * @since_tizen 3.0 + * @brief Registers a callback function that will be invoked when the shuffle mode is changed. + * @since_tizen 2.4 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3049,15 +2977,16 @@ int bt_avrcp_unset_repeat_mode_changed_cb(void); */ int bt_avrcp_set_shuffle_mode_changed_cb(bt_avrcp_shuffle_mode_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed by the remote control device. - * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed. + * @since_tizen 2.4 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3065,18 +2994,19 @@ int bt_avrcp_set_shuffle_mode_changed_cb(bt_avrcp_shuffle_mode_changed_cb callba */ int bt_avrcp_unset_shuffle_mode_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the scan mode is changed by the remote control device. - * @since_tizen 3.0 + * @brief Registers a callback function that will be invoked when the scan mode is changed. + * @since_tizen 2.4 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3084,15 +3014,16 @@ int bt_avrcp_unset_shuffle_mode_changed_cb(void); */ int bt_avrcp_set_scan_mode_changed_cb(bt_avrcp_scan_mode_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the scan mode is changed by the remote control device. - * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters a callback function that will be invoked when the scan mode is changed. + * @since_tizen 2.4 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3100,34 +3031,36 @@ int bt_avrcp_set_scan_mode_changed_cb(bt_avrcp_scan_mode_changed_cb callback, vo */ int bt_avrcp_unset_scan_mode_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the song position is changed by the remote target device. + * @brief Registers a callback function that will be invoked when the song position is changed. * @since_tizen 3.0 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() - * @see bt_avrcp_unset_position_changed_cb() + * @see bt_avrcp_set_position_changed_cb() */ int bt_avrcp_set_position_changed_cb(bt_avrcp_position_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the song position is changed by the remote target device. + * @brief Unregisters a callback function that will be invoked when the song position is changed. * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3135,18 +3068,19 @@ int bt_avrcp_set_position_changed_cb(bt_avrcp_position_changed_cb callback, void */ int bt_avrcp_unset_position_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the Play status is changed by the remote target device. + * @brief Registers a callback function that will be invoked when the Play status is changed. * @since_tizen 3.0 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3154,15 +3088,16 @@ int bt_avrcp_unset_position_changed_cb(void); */ int bt_avrcp_set_play_status_changed_cb(bt_avrcp_play_status_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the Play status is changed by the remote target device. + * @brief Unregisters a callback function that will be invoked when the Play status is changed. * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3170,18 +3105,19 @@ int bt_avrcp_set_play_status_changed_cb(bt_avrcp_play_status_changed_cb callback */ int bt_avrcp_unset_play_status_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the track metadata is changed by the remote target device. + * @brief Registers a callback function that will be invoked when the track metadata is changed. * @since_tizen 3.0 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3189,15 +3125,16 @@ int bt_avrcp_unset_play_status_changed_cb(void); */ int bt_avrcp_set_track_info_changed_cb(bt_avrcp_track_info_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the track metadata is changed by the remote target device. + * @brief Unregisters a callback function that will be invoked when the track metadata is changed. * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize(). * @see bt_avrcp_target_initialize() * @see bt_avrcp_control_initialize() @@ -3205,404 +3142,430 @@ int bt_avrcp_set_track_info_changed_cb(bt_avrcp_track_info_changed_cb callback, */ int bt_avrcp_unset_track_info_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Initializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) controller service. * @since_tizen 3.0 * @remarks This function must be called before any other AVRCP controller functions are called. \n - * You must free all resources of the this service by calling bt_avrcp_control_deinitialize() - * if Bluetooth AVRCP service is no longer needed. + * You must free all resources of the this service by calling bt_avrcp_control_deinitialize() + * if Bluetooth AVRCP service is no longer needed. * @param[in] callback The callback function called when the connection state is changed * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_initialize() * @see bt_avrcp_control_deinitialize() */ int bt_avrcp_control_initialize(bt_avrcp_control_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Deinitializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) controller service. * @since_tizen 3.0 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() */ int bt_avrcp_control_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Connects the AVRCP (Audio/Video Remote Control Profile) target device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @param[in] remote_address The remote address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() */ int bt_avrcp_control_connect(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Disconnects from the AVRCP (Audio/Video Remote Control Profile) target device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @param[in] remote_address The remote address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() * @see bt_avrcp_control_connect() */ int bt_avrcp_control_disconnect(const char *remote_address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Sends a command to the target device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] cmd The commands, one of: Play, Pause, Next, Rewind. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @param[in] cmd The commands, one of: Play, Pause, Next, Rewind + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() * @see bt_avrcp_control_connect() */ int bt_avrcp_control_send_player_command(bt_avrcp_player_command_e cmd); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Sends the equalizer state change request to the remote device. + * @brief Sends the equalizer state change request to the remote device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] state The new equalizer state, one of: ON, OFF - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_set_equalizer_state(bt_avrcp_equalizer_state_e state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the the equalizer state of the remote device. + * @brief Gets the the equalizer state of the remote device. * @since_tizen 3.0 * @param[out] state The equalizer state, one of: ON, OFF - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_equalizer_state(bt_avrcp_equalizer_state_e *state); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Sends the repeat change request to the remote device. + * @brief Sends the repeat change request to the remote device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The new repeat mode, one of: OFF, SINGLE, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_set_repeat_mode(bt_avrcp_repeat_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the repeat state of the remote device. + * @brief Gets the repeat state of the remote device. * @since_tizen 3.0 * @param[out] mode The repeat mode, one of: OFF, SINGLE, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_repeat_mode(bt_avrcp_repeat_mode_e *mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Sends the shuffle mode change request to the remote device. + * @brief Sends the shuffle mode change request to the remote device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The new shuffle mode, one of: OFF, GROUP, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_set_shuffle_mode(bt_avrcp_shuffle_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the shuffle mode of the remote device. + * @brief Gets the shuffle mode of the remote device. * @since_tizen 3.0 * @param[out] mode The shuffle mode, one of: OFF, GROUP, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_shuffle_mode(bt_avrcp_shuffle_mode_e *mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Sends the scan mode change request to the remote device. + * @brief Sends the scan mode change request to the remote device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @param[in] mode The new scan mode, one of: OFF, GROUP, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_set_scan_mode(bt_avrcp_scan_mode_e mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the scan mode of the remote device. + * @brief Gets the scan mode of the remote device. * @since_tizen 3.0 * @param[out] mode The scan mode, one of: OFF, GROUP, ALL - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_scan_mode(bt_avrcp_scan_mode_e *mode); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the position of the song played by the remote device. + * @brief Gets the position of the song played by the remote device. * @since_tizen 3.0 * @param[out] position The position, in milliseconds - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_position(unsigned int *position); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the play status of the remote device. + * @brief Gets the play status of the remote device. * @since_tizen 3.0 * @param[out] status The play status, one of: PLAYING, STOPPED... - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_play_status(bt_avrcp_player_state_e *status); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Gets the metadata of the track played by the remote device. + * @brief Gets the metadata of the track played by the remote device. * @since_tizen 3.0 - * @remarks The @a track must be released using bt_avrcp_control_free_track_info() - * @param[out] track The track metadata. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a track must be released using bt_avrcp_control_free_track_info(). + * @param[out] track The track metadata + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_avrcp_target_connection_state_changed_cb() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_get_track_info(bt_avrcp_metadata_attributes_info_s **track); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE - * @brief Frees the track metadata. + * @brief Frees the track metadata. * @since_tizen 3.0 - * @param[in] track The track metadata. - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * @pre track should point to valid metadata address. + * @param[in] track The track metadata + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre Track should point to valid metadata address. * @see bt_avrcp_control_get_track_info() * @see bt_avrcp_target_initialize() */ int bt_avrcp_control_free_track_info(bt_avrcp_metadata_attributes_info_s *track); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Registers an application that acts as the @a Sink role of HDP(Health Device Profile). - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * @remarks The @a app_id must be released with free() by you. - * @param[in] data_type The data type of MDEP. This value is defined in ISO/IEEE 11073-20601 spec. - * For example, pulse oximeter is 0x1004 and blood pressure monitor is 0x1007. - * @param[out] app_id The ID of application - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] data_type The data type of MDEP. This value is defined in ISO/IEEE 11073-20601 spec. + * For example, pulse oximeter is 0x1004 and blood pressure monitor is 0x1007 + * @param[out] app_id The ID of application + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @see bt_hdp_unregister_sink_app() */ int bt_hdp_register_sink_app(unsigned short data_type, char **app_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Unregisters the given application that acts as the @a Sink role of HDP(Health Device Profile). - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] app_id The ID of application - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] app_id The ID of application + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_hdp_register_sink_app() */ int bt_hdp_unregister_sink_app(const char *app_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Connects the remote device which acts as @a Source role, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @param[in] app_id The ID of application - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @param[in] app_id The ID of application + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Sink role of HDP must be registered with bt_hdp_register_sink_app(). * @pre The local device must be bonded with the remote device by bt_device_create_bond(). * @post bt_hdp_connected_cb() will be invoked. @@ -3612,25 +3575,26 @@ int bt_hdp_unregister_sink_app(const char *app_id); */ int bt_hdp_connect_to_source(const char *remote_address, const char *app_id); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Disconnects the remote device, asynchronously. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] remote_address The remote address - * @param[in] channel The connected data channel - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] remote_address The remote address + * @param[in] channel The connected data channel + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @post bt_hdp_disconnected_cb() will be invoked. * @see bt_hdp_set_connection_state_changed_cb() @@ -3638,24 +3602,25 @@ int bt_hdp_connect_to_source(const char *remote_address, const char *app_id); */ int bt_hdp_disconnect(const char *remote_address, unsigned int channel); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE * @brief Sends the data to the remote device. - * @since_tizen 2.3.1 + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @param[in] channel The connected data channel - * @param[in] data The data to send - * @param[in] size The size of data to send (byte) - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] channel The connected data channel + * @param[in] data The data to send + * @param[in] size The size of data to send (byte) + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The remote device must be connected. * @see bt_hdp_data_received_cb() * @see bt_hdp_set_data_received_cb() @@ -3663,64 +3628,68 @@ int bt_hdp_disconnect(const char *remote_address, unsigned int channel); */ int bt_hdp_send_data(unsigned int channel, const char *data, unsigned int size); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Registers a callback function that will be invoked when the connection state is changed. - * @since_tizen 2.3.1 + * @brief Registers a callback function that will be invoked when the connection state is changed. + * @since_tizen 2.3 * @param[in] connected_cb The callback function called when a connection is established * @param[in] disconnected_cb The callback function called when a connection is disconnected * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_hdp_unset_connection_state_changed_cb() */ int bt_hdp_set_connection_state_changed_cb(bt_hdp_connected_cb connected_cb, bt_hdp_disconnected_cb disconnected_cb, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Unregisters a callback function that will be invoked when the connection state is changed. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters a callback function that will be invoked when the connection state is changed. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_hdp_set_connection_state_changed_cb() */ int bt_hdp_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Registers a callback function that will be invoked when you receive the data. - * @since_tizen 2.3.1 + * @brief Registers a callback function that will be invoked when you receive the data. + * @since_tizen 2.3 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_hdp_unset_data_received_cb() */ int bt_hdp_set_data_received_cb(bt_hdp_data_received_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Unregisters a callback function that will be invoked when you receive the data. - * @since_tizen 2.3.1 - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @brief Unregisters a callback function that will be invoked when you receive the data. + * @since_tizen 2.3 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @see bt_hdp_set_data_received_cb() */ @@ -3728,483 +3697,482 @@ int bt_hdp_unset_data_received_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the value of a characteristic or descriptor's GATT handle. + * @brief Gets the value of a characteristic or descriptor's GATT handle. * @since_tizen 2.3.1 - * * @remarks @a value must be released using free(). \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n - * in order to get the remote device's current value. - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n + * in order to get the remote device's current value. * @param[in] gatt_handle The handle of a characteristic or descriptor - * @param[out] value The value of @a gatt_handle. It is a byte stream type. + * @param[out] value The value of @a gatt_handle. It is a byte stream type * @param[out] value_length The length of @a value - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_value(bt_gatt_h gatt_handle, char **value, int *value_length); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the value of a characteristic or descriptor's GATT handle as an integer type. + * @brief Gets the value of a characteristic or descriptor's GATT handle as an integer type. * @since_tizen 2.3.1 - * * @remarks This function returns a locally saved value in @a gatt_handle. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n - * in order to get the remote device's current value. - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n + * in order to get the remote device's current value. * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type The type of a saved value in @a gatt_handle * @param[in] offset The offset from where a value will be read from @a gatt_handle as an integer type * @param[out] value The integer type's value of @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_int_value(bt_gatt_h gatt_handle, bt_data_type_int_e type, int offset, int *value); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the value of a characteristic or descriptor's GATT handle as a float type. + * @brief Gets the value of a characteristic or descriptor's GATT handle as a float type. * @since_tizen 2.3.1 - * * @remarks This function returns a locally saved value in @a gatt_handle. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n - * in order to get the remote device's current value. - * - * @param[in] gatt_handle The handle of a characteristic or descriptor + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_read_value() must be used prior to this function \n + * in order to get the remote device's current value. + * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type The type of a saved value in @a gatt_handle * @param[in] offset The offset from where a value will be read from @a gatt_handle as an integer type * @param[out] value The float type's value of @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_float_value(bt_gatt_h gatt_handle, bt_data_type_float_e type, int offset, float *value); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Updates the value of a characteristic or descriptor's GATT handle. + * @brief Updates the value of a characteristic or descriptor's GATT handle. * @since_tizen 2.3.1 - * * @remarks This function updates a value of @a gatt_handle locally. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n - * in order to update the remote device's value. \n - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n + * in order to update the remote device's value. * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] value The value to be updated * @param[in] value_length The length of @a value - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + + + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_set_value(bt_gatt_h gatt_handle, const char *value, int value_length); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Updates the value of a characteristic or descriptor's GATT handle using a integer type's value. + * @brief Updates the value of a characteristic or descriptor's GATT handle using a integer type's value. * @since_tizen 2.3.1 - * * @remarks This function updates a value of @a gatt_handle locally. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n - * in order to update the remote device's value. \n - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n + * in order to update the remote device's value. * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type @a value will be saved in @a gatt_handle as this type * @param[in] value The integer type's value to be updated * @param[in] offset The offset from where @a value will be saved in @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_set_int_value(bt_gatt_h gatt_handle, bt_data_type_int_e type, int value, int offset); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Updates the value of a characteristic or descriptor's GATT handle using a float type's value. + * @brief Updates the value of a characteristic or descriptor's GATT handle using a float type's value. * @since_tizen 2.3.1 - * * @remarks This function updates a value of @a gatt_handle locally. \n - * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n - * in order to update the remote device's value. \n - * + * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n + * in order to update the remote device's value. * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type @a mantissa and @a exponent will be saved in @a gatt_handle as this type * @param[in] mantissa The mantissa of float type's value to be updated * @param[in] exponent The exponent of float type's value to be updated * @param[in] offset The offset from where @a mantissa and @a exponent will be saved in @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_set_float_value(bt_gatt_h gatt_handle, bt_data_type_float_e type, int mantissa, int exponent, int offset); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the UUID of a service, characteristic or descriptor's GATT handle. + * @brief Gets the UUID of a service, characteristic or descriptor's GATT handle. * @since_tizen 2.3.1 - * * @remarks @a uuid must be released using free(). \n - * 16-bit UUID or 128-bit UUID is supported. (e.g. 2A19, 00002A19-0000-1000-8000-00805F9B34FB) - * + * 16-bit UUID or 128-bit UUID is supported. (e.g. 2A19, 00002A19-0000-1000-8000-00805F9B34FB). * @param[in] gatt_handle The handle of a service, characteristic or descriptor * @param[out] uuid The string of the UUID of @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_uuid(bt_gatt_h gatt_handle, char **uuid); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the type of GATT handle. + * @brief Gets the type of GATT handle. * @since_tizen 2.3.1 - * * @param[in] gatt_handle The GATT handle * @param[out] gatt_type The type of @a gatt_handle - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_get_type(bt_gatt_h gatt_handle, bt_gatt_type_e *gatt_type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the GATT client handle which the specified service belongs to. + * @brief Gets the GATT client handle which the specified service belongs to. * @since_tizen 2.3.1 - * - * @remark This function doesn't allocate new memory for GATT client handle. - * The returned GATT client handle is the same one which was got from bt_gatt_client_create(). - * So if it is destroyed by bt_gatt_client_destroy(), all related GATT handles are freed also. - * + * @remarks This function doesn't allocate new memory for GATT client handle. + * The returned GATT client handle is the same one which was got from bt_gatt_client_create(). + * So if it is destroyed by bt_gatt_client_destroy(), all related GATT handles are freed also. * @param[in] service The service's GATT handle * @param[out] client The GATT client handle which @a service belongs to - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() */ int bt_gatt_service_get_client(bt_gatt_h service, bt_gatt_client_h *client); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets a characteristic's GATT handle which has specific UUID. + * @brief Gets a characteristic's GATT handle which has specific UUID. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * If there are multiple characteristics which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * If there are multiple characteristics which have same UUID, only the first matched one will be returned. * @param[in] service The service's GATT handle * @param[in] uuid The characteristic's GATT handle which has this UUID will be returned if it exists * @param[out] characteristic The characteristic's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_service_get_characteristic(bt_gatt_h service, const char *uuid, bt_gatt_h *characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Invokes @a callback function on each characteristic that belongs to the specified service. + * @brief Invokes @a callback function on each characteristic that belongs to the specified service. * @since_tizen 2.3.1 - * * @param[in] service The service's GATT handle * @param[in] callback The function to be invoked on each characteristic * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_service_foreach_characteristics(bt_gatt_h service, bt_gatt_foreach_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets an included service's GATT handle which has specific UUID. + * @brief Gets an included service's GATT handle which has specific UUID. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * If there are multiple included services which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * If there are multiple included services which have same UUID, only the first matched one will be returned. * @param[in] service The service's GATT handle * @param[in] uuid The included service's GATT handle which has this UUID will be returned if it exists * @param[out] included_service The included service's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_service_get_included_service(bt_gatt_h service, const char *uuid, bt_gatt_h *included_service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Invokes @a callback function on each included service that belongs to the specified service. + * @brief Invokes @a callback function on each included service that belongs to the specified service. * @since_tizen 2.3.1 - * * @param[in] service The service's GATT handle * @param[in] callback The function to be invoked on each included service * @param[in] user_data The user data to be passed to the callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_service_foreach_included_services(bt_gatt_h service, bt_gatt_foreach_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the service's GATT handle which the specified characteristic belongs to. + * @brief Gets the service's GATT handle which the specified characteristic belongs to. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). * @param[in] characteristic The characteristic's GATT handle * @param[out] service The service's GATT handle which @a characteristic belongs to - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_characteristic_get_service(bt_gatt_h characteristic, bt_gatt_h *service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the properties which a characteristic's GATT handle has. + * @brief Gets the properties which a characteristic's GATT handle has. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[out] properties The properties which a characteristic's GATT handle has - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_property_e */ int bt_gatt_characteristic_get_properties(bt_gatt_h characteristic, int *properties); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE * @brief Gets the write type of the specified characteristic. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[out] write_type The write type of the specified characteristic - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_write_type_e */ int bt_gatt_characteristic_get_write_type(bt_gatt_h characteristic, bt_gatt_write_type_e *write_type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Updates the write type of the specified characteristic. + * @brief Updates the write type of the specified characteristic. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[in] write_type The write type to be updated - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_write_value() * @see bt_gatt_write_type_e */ int bt_gatt_characteristic_set_write_type(bt_gatt_h characteristic, bt_gatt_write_type_e write_type); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets a descriptor's GATT handle which has specific UUID. + * @brief Gets a descriptor's GATT handle which has specific UUID. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * If there are multiple descriptors which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * If there are multiple descriptors which have same UUID, only the first matched one will be returned. * @param[in] characteristic The characteristic's GATT handle * @param[in] uuid The descriptor's GATT handle which has this UUID will be returned if it exists * @param[out] descriptor The descriptor's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_characteristic_get_descriptor(bt_gatt_h characteristic, const char *uuid, bt_gatt_h *descriptor); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Invokes @a callback function on each descriptor that belongs to the specified characteristic. + * @brief Invokes @a callback function on each descriptor that belongs to the specified characteristic. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[in] callback The function to be invoked on each descriptor * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_characteristic_foreach_descriptors(bt_gatt_h characteristic, bt_gatt_foreach_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the characteristic's GATT handle which the specified descriptor belongs to. + * @brief Gets the characteristic's GATT handle which the specified descriptor belongs to. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). * @param[in] descriptor The descriptor's GATT handle * @param[out] characteristic The characteristic's GATT handle which @a descriptor belongs to - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_descriptor_get_characteristic(bt_gatt_h descriptor, bt_gatt_h *characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Creates the GATT client handle. + * @brief Creates the GATT client handle. * @since_tizen 2.3.1 - * - * @remark The GATT client handle must be freed by bt_gatt_client_destroy() after use - * + * @remarks The GATT client handle must be freed by bt_gatt_client_destroy() after use. * @param[in] remote_address The address of the remote device * @param[out] client The created GATT client's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_ALREADY_DONE Operation is already done - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_ALREADY_DONE Operation is already done + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_destroy() */ int bt_gatt_client_create(const char *remote_address, bt_gatt_client_h *client); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Destroys the GATT client's handle. + * @brief Destroys the GATT client's handle. * @since_tizen 2.3.1 - * - * @remark All related service, characteristic and descriptor's GATT handles are freed also - * + * @remarks All related service, characteristic and descriptor's GATT handles are freed also. * @param[in] client The GATT client's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() */ int bt_gatt_client_destroy(bt_gatt_client_h client); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets the address of remote device. + * @brief Gets the address of remote device. * @since_tizen 2.3.1 - * * @param[in] client The created GATT client's handle * @param[out] remote_address The address of the remote device which is associated with @a client - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() */ int bt_gatt_client_get_remote_address(bt_gatt_client_h client, char **remote_address); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Reads the value of a characteristic or descriptor from the remote device asynchronously. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Reads the value of a characteristic or descriptor from the remote device asynchronously. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] gatt_handle The GATT handle of a characteristic or descriptor * @param[in] callback When a read request is completed, this callback function will be called * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() * @see bt_gatt_client_request_completed_cb() */ int bt_gatt_client_read_value(bt_gatt_h gatt_handle, bt_gatt_client_request_completed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Writes the value of a characteristic or descriptor to the remote device asynchronously. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Writes the value of a characteristic or descriptor to the remote device asynchronously. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] gatt_handle The GATT handle of a characteristic or descriptor * @param[in] callback When a write request is completed, this callback function will be called * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_ENABLED Not enabled + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_NOW_IN_PROGRESS Operation now in progress + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_create() * @see bt_gatt_characteristic_set_write_type() * @see bt_gatt_set_value() @@ -4215,20 +4183,20 @@ int bt_gatt_client_read_value(bt_gatt_h gatt_handle, int bt_gatt_client_write_value(bt_gatt_h gatt_handle, bt_gatt_client_request_completed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Registers a callback function to be invoked when the characteristic value is changed on the remote device. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Registers a callback function to be invoked when the characteristic value is changed on the remote device. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle * @param[in] callback The callback to be invoked when the value is changed and it is informed * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_characteristic_value_changed_cb() * @see bt_gatt_client_unset_characteristic_value_change() */ @@ -4236,119 +4204,116 @@ int bt_gatt_client_set_characteristic_value_changed_cb(bt_gatt_h characteristic, bt_gatt_client_characteristic_value_changed_cb callback, void *user_data); + /** - * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Unregisters a callback function to be invoked when the characteristic value is changed on the remote device. + * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE + * @brief Unregisters a callback function to be invoked when the characteristic value is changed on the remote device. * @since_tizen 2.3.1 - * * @param[in] characteristic The characteristic's GATT handle, whose value change will not be informed - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_set_characteristic_value_changed_cb() */ int bt_gatt_client_unset_characteristic_value_changed_cb(bt_gatt_h characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Gets a service's GATT handle which has specific UUID. + * @brief Gets a service's GATT handle which has specific UUID. * @since_tizen 2.3.1 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). - * If there are multiple services which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * If there are multiple services which have same UUID, only the first matched one will be returned. * @param[in] client The GATT client's handle * @param[in] uuid The service's GATT handle which has this UUID will be returned if it exists * @param[out] service The service's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_client_get_service(bt_gatt_client_h client, const char *uuid, bt_gatt_h *service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Invokes @a callback function on each service that belongs to the specified GATT client. + * @brief Invokes @a callback function on each service that belongs to the specified GATT client. * @since_tizen 2.3.1 - * * @param[in] client The GATT client's handle * @param[in] callback The function to be invoked on each service * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_client_foreach_services(bt_gatt_client_h client, bt_gatt_foreach_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Registers a callback function to be invoked when service is changed from a remote device(GATT server). + * @brief Registers a callback function to be invoked when service is changed from a remote device(GATT server). * @since_tizen 3.0 - * * @param[in] client The GATT client's handle * @param[in] callback The callback to be invoked * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_unset_service_changed_cb() */ int bt_gatt_client_set_service_changed_cb(bt_gatt_client_h client, bt_gatt_client_service_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Unregisters a callback function + * @brief Unregisters a callback function. * @since_tizen 3.0 - * * @param[in] client The GATT client's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_client_set_service_changed_cb() */ int bt_gatt_client_unset_service_changed_cb(bt_gatt_client_h client); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Connect to a specific LE based service on a remote bluetooth device address, asynchronously. - * @since_tizen 2.3.1 + * @brief Connects to a specific LE based service on a remote bluetooth device address, asynchronously. + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks A connection can be disconnected by bt_gatt_disconnect(). - * - * @param[in] address The address of the remote Bluetooth device. - * @param[in] auto_connect The flag of the auto connection. - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @param[in] address The address of the remote Bluetooth device + * @param[in] auto_connect The flag of the auto connection + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The Bluetooth service must be initialized with bt_initialize(). * @pre The remote device must support le connection. * @post This function invokes bt_gatt_connection_state_changed_cb(). - * * @see bt_initialize() * @see bt_gatt_disconnect() * @see bt_gatt_set_connection_state_changed_cb() @@ -4357,27 +4322,25 @@ int bt_gatt_client_unset_service_changed_cb(bt_gatt_client_h client); */ int bt_gatt_connect(const char *address, bool auto_connect); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Disconnect to LE connection with the given remote Bluetooth device address, asynchronously. - * @since_tizen 2.3.1 + * @brief Disconnects to LE connection with the given remote Bluetooth device address, asynchronously. + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] address The address of the remote Bluetooth device - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The connection must be established. * @post This function invokes bt_gatt_connection_state_changed_cb(). - * * @see bt_initialize() * @see bt_gatt_connect() * @see bt_gatt_set_connection_state_changed_cb() @@ -4386,349 +4349,340 @@ int bt_gatt_connect(const char *address, bool auto_connect); */ int bt_gatt_disconnect(const char *address); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE * @brief Registers a callback function that will be invoked when the connection state is changed. - * @since_tizen 2.3.1 - * - * @param[in] callback The callback function to register. - * @param[in] user_data The user data to be passed to the callback function. - * - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @since_tizen 2.3 + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_connect() * @see bt_gatt_disconnect() * @see bt_gatt_unset_connection_state_changed_cb() */ int bt_gatt_set_connection_state_changed_cb(bt_gatt_connection_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE * @brief Unregisters a callback function that will be invoked when the connection state is changed. - * @since_tizen 2.3.1 - * - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @since_tizen 2.3 + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_connect() * @see bt_gatt_disconnect() * @see bt_gatt_connection_state_changed_cb() */ int bt_gatt_unset_connection_state_changed_cb(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Destroys the GATT handle of service. * @since_tizen 3.0 - * * @param[in] gatt_handle The handle of service - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_service_create() */ int bt_gatt_service_destroy(bt_gatt_h gatt_handle); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Destroys the GATT handle of characteristic. * @since_tizen 3.0 - * * @param[in] gatt_handle The handle of characteristic - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_characteristic_create() */ int bt_gatt_characteristic_destroy(bt_gatt_h gatt_handle); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Destroys the GATT handle of descriptor. * @since_tizen 3.0 - * * @param[in] gatt_handle The handle of descriptor - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_descriptor_create() */ int bt_gatt_descriptor_destroy(bt_gatt_h gatt_handle); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Gets the permissions which a characteristic's GATT handle has. + * @brief Gets the permissions which a characteristic's GATT handle has. * @since_tizen 3.0 - * * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. - * * @param[in] gatt_handle The handle of a characteristic * @param[out] permissions The permissions which a characteristic's GATT handle has - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_characteristic_create() * @see bt_gatt_permission_e */ int bt_gatt_characteristic_get_permissions(bt_gatt_h gatt_handle, int *permissions); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Gets the permissions which a descriptor's GATT handle has. + * @brief Gets the permissions which a descriptor's GATT handle has. * @since_tizen 3.0 - * * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. - * * @param[in] gatt_handle The handle of a descriptor * @param[out] permissions The permissions which a descriptor's GATT handle has - * @return 0 on success, otherwise a negative error value - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_descriptor_create() * @see bt_gatt_permission_e */ int bt_gatt_descriptor_get_permissions(bt_gatt_h gatt_handle, int *permissions); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Creates the GATT service. + * @brief Creates the GATT service. * @since_tizen 3.0 - * - * @remarks The @a service should be destroyed by using bt_gatt_service_destroy() - * + * @remarks The @a service should be destroyed by using bt_gatt_service_destroy(). * @param[in] uuid The UUID of the service * @param[in] type The type of the service * @param[out] service The GATT handle of the created service - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_service_destroy() */ int bt_gatt_service_create(const char *uuid, bt_gatt_service_type_e type, bt_gatt_h *service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Adds a characteristic to a specified service. + * @brief Adds a characteristic to a specified service. * @since_tizen 3.0 - * * @param[in] service The service's GATT handle * @param[in] characteristic The characteristic's GATT handle to be added - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_service_create() * @see bt_gatt_characteristic_create() */ int bt_gatt_service_add_characteristic(bt_gatt_h service, bt_gatt_h characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Adds a service to a specified service as included service. + * @brief Adds a service to a specified service as included service. * @since_tizen 3.0 - * * @param[in] service The service's GATT handle * @param[in] included_service The service's GATT handle to be added as included service - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_service_create() */ int bt_gatt_service_add_included_service(bt_gatt_h service, bt_gatt_h included_service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Gets the GATT server handle to which the specified service belongs. + * @brief Gets the GATT server handle to which the specified service belongs. * @since_tizen 3.0 - * * @remarks The returned Server handle must not be freed by application. - * * @param[in] service The service's GATT handle * @param[out] server The GATT server handle to which @a service belongs - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_create() * @see bt_gatt_service_create() * @see bt_gatt_server_register_service() */ int bt_gatt_service_get_server(bt_gatt_h service, bt_gatt_server_h *server); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Creates the GATT characteristic. + * @brief Creates the GATT characteristic. * @since_tizen 3.0 - * * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. * @remarks The @a properties can be one or more values of #bt_gatt_property_e, combined with bitwise 'or'. * @remarks The @a characteristic should be destroyed by using bt_gatt_characteristic_destroy(). - * * @param[in] uuid The UUID of the characteristic - * @param[in] permissions the permissions of the characteristic + * @param[in] permissions The permissions of the characteristic * @param[in] properties The properties of the characteristic * @param[in] value The value(byte stream) of the characteristic * @param[in] value_length The length of @a value * @param[out] characteristic The GATT handle of the created characteristic - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_characteristic_destroy() */ int bt_gatt_characteristic_create(const char *uuid, int permissions, int properties, const char *value, int value_length, bt_gatt_h *characteristic); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Adds a descriptor to a specified characteristic. + * @brief Adds a descriptor to a specified characteristic. * @since_tizen 3.0 - * * @param[in] characteristic The GATT handle of the characteristic * @param[in] descriptor The descriptor's GATT handle to be added - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_characteristic_create() * @see bt_gatt_descriptor_create() */ int bt_gatt_characteristic_add_descriptor(bt_gatt_h characteristic, bt_gatt_h descriptor); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Creates the GATT characteristic descriptor. + * @brief Creates the GATT characteristic descriptor. * @since_tizen 3.0 - * * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. * @remarks The @a descriptor should be destroyed by using bt_gatt_descriptor_destroy(). - * * @param[in] uuid The UUID of the descriptor * @param[in] permissions The permissions of the descriptor * @param[in] value The value(byte stream) associated with the descriptor * @param[in] value_length The length of @a value * @param[out] descriptor The GATT handle of the created characteristic descriptor - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_descriptor_destroy() */ int bt_gatt_descriptor_create(const char *uuid, int permissions, const char *value, int value_length, bt_gatt_h *descriptor); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Initializes the GATT Server. * @since_tizen 3.0 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. * @see bt_gatt_server_deinitialize() */ int bt_gatt_server_initialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief DeInitializes the GATT server. * @since_tizen 3.0 - * - * @return 0 on success, otherwise a negative error value. - * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * - * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. - * @see bt_gatt_server_initialize() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #BT_ERROR_NONE Successful + * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. + * @see bt_gatt_server_initialize() */ int bt_gatt_server_deinitialize(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Creates the GATT server's handle. + * @brief Creates the GATT server's handle. * @since_tizen 3.0 - * + * @remarks The @a server handle should be destroyed by using bt_gatt_server_destroy(). * @param[out] server The GATT server's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_destroy() */ int bt_gatt_server_create(bt_gatt_server_h *server); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Destroys the GATT server's handle. + * @brief Destroys the GATT server's handle. * @since_tizen 3.0 - * - * @remarks All registered services to GATT server are unregistered - * + * @remarks All registered services to GATT server are unregistered. * @param[in] server The GATT server's handle - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_create() */ int bt_gatt_server_destroy(bt_gatt_server_h server); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers a callback function to be invoked when a read request for a specified characteristic or descriptor is issued from a remote device(GATT client). + * @brief Registers a callback function to be invoked when a read request for a specified characteristic or descriptor is issued from a remote device(GATT client). * @since_tizen 3.0 - * * @param[in] gatt_handle The GATT handle of a characteristic or descriptor * @param[in] callback The callback to be invoked * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_read_value_requested_cb() * @see bt_gatt_server_send_response() */ @@ -4739,59 +4693,58 @@ int bt_gatt_server_set_read_value_requested_cb(bt_gatt_h gatt_handle, /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers a callback function to be invoked when the remote device enables or disables the Notification/Indication for particular characteristics. + * @brief Registers a callback function to be invoked when the remote device enables or disables the Notification/Indication for particular characteristics. * @since_tizen 3.0 - * * @param[in] gatt_handle The GATT handle of a characteristic * @param[in] callback The callback to be invoked * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_characteristic_notification_state_changed_cb() */ int bt_gatt_server_set_characteristic_notification_state_change_cb(bt_gatt_h gatt_handle, bt_gatt_server_characteristic_notification_state_changed_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers a callback function to be invoked when a value of a characteristic or descriptor has been changed by a remote device(GATT client)'s request. + * @brief Registers a callback function to be invoked when a value of a characteristic or descriptor has been changed by a remote device(GATT client)'s request. * @since_tizen 3.0 - * * @param[in] gatt_handle The GATT handle of a characteristic or descriptor * @param[in] callback The callback to be invoked * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_write_value_requested_cb() */ int bt_gatt_server_set_write_value_requested_cb(bt_gatt_h gatt_handle, bt_gatt_server_write_value_requested_cb callback, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers a specified service to the specified GATT server that the local device is hosting. + * @brief Registers a specified service to the specified GATT server that the local device is hosting. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] server The GATT server that local device is hosting * @param[in] service The service, which needs to be registered in @a server - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed * @retval #BT_ERROR_ALREADY_DONE Operation is already done - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_create() * @see bt_gatt_service_create() * @see bt_gatt_server_start() @@ -4799,59 +4752,59 @@ int bt_gatt_server_set_write_value_requested_cb(bt_gatt_h gatt_handle, */ int bt_gatt_server_register_service(bt_gatt_server_h server, bt_gatt_h service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Unregisters a specified service from the specified GATT server that the local device is hosting. + * @brief Unregisters a specified service from the specified GATT server that the local device is hosting. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] server The GATT server that local device is hosting * @param[in] service The service, which needs to be unregistered from @a server - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_SERVICE_NOT_FOUND Service not found - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_SERVICE_NOT_FOUND Service not found + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_register_service() */ int bt_gatt_server_unregister_service(bt_gatt_server_h server, bt_gatt_h service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Unregisters all services from the specified GATT server that the local device is hosting. + * @brief Unregisters all services from the specified GATT server that the local device is hosting. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @param[in] server The GATT server that local device is hosting - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_register_service() */ int bt_gatt_server_unregister_all_services(bt_gatt_server_h server); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Registers the application along with the GATT services of the application it is hosting. + * @brief Registers the application along with the GATT services of the application it is hosting. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_OPERATION_FAILED Operation failed + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_OPERATION_FAILED Operation failed * @retval #BT_ERROR_ALREADY_DONE Operation is already done - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_initialize() * @see bt_gatt_server_create() * @see bt_gatt_service_create() @@ -4859,86 +4812,85 @@ int bt_gatt_server_unregister_all_services(bt_gatt_server_h server); */ int bt_gatt_server_start(void); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Sends a response to the remote device as a result of a read/write request. + * @brief Sends a response to the remote device as a result of a read/write request. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * * @remarks Until this function is called, a read/write request is not finished. - * * @param[in] request_id The identification of a read/write request * @param[in] request_type The request type for read/write * @param[in] offset The offset from where a value is read - * @param[in] resp_status The application error if any occurred or BT_ERROR_NONE for successful. - * @param[in] value The value to be sent. It will be sent from @a offset. If it is NULL, a requested GATT handle's value will be sent from @a offset. + * @param[in] resp_status The application error if any occurred or BT_ERROR_NONE for successful + * @param[in] value The value to be sent. It will be sent from @a offset. If it is NULL, a requested GATT handle's value will be sent from @a offset * @param[in] value_length Value Length - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_read_value_requested_cb() */ int bt_gatt_server_send_response(int request_id, bt_gatt_att_request_type_e request_type, int offset, int resp_status, char *value, int value_length); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Notifies value change of the characteristic to the remote devices which enable a Client Characteristic Configuration Descriptor. + * @brief Notifies value change of the characteristic to the remote devices which enable a Client Characteristic Configuration Descriptor. * @since_tizen 3.0 - * * @param[in] characteristic The characteristic which has a changed value * @param[in] callback The function to be invoked on each remote device when a sending operation is done - * @param[in] device_address Remote device address to send notify or indicate and if set to NULL then notify/indicate all is enabled. + * @param[in] device_address Remote device address to send notify or indicate and if set to NULL then notify/indicate all is enabled * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_server_notification_sent_cb() */ int bt_gatt_server_notify_characteristic_changed_value(bt_gatt_h characteristic, bt_gatt_server_notification_sent_cb callback, const char *device_address, void *user_data); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Gets a service's GATT handle which has specific UUID. + * @brief Gets a service's GATT handle which has specific UUID. * @since_tizen 3.0 - * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated server is destroyed by bt_gatt_server_destroy(). - * If there are multiple services which have same UUID, only the first matched one will be returned. - * + * @remarks The returned GATT handle must not be freed by application. + * It will be freed when an associated server is destroyed by bt_gatt_server_destroy(). + * If there are multiple services which have same UUID, only the first matched one will be returned. * @param[in] server The GATT server's handle * @param[in] uuid The service's GATT handle which has this UUID will be returned if it exists * @param[out] service The service's GATT handle which has @a uuid if it exists - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NO_DATA No data available - * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NO_DATA No data available + * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_server_get_service(bt_gatt_server_h server, const char *uuid, bt_gatt_h *service); + /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Invokes @a callback function on each service that belongs to the specified GATT server. + * @brief Invokes @a callback function on each service that belongs to the specified GATT server. * @since_tizen 3.0 - * * @param[in] server The GATT server's handle * @param[in] callback The function to be invoked on each service * @param[in] user_data The user data to be passed to @a callback function - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #BT_ERROR_NOT_SUPPORTED Not supported - * + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BT_ERROR_NOT_SUPPORTED Not supported * @see bt_gatt_foreach_cb() */ int bt_gatt_server_foreach_services(bt_gatt_server_h server, |