- For easier review, I didn't merge the files at the (1/2) patch.
They will be merged in a following patch (2/2)
- This is for Tizen 4.0 Configurability / Building Blocks
(Fragmentation of CAPI is a blocking issue)
- @ SDK (yongheon.shin@samsung.com): please confirm that this "merged"
CAPI header (sync_manager.h) is going to be filetered for SDK rootstraping
so that Tizen APP developers won't be able to see MOBILE-only APIs in
WEARABLE development.
- CC'ed API (hobum.kwon@samsung.com) to notify what's going on for CAPI
fragmentation.
Change-Id: I0e5814f1de867ff082dc7908d35bca8f0909426e
Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com>
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
* @brief Initializes the Bluetooth API.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
* @brief Releases all resources of the Bluetooth API.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks This function must be called if Bluetooth API is no longer needed.
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the current state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] adapter_state The current adapter state
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the address of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks The @a local_address must be released with free() by you.
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the name of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details Use this function to get the friendly name associated with Bluetooth
* device, retrieved by the remote Bluetooth devices.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the name of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the visibility mode of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Starts the device discovery, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Stops the device discovery, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Checks for the device discovery is in progress or not.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @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,
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Get the service mask from the uuid list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] uuids The UUID list of the device.
* @param[in] no_of_service The number of the UUID list count.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Retrieves the device information of all bonded devices.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param [in] callback The callback function to invoke
* @param [in] user_data The user data passed from the foreach function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the device information of a bonded device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Frees device info.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param [in] device_info The bonded device information
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Checks whether the UUID of service is used or not
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the Bluetooth adapter state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the visibility mode changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked every second
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* 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,
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the device discovery state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Get the Hash and Randmoizer value, synchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] hash The hash value received from the controller
* @param[out] randomizer The hash value received from the controller
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the Hash and Randmoizer value, synchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Deletes the Hash and Randomizer value, synchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Starts the LE device discovery.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Stops the LE device discovery, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @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,
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] advertiser The handle of advertiser
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Destroy advertiser.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] advertiser The handle of advertiser
*
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @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.
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] advertiser The handle of advertiser
* @param[in] pkt_type The packet type
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] advertiser The handle of advertiser
* @param[in] pkt_type The packet type to be cleared
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Start advertising with passed advertiser and advertising parameters.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Stops the advertising.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Creates a bond with a remote Bluetooth device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Cancels the bonding process.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Destroys the bond, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Sets an alias for the bonded device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Sets the authorization of a bonded device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Starts the search for services supported by the specified device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Gets the connected profiles.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Gets the profile connected status.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the bond creates.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the bond destroys.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the authorization of device changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function to be invoked when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Registers a rfcomm server socket with a specific UUID.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Removes the rfcomm server socket which was created using bt_socket_create_rfcomm().
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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,
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Starts listening on passed rfcomm socket and accepts connection requests.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @details Pop-up is shown automatically when a RFCOMM connection is requested.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Disconnects the RFCOMM connection with the given file descriptor of connected socket.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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().
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Sends data to the connected device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Register a callback function that will be invoked when you receive data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Register a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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().
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Deinitializes the Bluetooth OPP server.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Accepts the push request from the remote device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Rejects the push request from the remote device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Cancels the transfer.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] transfer_id The ID of transfer
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Sets the destination path of file to be pushed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] destination The destination path of file to be pushed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Initializes the Bluetooth OPP client.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Deinitializes the Bluetooth OPP client.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Adds file to be pushed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] file The path of file to be pushed
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Adds file to be pushed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Pushes the file to the remote device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @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
* @brief Cancels the push request in progress, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
int bt_opp_client_cancel_push(void);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Initializes the Bluetooth HID(Human Interface Device) Host.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
int bt_hid_host_initialize(bt_hid_host_connection_state_changed_cb connection_cb, void *user_data);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Deinitializes the Bluetooth HID(Human Interface Device) Host.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
int bt_hid_host_deinitialize(void);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Connects the remote device with the HID(Human Interface Device) service, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
int bt_hid_host_connect(const char *remote_address);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Disconnects the remote device with the HID(Human Interface Device) service, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
int bt_hid_host_disconnect(const char *remote_address);
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Activates the Bluetooth HID Device role.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @remarks This function must be called to register HID UUID.
+ * Only then a remote device is able to identify this one as a HID device.
+ *
+ * @param[in] callback 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_NOT_ENABLED Not enabled
+ * @retval #BT_ERROR_NOW_IN_PROGRESS Already activated
+ * @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().
+ * @see bt_initialize()
+ * @see bt_hid_device_deactivate()
+ */
+int bt_hid_device_activate(bt_hid_device_connection_state_changed_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Deactivates the Bluetooth HID Device role.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @remarks This function must be called to deregister the HID 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_NOT_ENABLED Not enabled
+ * @retval #BT_ERROR_NOT_IN_PROGRESS Not activated
+ * @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().
+ * @see bt_initialize()
+ * @see bt_hid_device_activate()
+ */
+int bt_hid_device_deactivate(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Initiates the HID device connection with the Device role, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @remarks This function must be called to Initiate the HID device role connection.
+ *
+ * @param[in] remote_address The remote device's 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_NOT_IN_PROGRESS Not activated
+ * @retval #BT_ERROR_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #BT_ERROR_ALREADY_DONE Already connected
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The Bluetooth service must be initialized with bt_initialize().
+ * @pre The local device must be bonded with the remote device by bt_device_create_bond().
+ * @see bt_initialize()
+ * @see bt_hid_device_activate()
+ */
+int bt_hid_device_connect(const char *remote_address);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Disconnects from the HID Host device, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] remote_address The remote device's 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_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 Bluetooth service must be initialized with bt_initialize().
+ * @see bt_initialize()
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_disconnect(const char *remote_address);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Sends the mouse event data to the remote device.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] remote_address The remote device's address.
+ * @param[in] mouse_data The mouse data to be passed to the remote 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_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The HID connection must be established.
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_send_mouse_event(const char *remote_address,
+ const bt_hid_mouse_data_s *mouse_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Sends the keyboard event data to the remote device.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] remote_address The remote device's address.
+ * @param[in] key_data The key data to be passed to the remote 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_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The HID connection must be established.
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_send_key_event(const char *remote_address,
+ const bt_hid_key_data_s *key_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Sets the callback called when the device receives data from the HID Host.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] callback The callback function to be set when data is received.
+ * @param[in] user_data The user data to be passed to the callback.
+ * @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_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_set_data_received_cb(bt_hid_device_data_received_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Unsets the data received callback.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @retval #BT_ERROR_NONE Successful
+ * @retval #BT_ERROR_NOT_INITIALIZED Not initialized
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_unset_data_received_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Responds to reports from the HID Host.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] remote_address The remote device's address.
+ * @param[in] header_type The response header type
+ * @param[in] param_type The response parameter type
+ * @param[in] data The response data
+ * @param[in] data_len The length of the response data
+ * @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 The HID connection must be established.
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_reply_to_report(const char *remote_address,
+ bt_hid_header_type_e header_type,
+ bt_hid_param_type_e param_type,
+ const char *data, unsigned int data_len);
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Initializes the Bluetooth profiles related with audio.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Deinitializes the Bluetooth profiles related with audio.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Connects the remote device with the given audio profile, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Disconnects the remote device with the given audio profile, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Initializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Deinitializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the equalizer state to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] state The state of equalizer
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the repeat mode to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] mode The repeat mode
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the shuffle mode to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] mode The repeat mode
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the scan mode to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] mode The scan mode
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the player state to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] state The player state
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the current position of song to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] position The current position in milliseconds
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the track to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] title The title of track
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Registers a callback function that will be invoked when the equalizer state is changed.
- * @since_tizen 2.4
+ * @brief Registers a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Unregisters a callback function that will be invoked when the equalizer state is changed.
- * @since_tizen 2.4
+ * @brief Unregisters a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Registers a callback function that will be invoked when the repeat mode is changed.
- * @since_tizen 2.4
+ * @brief Registers a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Unregisters a callback function that will be invoked when the repeat mode is changed.
- * @since_tizen 2.4
+ * @brief Unregisters a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devi)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Registers a callback function that will be invoked when the shuffle mode is changed.
- * @since_tizen 2.4
+ * @brief Registers a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed.
- * @since_tizen 2.4
+ * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Registers a callback function that will be invoked when the scan mode is changed.
- * @since_tizen 2.4
+ * @brief Registers a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Unregisters a callback function that will be invoked when the scan mode is changed.
- * @since_tizen 2.4
+ * @brief Unregisters a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Registers a callback function that will be invoked when the song position is changed.
+ * @brief Registers a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices)
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Unregisters a callback function that will be invoked when the song position is changed.
+ * @brief Unregisters a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices)
* @since_tizen 3.0
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Registers a callback function that will be invoked when the Play status is changed.
+ * @brief Registers a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices)
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Unregisters a callback function that will be invoked when the Play status is changed.
+ * @brief Unregisters a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices)
* @since_tizen 3.0
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Registers a callback function that will be invoked when the track metadata is changed.
+ * @brief Registers a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices)
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Unregisters a callback function that will be invoked when the track metadata is changed.
+ * @brief Unregisters a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices)
* @since_tizen 3.0
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @remarks The @a app_id must be released with free() by you.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] app_id The ID of application
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Connects the remote device which acts as @a Source role, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Disconnects the remote device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Sends the data to the remote device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] channel The connected data channel
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Registers a callback function that will be invoked when you receive the data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Unregisters a callback function that will be invoked when you receive the data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @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).
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The address of the remote device
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] service The attribute handle of service
* @deprecated Deprecated since 2.3.1. Use bt_gatt_get_uuid instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Gets the UUID of service.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @remarks @a uuid must be released with free() by you.
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] service The attribute handle of service
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @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.
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] service The attribute handle of service
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] service The attribute handle of service
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @remarks @a uuid and @a value must be released with free() by you.
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] characteristic The attribute handle of characteristic
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] characteristic The attribute handle of characteristic
* @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
+* @since_tizen @if WEARABLE @else 2.3 @endif
* @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
*
* @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;
+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
+* @since_tizen @if WEARABLE @else 2.3 @endif
* @param[in] handle The attribute handle
* @return 0 on success, otherwise negative error value.
* @retval #BT_ERROR_NONE Successful
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] char_handle The attribute handle of characteristic
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] characteristic_handle The attribute handle of characteristic
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Disconnect to LE connection with the given remote Bluetooth device address, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register.
* @param[in] user_data The user data to be passed to the callback function.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
int bt_gatt_server_foreach_services(bt_gatt_server_h server,
bt_gatt_foreach_cb callback, void *user_data);
+
/**
- * @}
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Initializes the Bluetooth PBAP Client.
+ * @details This initialization is necessary to call other PBAP client APIs.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @remarks This function must be called to initialize Bluetooth PBAP client. You must free all resources of the Bluetooth service
+ * by calling bt_pbap_client_deinitialize() if Bluetooth PBAP Client 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_NOT_ENABLED Not enabled
+ * @retval #BT_ERROR_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The state of the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ *
+ * @see bt_pbap_client_deinitialize()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ * @see bt_pbap_client_get_phone_book_size()
+ * @see bt_pbap_client_get_phone_book()
+ * @see bt_pbap_client_get_list()
+ * @see bt_pbap_client_pull_vcard()
+ * @see bt_pbap_client_search_phone_book()
*/
+int bt_pbap_client_initialize(void);
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Deinitializes the Bluetooth PBAP Client.
+ * @details This deinitialization must be done to free resources when the PBAP client is not longer needed.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @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
+ *
+ * @pre The state of the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @see bt_pbap_client_deinitialize()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ * @see bt_pbap_client_get_phone_book_size()
+ * @see bt_pbap_client_get_phone_book()
+ * @see bt_pbap_client_get_list()
+ * @see bt_pbap_client_pull_vcard()
+ * @see bt_pbap_client_search_phone_book()
+ */
+int bt_pbap_client_deinitialize(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Registers a callback function that will be invoked when the connection state is changed.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @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 PBAP client must be initialized with bt_pbap_client_initialize().
+ * @see bt_pbap_client_initialize()
+ */
+int bt_pbap_client_set_connection_state_changed_cb(bt_pbap_connection_state_changed_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Unregisters a callback function that will be invoked when the connection state is changed.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @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 PBAP client must be initialized with bt_pbap_client_initialize().
+ * @see bt_pbap_client_initialize()
+ */
+int bt_pbap_client_unset_connection_state_changed_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Connects to PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's 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 Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre The local device must be bonded with the remote device by bt_device_create_bond().
+ * @post bt_pbap_connection_state_changed_cb() will be invoked.
+ * @see bt_pbap_client_disconnect()
+ * @see bt_pbap_client_set_connection_state_changed_cb()
+ */
+int bt_pbap_client_connect(const char *address);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Disconnects from PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's 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 Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ * @post bt_pbap_connection_state_changed_cb() will be invoked.
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_set_connection_state_changed_cb()
+ */
+int bt_pbap_client_disconnect(const char *address);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Gets size of phone book from PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of the phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] callback The callback function called when PBAP phone book size is returned.
+ * @param[in] user_data Data to be passed to the PBAP phone book size 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ *
+ * @see bt_pbap_client_connect()
+ */
+int bt_pbap_client_get_phone_book_size(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ bt_pbap_phone_book_size_cb callback,
+ void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Gets all contacts and call logs as vCard from PBAP server, asynchronously.
+ * @details The received phone book file will be saved in the platform downloads folder.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ * http://tizen.org/privilege/mediastorage
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] format The vCard format
+ * @param[in] order Specifies which field shall be used to sort vCards.
+ * @param[in] offset The number of vCards to be excluded, counting from the beginning
+ * @param[in] max_list_count The maximum number of vCards to be fetched
+ * @param[in] fields vCard fields to be fetched; one or more #bt_pbap_field_e values combined with bitwise 'or'
+ * @param[in] callback The callback function called when PBAP phone book is Pulled.
+ * @param[in] user_data Data to be passed to the PBAP phone book pulling 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ *
+ * @see bt_pbap_client_connect()
+ */
+int bt_pbap_client_get_phone_book(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ bt_pbap_vcard_format_e format,
+ bt_pbap_sort_order_e order,
+ unsigned short offset,
+ unsigned short max_list_count,
+ unsigned int fields,
+ bt_pbap_phone_book_received_cb callback,
+ void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Gets contact and call log information from the PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] order Specifies which field shall be used to sort vCards.
+ * @param[in] offset vCards to be excluded from beginning.
+ * @param[in] max_list_count Maximum number of vCards to be fetched
+ * @param[in] callback The callback function called when PBAP List is returned.
+ * @param[in] user_data Data to be passed to the PBAP phone book pulling 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ *
+ * @see bt_pbap_client_connect()
+ */
+int bt_pbap_client_get_list(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ bt_pbap_sort_order_e order,
+ unsigned short offset,
+ unsigned short max_list_count,
+ bt_pbap_list_vcards_cb callback,
+ void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Gets the selected contact using the index parameter as vCard from PBAP server, asynchronously.
+ * @details The received phone book file will be saved in the platform downloads folder.
+ * The @a index value should be equal to the value of the @a index field in the #bt_pbap_vcard_info_s structure,
+ * which can be obtained with bt_pbap_client_get_list() or bt_pbap_client_search_phone_book().
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ * http://tizen.org/privilege/mediastorage
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] index The handle index of vCard to be fetched
+ * @param[in] format Format of vCard
+ * @param[in] fields vCard fields to be fetched; one or more #bt_pbap_field_e values combined with bitwise 'or'
+ * @param[in] callback The callback function called when PBAP phone book is Pulled.
+ * @param[in] user_data Data to be passed to the PBAP phone book Pulling 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ * @pre The vCard information (#bt_pbap_vcard_info_s) must be obtained with bt_pbap_client_get_list() or bt_pbap_client_search_phone_book().
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_get_list()
+ * @see bt_pbap_client_search_phone_book()
+ */
+int bt_pbap_client_pull_vcard(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ int index,
+ bt_pbap_vcard_format_e format,
+ unsigned int fields,
+ bt_pbap_phone_book_received_cb callback,
+ void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Finds and fetches the contact and call log information from the PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] search_attribute field to be search
+ * @param[in] search_value pattern to be searched for
+ * @param[in] order Specifies which field shall be used to sort vCards.
+ * @param[in] offset vCards to be excluded from beginning.
+ * @param[in] max_list_count Maximum number of vCards to be fetched
+ * @param[in] callback The callback function called when PBAP List is returned.
+ * @param[in] user_data Data to be passed to the PBAP phone book pulling 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ *
+ * @see bt_pbap_client_connect()
+ */
+int bt_pbap_client_search_phone_book(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ bt_pbap_search_field_e search_attribute,
+ const char *search_value,
+ bt_pbap_sort_order_e order,
+ unsigned short offset,
+ unsigned short max_list_count,
+ bt_pbap_list_vcards_cb callback,
+ void *user_data);
+
+/**
+ * @}
+ */
#ifdef __cplusplus
}
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enables the local Bluetooth adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Disables the local Bluetooth adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Recover the local Bluetooth adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Reset the local Bluetooth adapter, synchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the version of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @remarks The @a local_version must be released with free() by you.
*
* @param[out] local_version The version of local Bluetooth adapter
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the information regarding local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @remarks The @a all parameters must be released with free() by you.
*
* @param[out] chipset Chipset name of local Bluetooth adapter
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the visibility mode.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the connectable state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the connectable state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks When connectable state is false, no device can connect to this device and visibility mode cannot be changed.
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the connectable state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
*/
int bt_adapter_unset_manufacturer_data_changed_cb(void);
-
/**
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enables the local Bluetooth le adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Disables the local Bluetooth le adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Gets the current state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] adapter_le_state The current adapter le state
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Registers a callback function to be invoked when the Bluetooth adapter le state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief add address to whitelist for accepting scanning request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief remove address from the whitelist for not accepting scanning request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief clear address from the whitelist for not accepting scanning request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Sets the Privacy feature state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Gets a connection state
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE Unsupported @else 2.4 @endif
*
* @param[in] remote_address The address of the remote Bluetooth device
* @param[in] link_type The link type to get a connection state
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Creates a bond with a remote Bluetooth device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Cancels service search process.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
+ * @brief Gets a connection state
+ * @since_tizen @if WEARABLE 2.4 @endif
+ *
+ * @param[in] remote_address The address of the remote Bluetooth device
+ * @param[in] link_type The link type to get a connection state
+ * @param[out] connected The connection state
+ *
+ * @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
+ */
+int bt_device_get_connection_state(const char *remote_address, bt_device_connection_link_type_e link_type, bool *connected);
+
+/**
+ * @internal
+ * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Sets a profile restricted connection for a device
* @since_tizen 3.0
* @privlevel platform
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Starts listening on passed rfcomm socket.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @details bt_socket_connection_requested_cb() will be called when a RFCOMM connection is requested.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Accepts a connection request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] requested_socket_fd The file descriptor of socket on which a connection is requested
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Rejects a connection request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] socket_fd The file descriptor of socket on which a connection is requested
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Initializes the Bluetooth OPP server requested by bt_opp_server_push_requested_cb().
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @details The popup appears when an OPP connection is requested from a remote device.
* If you accept the request, then connection will be established and bt_opp_server_push_requested_cb() will be called.
* At that time, you can call either bt_opp_server_accept() or bt_opp_server_reject().
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Notifies the call event to the remote bluetooth device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @remarks Before notifying #BT_AG_CALL_EVENT_ANSWERED or #BT_AG_CALL_EVENT_DIALING, you should open SCO(Synchronous Connection Oriented link)
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Notifies the call list to the remote bluetooth device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] list The call list
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Notifies the state of voice recognition.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] state The state of voice recognition: (@c true = enabled, @c false = disabled)
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Registers a callback function that will be invoked when a call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Unregisters a callback function that will be invoked when a call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Registers a callback function that will be invoked when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Unregisters a callback function that will be invoked when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Registers a callback function that will be invoked when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Unregisters a callback function that will be invoked when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Checks whether the remoted device enables NREC(Noise Reduction and Echo Canceling) or not.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[out] enabled The NREC status: (@c true = enabled, @c false = not enabled)
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Creates a handle of call list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[out] list The handle of call list
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Destroys the handle of call list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] list The handle of call list
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Resets the handle of call list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] list The handle of call list
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Adds a call to the handle of call list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] list The handle of call list
* @param[in] call_id The call ID
* @param[in] state The state of audio gate call
int bt_ag_is_connected(bool *connected);
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when the SCO(Synchronous Connection Oriented link) state is changed.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_sco_state_changed_cb()
+ * @see bt_ag_unset_sco_state_changed_cb()
+ */
+int bt_hf_set_sco_state_changed_cb(bt_hf_sco_state_changed_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when the SCO(Synchronous Connection Oriented link) state is changed.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_sco_state_changed_cb()
+ * @see bt_ag_set_sco_state_changed_cb()
+ */
+int bt_hf_unset_sco_state_changed_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when a call handling event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_call_handling_event_cb()
+ * @see bt_ag_unset_call_handling_event_cb()
+ */
+int bt_hf_set_call_handling_event_cb(bt_hf_call_handling_event_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when a call handling event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_call_handling_event_cb()
+ * @see bt_ag_set_call_handling_event_cb()
+ */
+int bt_hf_unset_call_handling_event_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when a multi call handling event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_multi_call_handling_event_cb()
+ * @see bt_ag_unset_multi_call_handling_event_cb()
+ */
+int bt_hf_set_multi_call_handling_event_cb(bt_hf_multi_call_handling_event_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when a multi call handling event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_multi_call_handling_event_cb()
+ * @see bt_ag_set_multi_call_handling_event_cb()
+ */
+int bt_hf_unset_multi_call_handling_event_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Initializes the Bluetooth HF profile related with audio.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @remarks This function must be called before Bluetooth profiles related with audio starts.
+ * @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
+ * @pre The Bluetooth service must be initialized with bt_initialize().
+ * @see bt_hf_deinitialize()
+ */
+int bt_hf_initialize(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Deinitializes the Bluetooth HF profile related with audio.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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
+ * @pre The Bluetooth audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ */
+int bt_hf_deinitialize(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Notifies the call event to the remote bluetooth device.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @remarks Before notifying #BT_HF_CALL_EVENT_ANSWERED or #BT_HF_CALL_EVENT_DIALING, you should open SCO(Synchronous Connection Oriented link)
+ * if Bluetooth Hands-Free need SCO connection.
+ * @param[in] event The call event
+ * @param[in] call_id The call ID
+ * @param[in] phone_number The phone number. You must set this value in case of #BT_HF_CALL_EVENT_DIALING and #BT_HF_CALL_EVENT_INCOMING.
+ * In other cases, 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_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 device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_notify_call_event(bt_hf_call_event_e event, char *phone_number);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Notifies the speaker gain to the remote device.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @details This function sends a signal to the remote device. This signal has the gain value.
+ * @a gain is represented on a scale from 0 to 15. This value is absolute value relating to a particular volume level.
+ * When the speaker gain of remote device is changed to the requested gain, bt_audio_speaker_gain_changed_cb() will be called.
+ * @param[in] gain The gain of speaker (0 ~ 15)
+ * @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
+ * @pre The remote device is connected by bt_audio_connect() with #BT_AUDIO_PROFILE_TYPE_HSP_HFP service.
+ * @see bt_hf_get_speaker_gain()
+ * @see bt_hf_set_speaker_gain_changed_cb()
+ * @see bt_hf_unset_speaker_gain_changed_cb()
+ */
+int bt_hf_notify_speaker_gain(int gain);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when the speaker gain of the remote device is changed.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @details This function let you know the change of the speaker gain of the remote device.
+ * @a gain is represented on a scale from 0 to 15. This value is absolute value relating to a particular volume level.
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_hf_unset_speaker_gain_changed_cb()
+ */
+int bt_hf_set_speaker_gain_changed_cb(bt_hf_speaker_gain_changed_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when the speaker gain of the remote device is changed.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_hf_set_speaker_gain_changed_cb()
+ */
+int bt_hf_unset_speaker_gain_changed_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Notifies the state of voice recognition.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @param[in] state The state of voice recognition: (@c true = enabled, @c false = disabled)
+ * @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
+ * @pre The Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_notify_voice_recognition_state(bool state);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when a call status event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_hf_unset_call_status_updated_event_cb()
+ */
+int bt_hf_set_call_status_updated_event_cb(bt_hf_call_status_updated_event_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when a call status event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_hf_set_call_status_updated_event_cb()
+ */
+int bt_hf_unset_call_status_updated_event_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Closes an opened SCO(Synchronous Connection Oriented link), synchronously.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @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
+ */
+int bt_hf_close_sco(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Sends the DTMF(Dual Tone Multi Frequency).
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @param[in] dtmf The DTMF to send
+ * @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 Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_send_dtmf(char *dtmf);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Gets the HF(Hands-Free) profile connected status for HF role.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @param[out] connected the connected status: (@c true = connected , @c false = not connected )
+ * @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_NOT_SUPPORTED Not supported
+ * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED.
+ */
+int bt_hf_is_connected(bool *connected);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Checks whether an opened SCO(Synchronous Connection Oriented link) exists or not.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[out] opened The SCO status: (@c true = opened, @c false = not opened)
+ * @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
+ *
+ * @pre The Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_is_sco_opened(bool *opened);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Gets the codec ID.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a codec_id must be released with free() by you.
+ *
+ * @param[out] codec_id The codec ID
+ * @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
+ *
+ * @pre The Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_get_codec_id(unsigned int *codec_id);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Gets the call status information list.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a call_list must be released with bt_hf_free_call_status_info_list() by you.
+ * @remarks call_info_list has elements which consist of bt_hf_call_status_info_s
+ *
+ * @param[out] call_list The call status information 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_NOT_ENABLED Not enabled
+ * @retval #BT_ERROR_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_hf_call_status_info_s
+ * @see bt_audio_connect()
+ */
+int bt_hf_get_call_status_info_list(GSList **call_list);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Frees the call status information list.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[in] call_list The call status information 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_NOT_SUPPORTED Not supported
+ *
+ * @see bt_hf_get_call_status_info_list()
+ */
+int bt_hf_free_call_status_info_list(GSList *call_list);
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_A2DP_MODULE
* @brief Sets copy protection. streaming application that needs to have the copy protection for the streaming data, shall invoke this API.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Activates the NAP(Network Access Point).
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Deactivates the NAP(Network Access Point).
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Disconnects the all PANUs(Personal Area Networking User) which are connected to you.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Disconnects the specified PANU(Personal Area Networking User) which is connected to you.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Registers a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Unregisters a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Registers a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Unregisters a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Connects the remote device with the PAN(Personal Area Networking) service, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Disconnects the remote device with the PAN(Personal Area Networking) service, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief update LE connection.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @return 0 on success, otherwise a negative error value.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Registers the method for HID Device role
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Unregisters the method for HID Device role
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Initiates HID device Connection with device role, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Disconnects the connection with HID Host device, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Sends the mouse event data.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Sends the keyboard event data.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Sets the callback when device gets some data from HID Host.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
*
* @param[in] callback callback function to be set when data is received.
* @param[in] user_data data from application which will be provided in callback.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Unsets the callback when device gets some data from HID Host.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
*
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Responds to the reports from HID Host.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Sends the custom event data.
- * @since_tizen 3.0
+ * @since_tizen @if WEAREABLE @else 3.0 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
int bt_pbap_client_is_connected(const char *address, bool *connected_status);
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @brief Sends the custom event data.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/bluetooth.admin
+ *
+ * @param[in] remote_address device address of remote device.
+ * @param[in] report_id reoport id need to be passed to remote device
+ * @param[in] data The data need to be passed to remote device
+ * @param[in] data_len The length of the 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_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @pre The HID connection must be established.
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_send_custom_event(const char *remote_address,
+ unsigned char report_id, const char *data, unsigned int data_len);
+
+/**
* @internal
* @brief Creates the Proximity Profile Reporter Role.
*/
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of PBAP fields.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_FIELD_ALL = (0xFFFFFFFFU), /**< All field */
+ BT_PBAP_FIELD_VERSION = (1U << 0), /**< vCard Version */
+ BT_PBAP_FIELD_FN = (1U << 1), /**< Formatted Name */
+ BT_PBAP_FIELD_N = (1U << 2), /**< Structured Presentation of Name */
+ BT_PBAP_FIELD_PHOTO = (1U << 3), /**< Associated Image or Photo */
+ BT_PBAP_FIELD_BDAY = (1U << 4), /**< Birthday */
+ BT_PBAP_FIELD_ADR = (1U << 5), /**< Delivery Address */
+ BT_PBAP_FIELD_LABEL = (1U << 6), /**< Delivery */
+ BT_PBAP_FIELD_TEL = (1U << 7), /**< Telephone Number */
+ BT_PBAP_FIELD_EMAIL = (1U << 8), /**< Electronic Mail Address */
+ BT_PBAP_FIELD_MAILER = (1U << 9), /**< Electronic Mail */
+ BT_PBAP_FIELD_TZ = (1U << 10), /**< Time Zone */
+ BT_PBAP_FIELD_GEO = (1U << 11), /**< Geographic Position */
+ BT_PBAP_FIELD_TITLE = (1U << 12), /**< Job */
+ BT_PBAP_FIELD_ROLE = (1U << 13), /**< Role within the Organization */
+ BT_PBAP_FIELD_LOGO = (1U << 14), /**< Organization Logo */
+ BT_PBAP_FIELD_AGENT = (1U << 15), /**< vCard of Person Representing */
+ BT_PBAP_FIELD_ORG = (1U << 16), /**< Name of Organization */
+ BT_PBAP_FIELD_NOTE = (1U << 17), /**< Comments */
+ BT_PBAP_FIELD_REV = (1U << 18), /**< Revision */
+ BT_PBAP_FIELD_SOUND = (1U << 19), /**< Pronunciation of Name */
+ BT_PBAP_FIELD_URL = (1U << 20), /**< Uniform Resource Locator */
+ BT_PBAP_FIELD_UID = (1U << 21), /**< Unique ID */
+ BT_PBAP_FIELD_KEY = (1U << 22), /**< Public Encryption Key */
+ BT_PBAP_FIELD_NICKNAME = (1U << 23), /**< Nickname */
+ BT_PBAP_FIELD_CATEGORIES = (1U << 24), /**< Categories */
+ BT_PBAP_FIELD_PROID = (1U << 25), /**< Product ID */
+ BT_PBAP_FIELD_CLASS = (1U << 26), /**< Class information */
+ BT_PBAP_FIELD_SORT_STRING = (1U << 27), /**< String used for sorting operations */
+ BT_PBAP_FIELD_X_IRMC_CALL_DATETIME = (1U << 28), /**< Time stamp */
+} bt_pbap_field_e;
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
* @brief Enumerations of Bluetooth error codes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enumerations of the Bluetooth adapter state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_DISABLED = 0x00, /**< Bluetooth adapter is disabled */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enumerations of the Bluetooth visibility mode.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE = 0x00, /**< Other devices cannot find your device via discovery */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enumerations of the discovery state of Bluetooth device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_DEVICE_DISCOVERY_STARTED, /**< Device discovery is started */
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the discovery state of Bluetooth LE device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
*/
typedef enum {
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth advertising state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_ADVERTISING_STOPPED = 0x00, /**< Bluetooth advertising is stopped */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth advertising filter policy.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_ADVERTISING_FILTER_DEFAULT = 0x00, /**< White list is not in use */
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth advertising type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_ADVERTISING_CONNECTABLE = 0x00, /**< Connectable undirected advertising (ADV_IND) */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth LE packet type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_PACKET_ADVERTISING, /**< Advertising packet */
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth LE data type
* that can be included in LE packets.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_PACKET_DATA_COMP_LIST_16_BIT_SERVICE_CLASS_UUIDS = 0x03, /**< Complete list of 16 bit UUIDs */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of device disconnect reason.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_DISCONNECT_REASON_UNKNOWN, /**< Disconnected by unknown reason */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of connection link type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_CONNECTION_LINK_BREDR, /**< BR/EDR link */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of device authorization state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_AUTHORIZED, /**< The remote Bluetooth device is authorized */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of Bluetooth profile.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_PROFILE_RFCOMM = 0x01, /**< RFCOMM Profile */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of device address type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_PUBLIC_ADDRESS = 0x00, /**< Public address */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of service class.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_SC_NONE = 0, /**< No service class */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of major service class.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_MAJOR_SERVICE_CLASS_LIMITED_DISCOVERABLE_MODE = 0x002000, /**< Limited discoverable mode */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of major device class.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_MAJOR_DEVICE_CLASS_MISC = 0x00, /**< Miscellaneous major device class*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of minor device class.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_MINOR_DEVICE_CLASS_COMPUTER_UNCATEGORIZED = 0x00, /**< Uncategorized minor device class of computer */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of gap appearance type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_APPEARANCE_TYPE_UNKNOWN = 0x00, /**< Unknown appearance type */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Enumerations of connected Bluetooth device event role.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_SOCKET_UNKNOWN = 0x00, /**< Unknown role*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Enumerations of Bluetooth socket connection state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_SOCKET_CONNECTED, /**< RFCOMM is connected */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Enumerations for the types of profiles related with audio
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AUDIO_PROFILE_TYPE_ALL = 0, /**< All supported profiles related with audio */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the call handling event
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_CALL_HANDLING_EVENT_ANSWER = 0x00, /**< Request to answer an incoming call */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the multi call handling event
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_MULTI_CALL_HANDLING_EVENT_RELEASE_HELD_CALLS = 0x00, /**< Request to release held calls */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the equalizer state
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_EQUALIZER_STATE_OFF = 0x01, /**< Equalizer Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the repeat mode
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_REPEAT_MODE_OFF = 0x01, /**< Repeat Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the shuffle mode
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_SHUFFLE_MODE_OFF = 0x01, /**< Shuffle Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the scan mode
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_SCAN_MODE_OFF = 0x01, /**< Scan Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Enumerations for the data channel type
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_HDP_CHANNEL_TYPE_RELIABLE = 0x01, /**< Reliable Data Channel */
* @since_tizen 3.0
*/
typedef enum {
- BT_GATT_PERMISSION_READ = 0x01, /**< Read permission */
- BT_GATT_PERMISSION_WRITE = 0x02, /**< Write permission */
+ BT_GATT_PERMISSION_READ = 0x01, /**< Readable permission */
+ BT_GATT_PERMISSION_WRITE = 0x02, /**< Writable permission */
BT_GATT_PERMISSION_ENCRYPT_READ = 0x04, /**< Readable permission required encryption */
BT_GATT_PERMISSION_ENCRYPT_WRITE = 0x08, /**< Writable permission required encryption */
- BT_GATT_PERMISSION_ENCRYPT_AUTHENTICATED_READ = 0x10, /**< Readable permission required encryption and authentication */
- BT_GATT_PERMISSION_ENCRYPT_AUTHENTICATED_WRITE = 0x20, /**< Writable permission required encryption and authentication */
+ BT_GATT_PERMISSION_ENCRYPT_AUTHENTICATED_READ = 0x10, /**< Readable permission required encryption and authentication */
+ BT_GATT_PERMISSION_ENCRYPT_AUTHENTICATED_WRITE = 0x20, /**< Writable permission required encryption and authentication */
} bt_gatt_permission_e;
/**
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Enumerations for the types of PAN(Personal Area Networking) service.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_PANU_SERVICE_TYPE_NAP = 0, /**< Network Access Point */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief The handle to control Bluetooth LE advertising.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef void *bt_advertiser_h;
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of address book location for PBAP.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_SOURCE_DEVICE = 0x00, /**< Request for Addressbook from remote device */
+ BT_PBAP_SOURCE_SIM , /**< Request for address book from SIM */
+} bt_pbap_address_book_source_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of folder type.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_FOLDER_PHONE_BOOK = 0x00, /**< Request for address book */
+ BT_PBAP_FOLDER_INCOMING , /**< Request for incoming calls */
+ BT_PBAP_FOLDER_OUTGOING , /**< Request for outgoing calls */
+ BT_PBAP_FOLDER_MISSED , /**< Request for missed calls */
+ BT_PBAP_FOLDER_COMBINED , /**< Request for combined calls */
+} bt_pbap_folder_type_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of phone book search fields.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_SEARCH_NAME = 0x00, /**< Request for search by name (default) */
+ BT_PBAP_SEARCH_NUMBER, /**< Request for search by phone number */
+ BT_PBAP_SEARCH_SOUND, /**< Request for search by sound */
+} bt_pbap_search_field_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of vCard Formats.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_VCARD_FORMAT_VCARD21 = 0x00, /**< vCard format 2.1 (default) */
+ BT_PBAP_VCARD_FORMAT_VCARD30, /**< vCard format 3.0 */
+} bt_pbap_vcard_format_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of sorting orders.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_ORDER_INDEXED = 0x00, /**< Filter order indexed (default) */
+ BT_PBAP_ORDER_ALPHANUMERIC, /**< Filter order alphanumeric */
+ BT_PBAP_ORDER_PHONETIC, /**< Filter order phonetic */
+} bt_pbap_sort_order_e;
+
+/**
* @deprecated Deprecated since 2.3.1. Use bt_gatt_h instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief The attribute handle of GATT(Generic Attribute Profile).
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*/
typedef void *bt_gatt_attribute_h;
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief The handle of calls state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef void *bt_call_list_h;
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Class structure of device and service.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see #bt_device_info_s
* @see #bt_adapter_device_discovery_info_s
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Structure of device discovery information.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see #bt_class_s
* @see bt_adapter_device_discovery_state_changed_cb()
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Structure of le device discovery information.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @see #bt_class_s
* @see bt_adapter_le_device_discovery_state_changed_cb()
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Structure of advertising parameters.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @see bt_adapter_le_advertising_state_changed_cb()
* @see bt_adapter_le_start_advertising()
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Device information structure used for identifying pear device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see #bt_class_s
* @see bt_device_bond_created_cb()
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Service Discovery Protocol (SDP) data structure.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This protocol is used for discovering available services or pear device,
* and finding one to connect with.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Device connection information structure.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see bt_device_connection_state_changed_cb()
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Rfcomm connection data used for exchanging data between Bluetooth devices.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see bt_socket_connection_state_changed_cb()
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Structure of RFCOMM received data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks User can use standard linux functions for reading/writing
* data from/to sockets.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the Bluetooth adapter state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the adapter state changing
* @param[in] adapter_state The adapter state to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when adapter name changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] device_name The name of the Bluetooth device to be changed
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the visibility mode changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the visibility mode changing
* @param[in] visibility_mode The visibility mode to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called every second until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks This callback function is called only if visibility mode is #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE.
* @param[in] duration The duration until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE (in seconds)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the state of device discovery changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks If \a discovery_state is #BT_ADAPTER_DEVICE_DISCOVERY_FOUND,
* then you can get some information, such as remote device address, remote device name, rssi, and bonding state.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when you get bonded devices repeatedly.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] device_info The bonded device information
* @param[in] user_data The user data passed from the foreach function
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Called when the state of LE device discovery changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @remarks If \a discovery_state is #BT_ADAPTER_LE_DEVICE_DISCOVERY_FOUND,
* then you can get some information, such as remote LE device address, remote device name, rssi, and bonding state.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Called when the state of advertiser changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] result The result of the requested state change of advertiser
* @param[out] advertiser The handle of the state changed advertiser
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the process of creating bond finishes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks If the remote user does not respond within 60 seconds, a time out will happen with #BT_ERROR_TIMED_OUT result code.\n
* If bt_device_cancel_bonding() is called and it returns #BT_ERROR_NONE, then this callback function will be called
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when you get connected profiles repeatedly.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] profile The connected Bluetooth profile
* @param[in] user_data The user data passed from the foreach function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the bond destroys.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result that a bond is destroyed
* @param[in] remote_address The address of the remote Bluetooth device to destroy bond with
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the authorization of device changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] authorization The authorization of device
* @param[in] remote_address The address of the remote Bluetooth device which is (un)authorized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the process of service search finishes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remark
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] connected The connection status: (@c true = connected, @c false = disconnected)
* @param[in] conn_info The connection information
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Called when you receive data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] data The received data from the remote device
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Called when the socket connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of connection state changing
* @param[in] connection_state The connection state
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Called when a RFCOMM connection is requested.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] socket_fd The file descriptor of socket on which a connection is requested
* @param[in] remote_address The address of remote device
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when an OPP connection is requested.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details You must call bt_opp_server_accept_connection() if you want to accept.
* Otherwise, you must call bt_opp_server_reject_connection().
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when a file is being transferred.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] file The path of file to be pushed
* @param[in] size The file size (bytes)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when a transfer is finished.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] error_code The result of push
* @param[in] file The path of file to be pushed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Called when OPP server responds to the push request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of OPP server response
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Called when each file is being transferred.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] file The path of file to be pushed
* @param[in] size The file size (bytes)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Called when the push request is finished.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the push request
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you call bt_audio_connect() or bt_audio_disconnect(), this callback is also called with error result even though these functions fail.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when a call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] event The call handling event happened from Hands-Free
* @param[in] call_id The call ID
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] event The call handling event happened from Hands-Free
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] dtmf The DTMF transmitted from Hands-Free
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when the speaker gain of the remote device is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] gain The gain of speaker (0 ~ 15)
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when the microphone gain of the remote device is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] gain The gain of microphone (0 ~ 15)
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] connected The state to be changed. @a true means connected state, Otherwise, @a false.
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the equalizer state is changed by the remote control device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] equalizer The equalizer state
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the repeat mode is changed by the remote control device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] repeat The repeat mode
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the shuffle mode is changed by the remote control device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] shuffle The shuffle mode
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the scan mode is changed by the remote control device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] shuffle The shuffle mode
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you call bt_hid_host_connect() or bt_hid_host_disconnect(), this callback is also called with error result even though these functions fail.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Called when the connection is established.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of connecting to the remote device
* @param[in] remote_address The address of connected remote device
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Called when the connection is disconnected.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of disconnecting from the remote device
* @param[in] remote_address The address of disconnected remote device
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Called when the you receive the data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] channel The connected data channel
* @param[in] data The received data
* @deprecated Deprecated since 2.3.1. Use bt_gatt_foreach_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when you get the primary services repeatedly.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] service The attribute handle of service
* @param[in] user_data The user data passed from the foreach function
* @deprecated Deprecated since 2.3.1. This is not required because characteristic discovery is happened automatically.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called after the characteristics are discovered by bt_gatt_discover_characteristics().
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @remarks If bt_gatt_discover_characteristics() failed, then this callback function is called only once with 0 total and NULL characteristic_handle.
* @param[in] result The result of discovering
* @deprecated Deprecated since 2.3.1. Use bt_gatt_foreach_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when you get the included services repeatedly.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] service The attribute handle of service
* @param[in] user_data The user data passed from the foreach function
* @deprecated Deprecated since 2.3.1. Use bt_gatt_client_characteristic_value_changed_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when a characteristic in service is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] characteristic The attribute handle of characteristic
* @param[in] value The value of characteristic (byte array)
* @deprecated Deprecated since 2.3.1. Use bt_gatt_client_request_completed_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when a characteristic value is written.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @see bt_gatt_set_characteristic_value()
*/
* @deprecated Deprecated since 2.3.1. Use bt_gatt_client_request_completed_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when a characteristic value is read.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] value The value of characteristic (byte array)
* @param[in] value_length The length of value
* @deprecated Deprecated since 2.3.1. This is not required because descriptor discovery is happened automatically.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called after the characteristics descriptors are discovered by bt_gatt_discover_characteristic_descriptor().
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] result The result of discovering
* @param[in] characteristic_format The format of the information data.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you called bt_gatt_connect() or bt_gatt_disconnect(), this callback is also called with error result even though these functions fail.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] connected Indicates whether a client is connected or disconnected
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you call bt_panu_connect() or bt_panu_disconnect(), this callback is also called with error result even though these functions fail.
*/
typedef void (*bt_panu_connection_state_changed_cb) (int result, bool connected, const char *remote_address, bt_panu_service_type_e type, void *user_data);
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Enumerations of the Bluetooth HID mouse's button.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_HID_MOUSE_BUTTON_NONE = 0x00, /**<The mouse's none value*/
+ BT_HID_MOUSE_BUTTON_LEFT = 0x01, /**<The mouse's left button value*/
+ BT_HID_MOUSE_BUTTON_RIGHT = 0x02, /**<The mouse's right button value*/
+ BT_HID_MOUSE_BUTTON_MIDDLE = 0x04 /**<The mouse's middle button value*/
+} bt_hid_mouse_button_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief The structure type containing the HID mouse event information.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @see bt_hid_device_send_mouse_event()
+ */
+typedef struct {
+ int buttons; /**< The button values, we can combine key's values when we pressed multiple mouse buttons*/
+ int axis_x; /**< The location's x value, -128 ~127 */
+ int axis_y; /**< The location's y value, -128 ~127 */
+ int padding; /**< The padding value, -128 ~127 */
+} bt_hid_mouse_data_s;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief The structure type containing the HID keyboard event information.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @details If you want to know more detail values, refer to http://www.usb.org/developers/hidpage/ and see "HID Usage Tables"
+ *
+ * @see bt_hid_device_send_key_event()
+ */
+typedef struct {
+ unsigned char modifier; /**< The modifier keys : such as shift, alt */
+ unsigned char key[8]; /**< The key value - currently pressed keys : Max 8 at once */
+} bt_hid_key_data_s;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Enumerations of the Bluetooth HID header type.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_HID_HEADER_HANDSHAKE, /**< The Bluetooth HID header type: Handshake */
+ BT_HID_HEADER_HID_CONTROL, /**< The Bluetooth HID header type: HID control */
+ BT_HID_HEADER_GET_REPORT, /**< The Bluetooth HID header type: Get report */
+ BT_HID_HEADER_SET_REPORT, /**< The Bluetooth HID header type: Set report */
+ BT_HID_HEADER_GET_PROTOCOL, /**< The Bluetooth HID header type: Get protocol */
+ BT_HID_HEADER_SET_PROTOCOL, /**< The Bluetooth HID header type: Set protocol */
+ BT_HID_HEADER_DATA, /**< The Bluetooth HID header type: Data */
+ BT_HID_HEADER_UNKNOWN /**< The Bluetooth HID header type: Unknown */
+} bt_hid_header_type_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Enumerations of the Bluetooth HID parameter type.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_HID_PARAM_DATA_RTYPE_INPUT, /**< Parameter type: Input */
+ BT_HID_PARAM_DATA_RTYPE_OUTPUT /**< Parameter type: Output */
+} bt_hid_param_type_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Enumerations of the Bluetooth HID handshake type.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_HID_HANDSHAKE_SUCCESSFUL = 0x00, /**< Handshake error code none */
+ BT_HID_HANDSHAKE_NOT_READY, /**< Handshake error code Not Ready */
+ BT_HID_HANDSHAKE_ERR_INVALID_REPORT_ID, /**< Handshake error code send invalid report id */
+ BT_HID_HANDSHAKE_ERR_UNSUPPORTED_REQUEST, /**< Handshake error code request unsupported request */
+ BT_HID_HANDSHAKE_ERR_INVALID_PARAMETER, /**< Handshake error code received invalid parameter */
+ BT_HID_HANDSHAKE_ERR_UNKNOWN = 0x0e, /**< unknown error */
+ BT_HID_HANDSHAKE_ERR_FATAL /**< Fatal error */
+} bt_hid_handshake_type_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief The structure type containing data received from the HID Host.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef struct {
+ const char *address; /**< The remote device's address */
+ bt_hid_header_type_e header_type; /**< The header type */
+ bt_hid_param_type_e param_type; /**< The parameter type */
+ int data_size; /**< The length of the received data */
+ const char *data; /**< The received data */
+} bt_hid_device_received_data_s;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Called when the Bluetooth HID Device connection state changes.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of changing the connection state.
+ * @param[in] connected The requested state. @a true means the connection is enabled, @a false means the connection is disabled.
+ * @param[in] remote_address The remote device's address
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_hid_device_activate()
+ */
+typedef void (*bt_hid_device_connection_state_changed_cb) (int result,
+ bool connected, const char *remote_address, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Called when the HID Device receives data from the HID Host.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] data The data received from the HID Host.
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_hid_device_set_data_received_cb()
+ */
+typedef void (*bt_hid_device_data_received_cb)(const bt_hid_device_received_data_s *data, void *user_data);
+/* HID device related type */
+
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief The structure type containing vCard information.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @see bt_pbap_client_pull_vcard()
+ */
+typedef struct {
+ int index; /**< The vcard index, used as a parameter for bt_pbap_client_pull_vcard() */
+ const char *contact_name; /**< The contact name of the vCard */
+} bt_pbap_vcard_info_s;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Called when PBAP is Connected or Disconnected.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of connecting to or disconnecting from the remote device
+ * @param[in] connected The PBAP connection status (@c true = connected, @c false = disconnected)
+ * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ */
+typedef void (*bt_pbap_connection_state_changed_cb)(int result, bool connected,
+ const char *remote_address, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Called when PBAP Phonebook size calculation completes.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of getting the phone book size
+ * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
+ * @param[in] size Size of Phonebook
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_pbap_client_get_phone_book_size()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ */
+typedef void (*bt_pbap_phone_book_size_cb)(int result, const char *remote_address,
+ int size, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Called when PBAP Phonebook Pull completes.
+ * @details The received phone book file will be saved in the platform downloads folder. \n
+ * The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of getting the phone book
+ * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
+ * @param[in] vcf_file The absolute path of the file in which the vCards are saved (@a vcf_file is valid only inside this function. To use outside the callback, make a copy. @a vcf_file should not be freed.)
+ * @param[in] successful true if the operation was successful, false if not
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_pbap_client_get_phone_book()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ */
+typedef void (*bt_pbap_phone_book_received_cb)(int result, const char *remote_address,
+ const char *vcf_file, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Called when PBAP List vCards completes.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of getting the vcard list
+ * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
+ * @param[in] vcard_info List of vcard information (@a vcard_info is valid only inside this function. To use outside the callback, make a copy. @a vcard_info should not be freed.)
+ * @param[in] count Number of contacts in the list
+ * @param[in] successful true if the operation was successful, false if not
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_pbap_client_get_list()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ */
+typedef void (*bt_pbap_list_vcards_cb)(int result, const char *remote_address,
+ const bt_pbap_vcard_info_s *vcard_info, int count, void *user_data);
+
#ifdef __cplusplus
}
#endif /* __cplusplus */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when the SCO(Synchronous Connection Oriented link) state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the SCO state is changed.
* When you call bt_ag_open_sco() or bt_ag_close_sco(), this callback is also called with error result even though these functions failed.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth adapter le state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_DISABLED = 0x00, /**< Bluetooth le is disabled */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Called when the Bluetooth adapter le state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the adapter state changing
* @param[in] adapter_le_state The adapter le state to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the call state
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_CALL_EVENT_IDLE = 0x00, /**< Idle */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the call state
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_CALL_STATE_IDLE = 0x00, /**< Idle state */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the connectable state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the connectable state changing
* @param[in] connectable The connectable to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when the push is requested.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details You must call bt_opp_server_accept() if you want to accept.
* Otherwise, you must call bt_opp_server_reject().
} bt_adapter_le_scan_type_e;
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Enumerations for the call handling event
+ * @since_tizen @if WEARABLE 2.3 @endif
+ */
+typedef enum {
+ BT_HF_CALL_HANDLING_EVENT_ANSWER = 0x00, /**< Request to answer an incoming call */
+ BT_HF_CALL_HANDLING_EVENT_RELEASE, /**< Request to release a call */
+ BT_HF_CALL_HANDLING_EVENT_REJECT, /**< Request to reject an incoming call */
+ BT_HF_CALL_HANDLING_EVENT_RING, /**< Request of ringing call */
+ BT_HF_CALL_HANDLING_EVENT_CALL_STARTED, /**< Request of Call started */
+ BT_HF_CALL_HANDLING_EVENT_CALL_ENDED, /**< Request of Call Ended */
+ BT_HF_CALL_HANDLING_EVENT_VOICE_RECOGNITION_ENABLED, /**< Request of voice recognition enabled */
+ BT_HF_CALL_HANDLING_EVENT_VOICE_RECOGNITION_DISABLED, /**< Request of voice recognition disabled */
+ BT_HF_CALL_HANDLING_EVENT_VENDOR_DEP_CMD, /**< Request of Vendor command */
+ BT_HF_CALL_HANDLING_EVENT_WAITING, /**< Request to waiting a call */
+ BT_HF_CALL_HANDLING_EVENT_HELD, /**< Request to hold a call */
+ BT_HF_CALL_HANDLING_EVENT_UNHELD, /**< Request to unhold calls */
+ BT_HF_CALL_HANDLING_EVENT_SWAPPED, /**< Request to swap calls */
+} bt_hf_call_handling_event_e;
+
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Enumerations for the multi call handling event
+ * @since_tizen @if WEARABLE 2.3 @endif
+ */
+typedef enum {
+ BT_HF_MULTI_CALL_HANDLING_EVENT_RELEASE_HELD_CALLS = 0x00, /**< Request to release held calls */
+ BT_HF_MULTI_CALL_HANDLING_EVENT_RELEASE_ACTIVE_CALLS, /**< Request to release active calls */
+ BT_HF_MULTI_CALL_HANDLING_EVENT_ACTIVATE_HELD_CALL, /**< Request to put active calls into hold state and activate another (held or waiting) call */
+ BT_HF_MULTI_CALL_HANDLING_EVENT_MERGE_CALLS, /**< Request to add a held call to the conversation */
+ BT_HF_MULTI_CALL_HANDLING_EVENT_EXPLICIT_CALL_TRANSFER, /**< Request to let a user who has two calls to connect these two calls together and release its connections to both other parties */
+} bt_hf_multi_call_handling_event_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Enumerations for the call state
+ * @since_tizen @if WEARABLE 2.3 @endif
+ */
+typedef enum {
+ BT_HF_CALL_EVENT_IDLE = 0x00, /**< Idle */
+ BT_HF_CALL_EVENT_ANSWER, /**< Answered */
+ BT_HF_CALL_EVENT_HOLD, /**< Held */
+ BT_HF_CALL_EVENT_RETRIEVE, /**< Retrieved */
+ BT_HF_CALL_EVENT_DIAL, /**< Dialing */
+ BT_HF_CALL_EVENT_ALERT, /**< Alerting */
+ BT_HF_CALL_EVENT_INCOMING, /**< Incoming */
+ BT_HF_CALL_EVENT_REDIAL, /**< Redialling */
+ BT_HF_CALL_EVENT_RELEASE_ALL_NONACTIVE_CALLS, /**< Release all nonactive calls */
+ BT_HF_CALL_EVENT_ACCEPT_AND_RELEASE, /**< Accept and Release */
+ BT_HF_CALL_EVENT_ACCEPT_AND_HOLD, /**< Accept and Hold */
+ BT_HF_CALL_EVENT_ADD_TO_CONVERSATION, /**< Add to the conversation */
+} bt_hf_call_event_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief HF Call status information.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ */
+typedef struct {
+ char *number; /**< Phone Number */
+ int direction; /**< Direction :Incoming(1), Outgoing(0) */
+ int status; /**< Call Status :Active(0), Held(1), Waiting(5), Dailing(2) */
+ int multi_party; /**< Multiparty/conf call: Yes(1), No(0) */
+ int index; /**< Call index/ID */
+} bt_hf_call_status_info_s;
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the manufacturer dat changes.
* @since_tizen 2.3
typedef bool (*bt_adapter_profile_connected_devices_cb)(const char *remote_address, void *user_data);
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when the SCO(Synchronous Connection Oriented link) state is changed.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ *
+ * @details This callback is called when the SCO state is changed.
+ * When you call bt_ag_open_sco() or bt_ag_close_sco(), this callback is also called with error result even though these functions failed.
+ * @param[in] result The result of changing the connection state
+ * @param[in] opened The state to be changed: (@c true = opened, @c false = not opened)
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_ag_set_sco_state_changed_cb()
+ * @see bt_ag_unset_sco_state_changed_cb()
+ * @see bt_ag_open_sco()
+ * @see bt_ag_close_sco()
+ */
+typedef void (*bt_hf_sco_state_changed_cb) (int result, bool opened, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when a call handling event happened from Hands-Free.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ *
+ * @param[in] event The call handling event happened from Hands-Free
+ * @param[in] call_id The call ID
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_ag_set_call_handling_event_cb()
+ * @see bt_ag_unset_call_handling_event_cb()
+ */
+typedef void (*bt_hf_call_handling_event_cb) (bt_hf_call_handling_event_e event, char *phone_number, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when a multi call handling event happened from Hands-Free.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ *
+ * @param[in] event The call handling event happened from Hands-Free
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_ag_set_multi_call_handling_event_cb()
+ * @see bt_ag_unset_multi_call_handling_event_cb()
+ */
+typedef void (*bt_hf_multi_call_handling_event_cb) (bt_hf_multi_call_handling_event_e event, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when the speaker gain of the remote device is changed.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ *
+ * @param[in] gain The gain of speaker (0 ~ 15)
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_hf_set_speaker_gain_changed_cb()
+ * @see bt_hf_unset_speaker_gain_changed_cb()
+ */
+typedef void (*bt_hf_speaker_gain_changed_cb) (int gain, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when a call status updated event happened from Hands-Free.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ * @remarks call_info_list has elements which consist of bt_hf_call_status_info_s
+ * @remarks The @a call_info_list must be released with bt_hf_free_call_status_info_list() by you.
+ *
+ * @param[in] event The call handling event happened from Hands-Free
+ * @param[in] call_id The call ID
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_hf_call_status_info_s
+ * @see bt_hf_set_call_status_updated_event_cb()
+ * @see bt_hf_unset_call_status_updated_event_cb()
+ */
+typedef void (*bt_hf_call_status_updated_event_cb) (GSList *call_info_list, void *user_data);
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DPM_MODULE
* @brief DPM BT allowance state
* @since_tizen 3.0
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Device LE connection update structure.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef struct {
unsigned int interval_min; /**< Minimum value for the connection event interval (msec) */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID mouse's button.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef enum {
BT_HID_MOUSE_BUTTON_NONE = 0x00, /**<The mouse's none value*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief The structure type containing the HID mouse event information.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*
* @see bt_hid_device_send_mouse_event()
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief The structure type containing the HID keyboard event information.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
* @details If you want to know more detail values, refer to http://www.usb.org/developers/hidpage/ and see "HID Usage Tables"
*
* @see bt_hid_device_send_key_event()
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID header type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef enum {
BT_HID_HEADER_HANDSHAKE, /**< The Bluetooth HID header type: Handshake */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID parameter type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef enum {
BT_HID_PARAM_DATA_RTYPE_INPUT, /**< Parameter type: Input */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID handshake type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef enum {
BT_HID_HANDSHAKE_SUCCESSFUL = 0x00, /**< Handshake error code none */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief The structure type containing data received from the HID Host.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef struct {
const char *address; /**< The remote device's address */
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*
* @param[in] result The result of changing the connection state.
* @param[in] connected The requested state. @a true means the connection is enabled, @false means the connection is disabled.
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*
* @param[in] data The data received from the HID Host.
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
* @brief Initializes the Bluetooth API.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
* @brief Releases all resources of the Bluetooth API.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks This function must be called if Bluetooth API is no longer needed.
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the current state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] adapter_state The current adapter state
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the address of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks The @a local_address must be released with free() by you.
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the name of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details Use this function to get the friendly name associated with Bluetooth
* device, retrieved by the remote Bluetooth devices.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the name of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the visibility mode of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Starts the device discovery, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Stops the device discovery, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Checks for the device discovery is in progress or not.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @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,
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Get the service mask from the uuid list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] uuids The UUID list of the device.
* @param[in] no_of_service The number of the UUID list count.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Retrieves the device information of all bonded devices.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param [in] callback The callback function to invoke
* @param [in] user_data The user data passed from the foreach function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the device information of a bonded device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Frees device info.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param [in] device_info The bonded device information
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Checks whether the UUID of service is used or not
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the Bluetooth adapter state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the visibility mode changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked every second
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* 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,
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the device discovery state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Get the Hash and Randmoizer value, synchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] hash The hash value received from the controller
* @param[out] randomizer The hash value received from the controller
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the Hash and Randmoizer value, synchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Deletes the Hash and Randomizer value, synchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Starts the LE device discovery.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Stops the LE device discovery, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @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,
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] advertiser The handle of advertiser
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Destroy advertiser.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] advertiser The handle of advertiser
*
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @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.
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] advertiser The handle of advertiser
* @param[in] pkt_type The packet type
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] advertiser The handle of advertiser
* @param[in] pkt_type The packet type to be cleared
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Start advertising with passed advertiser and advertising parameters.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Stops the advertising.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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_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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Creates a bond with a remote Bluetooth device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Cancels the bonding process.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Destroys the bond, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Sets an alias for the bonded device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Sets the authorization of a bonded device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Starts the search for services supported by the specified device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Gets the connected profiles.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Gets the profile connected status.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the bond creates.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the bond destroys.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the authorization of device changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function to be invoked when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Registers a rfcomm server socket with a specific UUID.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Removes the rfcomm server socket which was created using bt_socket_create_rfcomm().
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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,
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Starts listening on passed rfcomm socket and accepts connection requests.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @details Pop-up is shown automatically when a RFCOMM connection is requested.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Disconnects the RFCOMM connection with the given file descriptor of connected socket.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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().
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Sends data to the connected device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Register a callback function that will be invoked when you receive data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Register a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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().
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Deinitializes the Bluetooth OPP server.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Accepts the push request from the remote device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Rejects the push request from the remote device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Cancels the transfer.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] transfer_id The ID of transfer
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Sets the destination path of file to be pushed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] destination The destination path of file to be pushed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Initializes the Bluetooth OPP client.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Deinitializes the Bluetooth OPP client.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Adds file to be pushed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] file The path of file to be pushed
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Adds file to be pushed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Pushes the file to the remote device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Cancels the push request in progress, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
int bt_opp_client_cancel_push(void);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Initializes the Bluetooth HID(Human Interface Device) Host.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
int bt_hid_host_initialize(bt_hid_host_connection_state_changed_cb connection_cb, void *user_data);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Deinitializes the Bluetooth HID(Human Interface Device) Host.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
int bt_hid_host_deinitialize(void);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Connects the remote device with the HID(Human Interface Device) service, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
int bt_hid_host_connect(const char *remote_address);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Disconnects the remote device with the HID(Human Interface Device) service, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
int bt_hid_host_disconnect(const char *remote_address);
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Activates the Bluetooth HID Device role.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @remarks This function must be called to register HID UUID.
+ * Only then a remote device is able to identify this one as a HID device.
+ *
+ * @param[in] callback 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_NOT_ENABLED Not enabled
+ * @retval #BT_ERROR_NOW_IN_PROGRESS Already activated
+ * @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().
+ * @see bt_initialize()
+ * @see bt_hid_device_deactivate()
+ */
+int bt_hid_device_activate(bt_hid_device_connection_state_changed_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Deactivates the Bluetooth HID Device role.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @remarks This function must be called to deregister the HID 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_NOT_ENABLED Not enabled
+ * @retval #BT_ERROR_NOT_IN_PROGRESS Not activated
+ * @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().
+ * @see bt_initialize()
+ * @see bt_hid_device_activate()
+ */
+int bt_hid_device_deactivate(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Initiates the HID device connection with the Device role, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @remarks This function must be called to Initiate the HID device role connection.
+ *
+ * @param[in] remote_address The remote device's 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_NOT_IN_PROGRESS Not activated
+ * @retval #BT_ERROR_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #BT_ERROR_ALREADY_DONE Already connected
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The Bluetooth service must be initialized with bt_initialize().
+ * @pre The local device must be bonded with the remote device by bt_device_create_bond().
+ * @see bt_initialize()
+ * @see bt_hid_device_activate()
+ */
+int bt_hid_device_connect(const char *remote_address);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Disconnects from the HID Host device, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] remote_address The remote device's 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_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 Bluetooth service must be initialized with bt_initialize().
+ * @see bt_initialize()
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_disconnect(const char *remote_address);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Sends the mouse event data to the remote device.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] remote_address The remote device's address.
+ * @param[in] mouse_data The mouse data to be passed to the remote 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_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The HID connection must be established.
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_send_mouse_event(const char *remote_address,
+ const bt_hid_mouse_data_s *mouse_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Sends the keyboard event data to the remote device.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] remote_address The remote device's address.
+ * @param[in] key_data The key data to be passed to the remote 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_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The HID connection must be established.
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_send_key_event(const char *remote_address,
+ const bt_hid_key_data_s *key_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Sets the callback called when the device receives data from the HID Host.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] callback The callback function to be set when data is received.
+ * @param[in] user_data The user data to be passed to the callback.
+ * @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_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_set_data_received_cb(bt_hid_device_data_received_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Unsets the data received callback.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @retval #BT_ERROR_NONE Successful
+ * @retval #BT_ERROR_NOT_INITIALIZED Not initialized
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_unset_data_received_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Responds to reports from the HID Host.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel pubilc
+ * @privilege %http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] remote_address The remote device's address.
+ * @param[in] header_type The response header type
+ * @param[in] param_type The response parameter type
+ * @param[in] data The response data
+ * @param[in] data_len The length of the response data
+ * @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 The HID connection must be established.
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_reply_to_report(const char *remote_address,
+ bt_hid_header_type_e header_type,
+ bt_hid_param_type_e param_type,
+ const char *data, unsigned int data_len);
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Initializes the Bluetooth profiles related with audio.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Deinitializes the Bluetooth profiles related with audio.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Connects the remote device with the given audio profile, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Disconnects the remote device with the given audio profile, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Initializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Deinitializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the equalizer state to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] state The state of equalizer
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the repeat mode to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] mode The repeat mode
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the shuffle mode to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] mode The repeat mode
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the scan mode to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] mode The scan mode
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the player state to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] state The player state
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the current position of song to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] position The current position in milliseconds
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the track to the remote device.
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] title The title of track
/**
* @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 2.4
+ * @brief Registers a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @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 2.4
+ * @brief Unregisters a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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 2.4
+ * @brief Registers a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @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 2.4
+ * @brief Unregisters a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devi)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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 2.4
+ * @brief Registers a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @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 2.4
+ * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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 2.4
+ * @brief Registers a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @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 2.4
+ * @brief Unregisters a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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. (e.g., by a TV remote control or other input devices)
* @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
* @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. (e.g., by a TV remote control or other input devices)
* @since_tizen 3.0
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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. (e.g., by a TV remote control or other input devices)
* @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
/**
* @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. (e.g., by a TV remote control or other input devices)
* @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()
+ * @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. (e.g., by a TV remote control or other input devices)
* @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
/**
* @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. (e.g., by a TV remote control or other input devices)
* @since_tizen 3.0
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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.
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE
* @brief Gets the position of the song played by the remote device.
* @since_tizen 3.0
- * @param[out] mode The position, in milliseconds
+ * @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
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @remarks The @a app_id must be released with free() by you.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] app_id The ID of application
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Connects the remote device which acts as @a Source role, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Disconnects the remote device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Sends the data to the remote device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] channel The connected data channel
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Registers a callback function that will be invoked when you receive the data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Unregisters a callback function that will be invoked when you receive the data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @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).
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The address of the remote device
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] service The attribute handle of service
* @deprecated Deprecated since 2.3.1. Use bt_gatt_get_uuid instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Gets the UUID of service.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @remarks @a uuid must be released with free() by you.
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] service The attribute handle of service
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @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.
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] service The attribute handle of service
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] service The attribute handle of service
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @remarks @a uuid and @a value must be released with free() by you.
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] characteristic The attribute handle of characteristic
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] characteristic The attribute handle of characteristic
* @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
+* @since_tizen @if WEARABLE @else 2.3 @endif
* @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
* @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
+* @since_tizen @if WEARABLE @else 2.3 @endif
* @param[in] handle The attribute handle
* @return 0 on success, otherwise negative error value.
* @retval #BT_ERROR_NONE Successful
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] char_handle The attribute handle of characteristic
* @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.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] characteristic_handle The attribute handle of characteristic
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Disconnect to LE connection with the given remote Bluetooth device address, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register.
* @param[in] user_data The user data to be passed to the callback function.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @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
* @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
* @retval #BT_ERROR_NONE Successful
int bt_gatt_server_foreach_services(bt_gatt_server_h server,
bt_gatt_foreach_cb callback, void *user_data);
+
/**
- * @}
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Initializes the Bluetooth PBAP Client.
+ * @details This initialization is necessary to call other PBAP client APIs.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @remarks This function must be called to initialize Bluetooth PBAP client. You must free all resources of the Bluetooth service
+ * by calling bt_pbap_client_deinitialize() if Bluetooth PBAP Client 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_NOT_ENABLED Not enabled
+ * @retval #BT_ERROR_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The state of the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ *
+ * @see bt_pbap_client_deinitialize()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ * @see bt_pbap_client_get_phone_book_size()
+ * @see bt_pbap_client_get_phone_book()
+ * @see bt_pbap_client_get_list()
+ * @see bt_pbap_client_pull_vcard()
+ * @see bt_pbap_client_search_phone_book()
+ */
+int bt_pbap_client_initialize(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Deinitializes the Bluetooth PBAP Client.
+ * @details This deinitialization must be done to free resources when the PBAP client is not longer needed.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @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
+ *
+ * @pre The state of the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @see bt_pbap_client_deinitialize()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ * @see bt_pbap_client_get_phone_book_size()
+ * @see bt_pbap_client_get_phone_book()
+ * @see bt_pbap_client_get_list()
+ * @see bt_pbap_client_pull_vcard()
+ * @see bt_pbap_client_search_phone_book()
+ */
+int bt_pbap_client_deinitialize(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Registers a callback function that will be invoked when the connection state is changed.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @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 PBAP client must be initialized with bt_pbap_client_initialize().
+ * @see bt_pbap_client_initialize()
+ */
+int bt_pbap_client_set_connection_state_changed_cb(bt_pbap_connection_state_changed_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Unregisters a callback function that will be invoked when the connection state is changed.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @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 PBAP client must be initialized with bt_pbap_client_initialize().
+ * @see bt_pbap_client_initialize()
+ */
+int bt_pbap_client_unset_connection_state_changed_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Connects to PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's 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 Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre The local device must be bonded with the remote device by bt_device_create_bond().
+ * @post bt_pbap_connection_state_changed_cb() will be invoked.
+ * @see bt_pbap_client_disconnect()
+ * @see bt_pbap_client_set_connection_state_changed_cb()
*/
+int bt_pbap_client_connect(const char *address);
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Disconnects from PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's 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 Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ * @post bt_pbap_connection_state_changed_cb() will be invoked.
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_set_connection_state_changed_cb()
+ */
+int bt_pbap_client_disconnect(const char *address);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Gets size of phone book from PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of the phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] callback The callback function called when PBAP phone book size is returned.
+ * @param[in] user_data Data to be passed to the PBAP phone book size 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ *
+ * @see bt_pbap_client_connect()
+ */
+int bt_pbap_client_get_phone_book_size(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ bt_pbap_phone_book_size_cb callback,
+ void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Gets all contacts and call logs as vCard from PBAP server, asynchronously.
+ * @details The received phone book file will be saved in the platform downloads folder.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ * http://tizen.org/privilege/mediastorage
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] format The vCard format
+ * @param[in] order Specifies which field shall be used to sort vCards.
+ * @param[in] offset The number of vCards to be excluded, counting from the beginning
+ * @param[in] max_list_count The maximum number of vCards to be fetched
+ * @param[in] fields vCard fields to be fetched; one or more #bt_pbap_field_e values combined with bitwise 'or'
+ * @param[in] callback The callback function called when PBAP phone book is Pulled.
+ * @param[in] user_data Data to be passed to the PBAP phone book pulling 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ *
+ * @see bt_pbap_client_connect()
+ */
+int bt_pbap_client_get_phone_book(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ bt_pbap_vcard_format_e format,
+ bt_pbap_sort_order_e order,
+ unsigned short offset,
+ unsigned short max_list_count,
+ unsigned int fields,
+ bt_pbap_phone_book_received_cb callback,
+ void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Gets contact and call log information from the PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] order Specifies which field shall be used to sort vCards.
+ * @param[in] offset vCards to be excluded from beginning.
+ * @param[in] max_list_count Maximum number of vCards to be fetched
+ * @param[in] callback The callback function called when PBAP List is returned.
+ * @param[in] user_data Data to be passed to the PBAP phone book pulling 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ *
+ * @see bt_pbap_client_connect()
+ */
+int bt_pbap_client_get_list(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ bt_pbap_sort_order_e order,
+ unsigned short offset,
+ unsigned short max_list_count,
+ bt_pbap_list_vcards_cb callback,
+ void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Gets the selected contact using the index parameter as vCard from PBAP server, asynchronously.
+ * @details The received phone book file will be saved in the platform downloads folder.
+ * The @a index value should be equal to the value of the @a index field in the #bt_pbap_vcard_info_s structure,
+ * which can be obtained with bt_pbap_client_get_list() or bt_pbap_client_search_phone_book().
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ * http://tizen.org/privilege/mediastorage
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] index The handle index of vCard to be fetched
+ * @param[in] format Format of vCard
+ * @param[in] fields vCard fields to be fetched; one or more #bt_pbap_field_e values combined with bitwise 'or'
+ * @param[in] callback The callback function called when PBAP phone book is Pulled.
+ * @param[in] user_data Data to be passed to the PBAP phone book Pulling 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ * @pre The vCard information (#bt_pbap_vcard_info_s) must be obtained with bt_pbap_client_get_list() or bt_pbap_client_search_phone_book().
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_get_list()
+ * @see bt_pbap_client_search_phone_book()
+ */
+int bt_pbap_client_pull_vcard(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ int index,
+ bt_pbap_vcard_format_e format,
+ unsigned int fields,
+ bt_pbap_phone_book_received_cb callback,
+ void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Finds and fetches the contact and call log information from the PBAP server, asynchronously.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel public
+ * @privilege http://tizen.org/privilege/bluetooth
+ *
+ * @param[in] address The other device's address
+ * @param[in] source Source of phone book (Phone/SIM)
+ * @param[in] folder_type Type of folder
+ * @param[in] search_attribute field to be search
+ * @param[in] search_value pattern to be searched for
+ * @param[in] order Specifies which field shall be used to sort vCards.
+ * @param[in] offset vCards to be excluded from beginning.
+ * @param[in] max_list_count Maximum number of vCards to be fetched
+ * @param[in] callback The callback function called when PBAP List is returned.
+ * @param[in] user_data Data to be passed to the PBAP phone book pulling 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_NOT_ENABLED Adapter is 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 the local Bluetooth adapter must be #BT_ADAPTER_ENABLED.
+ * @pre The PBAP client must be initialized with bt_pbap_client_initialize().
+ * @pre PBAP connection must be created with bt_pbap_client_connect().
+ *
+ * @see bt_pbap_client_connect()
+ */
+int bt_pbap_client_search_phone_book(const char *address,
+ bt_pbap_address_book_source_e source,
+ bt_pbap_folder_type_e folder_type,
+ bt_pbap_search_field_e search_attribute,
+ const char *search_value,
+ bt_pbap_sort_order_e order,
+ unsigned short offset,
+ unsigned short max_list_count,
+ bt_pbap_list_vcards_cb callback,
+ void *user_data);
+
+/**
+ * @}
+ */
#ifdef __cplusplus
}
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enables the local Bluetooth adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Disables the local Bluetooth adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Recover the local Bluetooth adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Reset the local Bluetooth adapter, synchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the version of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @remarks The @a local_version must be released with free() by you.
*
* @param[out] local_version The version of local Bluetooth adapter
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the information regarding local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @remarks The @a all parameters must be released with free() by you.
*
* @param[out] chipset Chipset name of local Bluetooth adapter
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the visibility mode.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the connectable state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the connectable state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks When connectable state is false, no device can connect to this device and visibility mode cannot be changed.
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the connectable state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
*/
int bt_adapter_unset_manufacturer_data_changed_cb(void);
-
/**
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enables the local Bluetooth le adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Disables the local Bluetooth le adapter, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Gets the current state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] adapter_le_state The current adapter le state
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Registers a callback function to be invoked when the Bluetooth adapter le state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief add address to whitelist for accepting scanning request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief remove address from the whitelist for not accepting scanning request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief clear address from the whitelist for not accepting scanning request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Sets the Privacy feature state of local Bluetooth adapter.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Gets a connection state
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE @else 2.4 @endif
*
* @param[in] remote_address The address of the remote Bluetooth device
* @param[in] link_type The link type to get a connection state
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Creates a bond with a remote Bluetooth device, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Cancels service search process.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
+ * @brief Gets a connection state
+ * @since_tizen @if WEARABLE 2.4 @endif
+ *
+ * @param[in] remote_address The address of the remote Bluetooth device
+ * @param[in] link_type The link type to get a connection state
+ * @param[out] connected The connection state
+ *
+ * @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
+ */
+int bt_device_get_connection_state(const char *remote_address, bt_device_connection_link_type_e link_type, bool *connected);
+
+/**
+ * @internal
+ * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Sets a profile restricted connection for a device
* @since_tizen 3.0
* @privlevel platform
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Starts listening on passed rfcomm socket.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @details bt_socket_connection_requested_cb() will be called when a RFCOMM connection is requested.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Accepts a connection request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] requested_socket_fd The file descriptor of socket on which a connection is requested
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Rejects a connection request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] socket_fd The file descriptor of socket on which a connection is requested
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Initializes the Bluetooth OPP server requested by bt_opp_server_push_requested_cb().
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @details The popup appears when an OPP connection is requested from a remote device.
* If you accept the request, then connection will be established and bt_opp_server_push_requested_cb() will be called.
* At that time, you can call either bt_opp_server_accept() or bt_opp_server_reject().
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Notifies the call event to the remote bluetooth device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @remarks Before notifying #BT_AG_CALL_EVENT_ANSWERED or #BT_AG_CALL_EVENT_DIALING, you should open SCO(Synchronous Connection Oriented link)
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Notifies the call list to the remote bluetooth device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] list The call list
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Notifies the state of voice recognition.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] state The state of voice recognition: (@c true = enabled, @c false = disabled)
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Registers a callback function that will be invoked when a call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Unregisters a callback function that will be invoked when a call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Registers a callback function that will be invoked when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Unregisters a callback function that will be invoked when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Registers a callback function that will be invoked when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Unregisters a callback function that will be invoked when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Checks whether the remoted device enables NREC(Noise Reduction and Echo Canceling) or not.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[out] enabled The NREC status: (@c true = enabled, @c false = not enabled)
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Creates a handle of call list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[out] list The handle of call list
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Destroys the handle of call list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] list The handle of call list
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Resets the handle of call list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] list The handle of call list
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Adds a call to the handle of call list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] list The handle of call list
* @param[in] call_id The call ID
* @param[in] state The state of audio gate call
int bt_ag_is_connected(bool *connected);
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when the SCO(Synchronous Connection Oriented link) state is changed.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_sco_state_changed_cb()
+ * @see bt_ag_unset_sco_state_changed_cb()
+ */
+int bt_hf_set_sco_state_changed_cb(bt_hf_sco_state_changed_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when the SCO(Synchronous Connection Oriented link) state is changed.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_sco_state_changed_cb()
+ * @see bt_ag_set_sco_state_changed_cb()
+ */
+int bt_hf_unset_sco_state_changed_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when a call handling event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_call_handling_event_cb()
+ * @see bt_ag_unset_call_handling_event_cb()
+ */
+int bt_hf_set_call_handling_event_cb(bt_hf_call_handling_event_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when a call handling event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_call_handling_event_cb()
+ * @see bt_ag_set_call_handling_event_cb()
+ */
+int bt_hf_unset_call_handling_event_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when a multi call handling event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_multi_call_handling_event_cb()
+ * @see bt_ag_unset_multi_call_handling_event_cb()
+ */
+int bt_hf_set_multi_call_handling_event_cb(bt_hf_multi_call_handling_event_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when a multi call handling event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_ag_multi_call_handling_event_cb()
+ * @see bt_ag_set_multi_call_handling_event_cb()
+ */
+int bt_hf_unset_multi_call_handling_event_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Initializes the Bluetooth HF profile related with audio.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @remarks This function must be called before Bluetooth profiles related with audio starts.
+ * @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
+ * @pre The Bluetooth service must be initialized with bt_initialize().
+ * @see bt_hf_deinitialize()
+ */
+int bt_hf_initialize(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Deinitializes the Bluetooth HF profile related with audio.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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
+ * @pre The Bluetooth audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ */
+int bt_hf_deinitialize(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Notifies the call event to the remote bluetooth device.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @remarks Before notifying #BT_HF_CALL_EVENT_ANSWERED or #BT_HF_CALL_EVENT_DIALING, you should open SCO(Synchronous Connection Oriented link)
+ * if Bluetooth Hands-Free need SCO connection.
+ * @param[in] event The call event
+ * @param[in] call_id The call ID
+ * @param[in] phone_number The phone number. You must set this value in case of #BT_HF_CALL_EVENT_DIALING and #BT_HF_CALL_EVENT_INCOMING.
+ * In other cases, 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_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 device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_notify_call_event(bt_hf_call_event_e event, char *phone_number);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Notifies the speaker gain to the remote device.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @details This function sends a signal to the remote device. This signal has the gain value.
+ * @a gain is represented on a scale from 0 to 15. This value is absolute value relating to a particular volume level.
+ * When the speaker gain of remote device is changed to the requested gain, bt_audio_speaker_gain_changed_cb() will be called.
+ * @param[in] gain The gain of speaker (0 ~ 15)
+ * @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
+ * @pre The remote device is connected by bt_audio_connect() with #BT_AUDIO_PROFILE_TYPE_HSP_HFP service.
+ * @see bt_hf_get_speaker_gain()
+ * @see bt_hf_set_speaker_gain_changed_cb()
+ * @see bt_hf_unset_speaker_gain_changed_cb()
+ */
+int bt_hf_notify_speaker_gain(int gain);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when the speaker gain of the remote device is changed.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @details This function let you know the change of the speaker gain of the remote device.
+ * @a gain is represented on a scale from 0 to 15. This value is absolute value relating to a particular volume level.
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_hf_unset_speaker_gain_changed_cb()
+ */
+int bt_hf_set_speaker_gain_changed_cb(bt_hf_speaker_gain_changed_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when the speaker gain of the remote device is changed.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_hf_set_speaker_gain_changed_cb()
+ */
+int bt_hf_unset_speaker_gain_changed_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Notifies the state of voice recognition.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @param[in] state The state of voice recognition: (@c true = enabled, @c false = disabled)
+ * @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
+ * @pre The Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_notify_voice_recognition_state(bool state);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Registers a callback function that will be invoked when a call status event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_hf_unset_call_status_updated_event_cb()
+ */
+int bt_hf_set_call_status_updated_event_cb(bt_hf_call_status_updated_event_cb callback, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Unregisters a callback function that will be invoked when a call status event happened from Hands-Free.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @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 audio service must be initialized with bt_audio_initialize().
+ * @see bt_audio_initialize()
+ * @see bt_hf_set_call_status_updated_event_cb()
+ */
+int bt_hf_unset_call_status_updated_event_cb(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Closes an opened SCO(Synchronous Connection Oriented link), synchronously.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @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
+ */
+int bt_hf_close_sco(void);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Sends the DTMF(Dual Tone Multi Frequency).
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @privlevel platform
+ * @privilege http://tizen.org/privilege/bluetooth.admin
+ * @param[in] dtmf The DTMF to send
+ * @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 Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_send_dtmf(char *dtmf);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Gets the HF(Hands-Free) profile connected status for HF role.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @param[out] connected the connected status: (@c true = connected , @c false = not connected )
+ * @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_NOT_SUPPORTED Not supported
+ * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED.
+ */
+int bt_hf_is_connected(bool *connected);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Checks whether an opened SCO(Synchronous Connection Oriented link) exists or not.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[out] opened The SCO status: (@c true = opened, @c false = not opened)
+ * @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
+ *
+ * @pre The Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_is_sco_opened(bool *opened);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Gets the codec ID.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a codec_id must be released with free() by you.
+ *
+ * @param[out] codec_id The codec ID
+ * @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
+ *
+ * @pre The Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_audio_connect()
+ */
+int bt_hf_get_codec_id(unsigned int *codec_id);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Gets the call status information list.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a call_list must be released with bt_hf_free_call_status_info_list() by you.
+ * @remarks call_info_list has elements which consist of bt_hf_call_status_info_s
+ *
+ * @param[out] call_list The call status information 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_NOT_ENABLED Not enabled
+ * @retval #BT_ERROR_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
+ *
+ * @pre The Bluetooth audio device must be connected with bt_audio_connect().
+ * @see bt_hf_call_status_info_s
+ * @see bt_audio_connect()
+ */
+int bt_hf_get_call_status_info_list(GSList **call_list);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Frees the call status information list.
+ * @since_tizen @if MOBILE @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[in] call_list The call status information 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_NOT_SUPPORTED Not supported
+ *
+ * @see bt_hf_get_call_status_info_list()
+ */
+int bt_hf_free_call_status_info_list(GSList *call_list);
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_A2DP_MODULE
* @brief Sets copy protection. streaming application that needs to have the copy protection for the streaming data, shall invoke this API.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Activates the NAP(Network Access Point).
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Deactivates the NAP(Network Access Point).
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Disconnects the all PANUs(Personal Area Networking User) which are connected to you.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Disconnects the specified PANU(Personal Area Networking User) which is connected to you.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Registers a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Unregisters a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Registers a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Unregisters a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Connects the remote device with the PAN(Personal Area Networking) service, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Disconnects the remote device with the PAN(Personal Area Networking) service, asynchronously.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief update LE connection.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @return 0 on success, otherwise a negative error value.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Registers the method for HID Device role
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Unregisters the method for HID Device role
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Initiates HID device Connection with device role, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Disconnects the connection with HID Host device, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Sends the mouse event data.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Sends the keyboard event data.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Sets the callback when device gets some data from HID Host.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
*
* @param[in] callback callback function to be set when data is received.
* @param[in] user_data data from application which will be provided in callback.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Unsets the callback when device gets some data from HID Host.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
*
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Responds to the reports from HID Host.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEAREABLE @else 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Sends the custom event data.
- * @since_tizen 3.0
+ * @since_tizen @if WEAREABLE @else 3.0 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
int bt_pbap_client_is_connected(const char *address, bool *connected_status);
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
+ * @brief Sends the custom event data.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/bluetooth.admin
+ *
+ * @param[in] remote_address device address of remote device.
+ * @param[in] report_id reoport id need to be passed to remote device
+ * @param[in] data The data need to be passed to remote device
+ * @param[in] data_len The length of the 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_OPERATION_FAILED Operation failed
+ * @retval #BT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @pre The HID connection must be established.
+ * @see bt_hid_device_connection_state_changed_cb()
+ */
+int bt_hid_device_send_custom_event(const char *remote_address,
+ unsigned char report_id, const char *data, unsigned int data_len);
+
+/**
* @internal
* @brief Creates the Proximity Profile Reporter Role.
*/
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of PBAP fields.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_FIELD_ALL = (0xFFFFFFFFU), /**< All field */
+ BT_PBAP_FIELD_VERSION = (1U << 0), /**< vCard Version */
+ BT_PBAP_FIELD_FN = (1U << 1), /**< Formatted Name */
+ BT_PBAP_FIELD_N = (1U << 2), /**< Structured Presentation of Name */
+ BT_PBAP_FIELD_PHOTO = (1U << 3), /**< Associated Image or Photo */
+ BT_PBAP_FIELD_BDAY = (1U << 4), /**< Birthday */
+ BT_PBAP_FIELD_ADR = (1U << 5), /**< Delivery Address */
+ BT_PBAP_FIELD_LABEL = (1U << 6), /**< Delivery */
+ BT_PBAP_FIELD_TEL = (1U << 7), /**< Telephone Number */
+ BT_PBAP_FIELD_EMAIL = (1U << 8), /**< Electronic Mail Address */
+ BT_PBAP_FIELD_MAILER = (1U << 9), /**< Electronic Mail */
+ BT_PBAP_FIELD_TZ = (1U << 10), /**< Time Zone */
+ BT_PBAP_FIELD_GEO = (1U << 11), /**< Geographic Position */
+ BT_PBAP_FIELD_TITLE = (1U << 12), /**< Job */
+ BT_PBAP_FIELD_ROLE = (1U << 13), /**< Role within the Organization */
+ BT_PBAP_FIELD_LOGO = (1U << 14), /**< Organization Logo */
+ BT_PBAP_FIELD_AGENT = (1U << 15), /**< vCard of Person Representing */
+ BT_PBAP_FIELD_ORG = (1U << 16), /**< Name of Organization */
+ BT_PBAP_FIELD_NOTE = (1U << 17), /**< Comments */
+ BT_PBAP_FIELD_REV = (1U << 18), /**< Revision */
+ BT_PBAP_FIELD_SOUND = (1U << 19), /**< Pronunciation of Name */
+ BT_PBAP_FIELD_URL = (1U << 20), /**< Uniform Resource Locator */
+ BT_PBAP_FIELD_UID = (1U << 21), /**< Unique ID */
+ BT_PBAP_FIELD_KEY = (1U << 22), /**< Public Encryption Key */
+ BT_PBAP_FIELD_NICKNAME = (1U << 23), /**< Nickname */
+ BT_PBAP_FIELD_CATEGORIES = (1U << 24), /**< Categories */
+ BT_PBAP_FIELD_PROID = (1U << 25), /**< Product ID */
+ BT_PBAP_FIELD_CLASS = (1U << 26), /**< Class information */
+ BT_PBAP_FIELD_SORT_STRING = (1U << 27), /**< String used for sorting operations */
+ BT_PBAP_FIELD_X_IRMC_CALL_DATETIME = (1U << 28), /**< Time stamp */
+} bt_pbap_field_e;
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
* @brief Enumerations of Bluetooth error codes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enumerations of the Bluetooth adapter state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_DISABLED = 0x00, /**< Bluetooth adapter is disabled */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enumerations of the Bluetooth visibility mode.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE = 0x00, /**< Other devices cannot find your device via discovery */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enumerations of the discovery state of Bluetooth device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_DEVICE_DISCOVERY_STARTED, /**< Device discovery is started */
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the discovery state of Bluetooth LE device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
*/
typedef enum {
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth advertising state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_ADVERTISING_STOPPED = 0x00, /**< Bluetooth advertising is stopped */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth advertising filter policy.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_ADVERTISING_FILTER_DEFAULT = 0x00, /**< White list is not in use */
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth advertising type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_ADVERTISING_CONNECTABLE = 0x00, /**< Connectable undirected advertising (ADV_IND) */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth LE packet type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_PACKET_ADVERTISING, /**< Advertising packet */
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth LE data type
* that can be included in LE packets.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_PACKET_DATA_COMP_LIST_16_BIT_SERVICE_CLASS_UUIDS = 0x03, /**< Complete list of 16 bit UUIDs */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of device disconnect reason.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_DISCONNECT_REASON_UNKNOWN, /**< Disconnected by unknown reason */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of connection link type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_CONNECTION_LINK_BREDR, /**< BR/EDR link */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of device authorization state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_AUTHORIZED, /**< The remote Bluetooth device is authorized */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of Bluetooth profile.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_PROFILE_RFCOMM = 0x01, /**< RFCOMM Profile */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of device address type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_PUBLIC_ADDRESS = 0x00, /**< Public address */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of service class.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_SC_NONE = 0, /**< No service class */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of major service class.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_MAJOR_SERVICE_CLASS_LIMITED_DISCOVERABLE_MODE = 0x002000, /**< Limited discoverable mode */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of major device class.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_MAJOR_DEVICE_CLASS_MISC = 0x00, /**< Miscellaneous major device class*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of minor device class.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_MINOR_DEVICE_CLASS_COMPUTER_UNCATEGORIZED = 0x00, /**< Uncategorized minor device class of computer */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of gap appearance type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_APPEARANCE_TYPE_UNKNOWN = 0x00, /**< Unknown appearance type */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Enumerations of connected Bluetooth device event role.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_SOCKET_UNKNOWN = 0x00, /**< Unknown role*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Enumerations of Bluetooth socket connection state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_SOCKET_CONNECTED, /**< RFCOMM is connected */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Enumerations for the types of profiles related with audio
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AUDIO_PROFILE_TYPE_ALL = 0, /**< All supported profiles related with audio */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the call handling event
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_CALL_HANDLING_EVENT_ANSWER = 0x00, /**< Request to answer an incoming call */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the multi call handling event
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_MULTI_CALL_HANDLING_EVENT_RELEASE_HELD_CALLS = 0x00, /**< Request to release held calls */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the equalizer state
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_EQUALIZER_STATE_OFF = 0x01, /**< Equalizer Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the repeat mode
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_REPEAT_MODE_OFF = 0x01, /**< Repeat Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the shuffle mode
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_SHUFFLE_MODE_OFF = 0x01, /**< Shuffle Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the scan mode
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_SCAN_MODE_OFF = 0x01, /**< Scan Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Enumerations for the data channel type
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_HDP_CHANNEL_TYPE_RELIABLE = 0x01, /**< Reliable Data Channel */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Enumerations for the types of PAN(Personal Area Networking) service.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_PANU_SERVICE_TYPE_NAP = 0, /**< Network Access Point */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief The handle to control Bluetooth LE advertising.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef void *bt_advertiser_h;
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of address book location for PBAP.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_SOURCE_DEVICE = 0x00, /**< Request for Addressbook from remote device */
+ BT_PBAP_SOURCE_SIM , /**< Request for address book from SIM */
+} bt_pbap_address_book_source_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of folder type.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_FOLDER_PHONE_BOOK = 0x00, /**< Request for address book */
+ BT_PBAP_FOLDER_INCOMING , /**< Request for incoming calls */
+ BT_PBAP_FOLDER_OUTGOING , /**< Request for outgoing calls */
+ BT_PBAP_FOLDER_MISSED , /**< Request for missed calls */
+ BT_PBAP_FOLDER_COMBINED , /**< Request for combined calls */
+} bt_pbap_folder_type_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of phone book search fields.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_SEARCH_NAME = 0x00, /**< Request for search by name (default) */
+ BT_PBAP_SEARCH_NUMBER, /**< Request for search by phone number */
+ BT_PBAP_SEARCH_SOUND, /**< Request for search by sound */
+} bt_pbap_search_field_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of vCard Formats.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_VCARD_FORMAT_VCARD21 = 0x00, /**< vCard format 2.1 (default) */
+ BT_PBAP_VCARD_FORMAT_VCARD30, /**< vCard format 3.0 */
+} bt_pbap_vcard_format_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Enumeration of sorting orders.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_PBAP_ORDER_INDEXED = 0x00, /**< Filter order indexed (default) */
+ BT_PBAP_ORDER_ALPHANUMERIC, /**< Filter order alphanumeric */
+ BT_PBAP_ORDER_PHONETIC, /**< Filter order phonetic */
+} bt_pbap_sort_order_e;
+
+/**
* @deprecated Deprecated since 2.3.1. Use bt_gatt_h instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief The attribute handle of GATT(Generic Attribute Profile).
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*/
typedef void *bt_gatt_attribute_h;
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief The handle of calls state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef void *bt_call_list_h;
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Class structure of device and service.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see #bt_device_info_s
* @see #bt_adapter_device_discovery_info_s
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Structure of device discovery information.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see #bt_class_s
* @see bt_adapter_device_discovery_state_changed_cb()
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Structure of le device discovery information.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @see #bt_class_s
* @see bt_adapter_le_device_discovery_state_changed_cb()
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Structure of advertising parameters.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @see bt_adapter_le_advertising_state_changed_cb()
* @see bt_adapter_le_start_advertising()
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Device information structure used for identifying pear device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see #bt_class_s
* @see bt_device_bond_created_cb()
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Service Discovery Protocol (SDP) data structure.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This protocol is used for discovering available services or pear device,
* and finding one to connect with.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Device connection information structure.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see bt_device_connection_state_changed_cb()
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Rfcomm connection data used for exchanging data between Bluetooth devices.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see bt_socket_connection_state_changed_cb()
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Structure of RFCOMM received data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks User can use standard linux functions for reading/writing
* data from/to sockets.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the Bluetooth adapter state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the adapter state changing
* @param[in] adapter_state The adapter state to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when adapter name changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] device_name The name of the Bluetooth device to be changed
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the visibility mode changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the visibility mode changing
* @param[in] visibility_mode The visibility mode to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called every second until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks This callback function is called only if visibility mode is #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE.
* @param[in] duration The duration until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE (in seconds)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the state of device discovery changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks If \a discovery_state is #BT_ADAPTER_DEVICE_DISCOVERY_FOUND,
* then you can get some information, such as remote device address, remote device name, rssi, and bonding state.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when you get bonded devices repeatedly.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] device_info The bonded device information
* @param[in] user_data The user data passed from the foreach function
* @deprecated Deprecated since 2.3.1
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Called when the state of LE device discovery changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @remarks If \a discovery_state is #BT_ADAPTER_LE_DEVICE_DISCOVERY_FOUND,
* then you can get some information, such as remote LE device address, remote device name, rssi, and bonding state.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Called when the state of advertiser changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] result The result of the requested state change of advertiser
* @param[out] advertiser The handle of the state changed advertiser
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the process of creating bond finishes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks If the remote user does not respond within 60 seconds, a time out will happen with #BT_ERROR_TIMED_OUT result code.\n
* If bt_device_cancel_bonding() is called and it returns #BT_ERROR_NONE, then this callback function will be called
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when you get connected profiles repeatedly.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] profile The connected Bluetooth profile
* @param[in] user_data The user data passed from the foreach function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the bond destroys.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result that a bond is destroyed
* @param[in] remote_address The address of the remote Bluetooth device to destroy bond with
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the authorization of device changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] authorization The authorization of device
* @param[in] remote_address The address of the remote Bluetooth device which is (un)authorized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the process of service search finishes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remark
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] connected The connection status: (@c true = connected, @c false = disconnected)
* @param[in] conn_info The connection information
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Called when you receive data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] data The received data from the remote device
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Called when the socket connection state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of connection state changing
* @param[in] connection_state The connection state
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Called when a RFCOMM connection is requested.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] socket_fd The file descriptor of socket on which a connection is requested
* @param[in] remote_address The address of remote device
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when an OPP connection is requested.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details You must call bt_opp_server_accept_connection() if you want to accept.
* Otherwise, you must call bt_opp_server_reject_connection().
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when a file is being transferred.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] file The path of file to be pushed
* @param[in] size The file size (bytes)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when a transfer is finished.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] error_code The result of push
* @param[in] file The path of file to be pushed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Called when OPP server responds to the push request.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of OPP server response
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Called when each file is being transferred.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] file The path of file to be pushed
* @param[in] size The file size (bytes)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Called when the push request is finished.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the push request
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you call bt_audio_connect() or bt_audio_disconnect(), this callback is also called with error result even though these functions fail.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when a call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] event The call handling event happened from Hands-Free
* @param[in] call_id The call ID
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] event The call handling event happened from Hands-Free
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] dtmf The DTMF transmitted from Hands-Free
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when the speaker gain of the remote device is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] gain The gain of speaker (0 ~ 15)
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when the microphone gain of the remote device is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] gain The gain of microphone (0 ~ 15)
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] connected The state to be changed. @a true means connected state, Otherwise, @a false.
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the equalizer state is changed by the remote control device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] equalizer The equalizer state
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the repeat mode is changed by the remote control device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] repeat The repeat mode
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the shuffle mode is changed by the remote control device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] shuffle The shuffle mode
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the scan mode is changed by the remote control device.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] shuffle The shuffle mode
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you call bt_hid_host_connect() or bt_hid_host_disconnect(), this callback is also called with error result even though these functions fail.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Called when the connection is established.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of connecting to the remote device
* @param[in] remote_address The address of connected remote device
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Called when the connection is disconnected.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of disconnecting from the remote device
* @param[in] remote_address The address of disconnected remote device
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Called when the you receive the data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] channel The connected data channel
* @param[in] data The received data
* @deprecated Deprecated since 2.3.1. Use bt_gatt_foreach_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when you get the primary services repeatedly.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] service The attribute handle of service
* @param[in] user_data The user data passed from the foreach function
* @deprecated Deprecated since 2.3.1. This is not required because characteristic discovery is happened automatically.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called after the characteristics are discovered by bt_gatt_discover_characteristics().
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @remarks If bt_gatt_discover_characteristics() failed, then this callback function is called only once with 0 total and NULL characteristic_handle.
* @param[in] result The result of discovering
* @deprecated Deprecated since 2.3.1. Use bt_gatt_foreach_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when you get the included services repeatedly.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] service The attribute handle of service
* @param[in] user_data The user data passed from the foreach function
* @deprecated Deprecated since 2.3.1. Use bt_gatt_client_characteristic_value_changed_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when a characteristic in service is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] characteristic The attribute handle of characteristic
* @param[in] value The value of characteristic (byte array)
* @deprecated Deprecated since 2.3.1. Use bt_gatt_client_request_completed_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when a characteristic value is written.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @see bt_gatt_set_characteristic_value()
*/
* @deprecated Deprecated since 2.3.1. Use bt_gatt_client_request_completed_cb instead.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when a characteristic value is read.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] value The value of characteristic (byte array)
* @param[in] value_length The length of value
* @deprecated Deprecated since 2.3.1. This is not required because descriptor discovery is happened automatically.
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called after the characteristics descriptors are discovered by bt_gatt_discover_characteristic_descriptor().
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE @else 2.3 @endif
*
* @param[in] result The result of discovering
* @param[in] characteristic_format The format of the information data.
typedef void (*bt_gatt_client_characteristic_value_changed_cb) (bt_gatt_h characteristic,
char *value, int len, void *user_data);
-
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when a service of a remote GATT server has been changed.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you called bt_gatt_connect() or bt_gatt_disconnect(), this callback is also called with error result even though these functions fail.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] connected Indicates whether a client is connected or disconnected
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you call bt_panu_connect() or bt_panu_disconnect(), this callback is also called with error result even though these functions fail.
*/
typedef void (*bt_panu_connection_state_changed_cb) (int result, bool connected, const char *remote_address, bt_panu_service_type_e type, void *user_data);
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Enumerations of the Bluetooth HID mouse's button.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_HID_MOUSE_BUTTON_NONE = 0x00, /**<The mouse's none value*/
+ BT_HID_MOUSE_BUTTON_LEFT = 0x01, /**<The mouse's left button value*/
+ BT_HID_MOUSE_BUTTON_RIGHT = 0x02, /**<The mouse's right button value*/
+ BT_HID_MOUSE_BUTTON_MIDDLE = 0x04 /**<The mouse's middle button value*/
+} bt_hid_mouse_button_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief The structure type containing the HID mouse event information.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @see bt_hid_device_send_mouse_event()
+ */
+typedef struct {
+ int buttons; /**< The button values, we can combine key's values when we pressed multiple mouse buttons*/
+ int axis_x; /**< The location's x value, -128 ~127 */
+ int axis_y; /**< The location's y value, -128 ~127 */
+ int padding; /**< The padding value, -128 ~127 */
+} bt_hid_mouse_data_s;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief The structure type containing the HID keyboard event information.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ * @details If you want to know more detail values, refer to http://www.usb.org/developers/hidpage/ and see "HID Usage Tables"
+ *
+ * @see bt_hid_device_send_key_event()
+ */
+typedef struct {
+ unsigned char modifier; /**< The modifier keys : such as shift, alt */
+ unsigned char key[8]; /**< The key value - currently pressed keys : Max 8 at once */
+} bt_hid_key_data_s;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Enumerations of the Bluetooth HID header type.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_HID_HEADER_HANDSHAKE, /**< The Bluetooth HID header type: Handshake */
+ BT_HID_HEADER_HID_CONTROL, /**< The Bluetooth HID header type: HID control */
+ BT_HID_HEADER_GET_REPORT, /**< The Bluetooth HID header type: Get report */
+ BT_HID_HEADER_SET_REPORT, /**< The Bluetooth HID header type: Set report */
+ BT_HID_HEADER_GET_PROTOCOL, /**< The Bluetooth HID header type: Get protocol */
+ BT_HID_HEADER_SET_PROTOCOL, /**< The Bluetooth HID header type: Set protocol */
+ BT_HID_HEADER_DATA, /**< The Bluetooth HID header type: Data */
+ BT_HID_HEADER_UNKNOWN /**< The Bluetooth HID header type: Unknown */
+} bt_hid_header_type_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Enumerations of the Bluetooth HID parameter type.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_HID_PARAM_DATA_RTYPE_INPUT, /**< Parameter type: Input */
+ BT_HID_PARAM_DATA_RTYPE_OUTPUT /**< Parameter type: Output */
+} bt_hid_param_type_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Enumerations of the Bluetooth HID handshake type.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef enum {
+ BT_HID_HANDSHAKE_SUCCESSFUL = 0x00, /**< Handshake error code none */
+ BT_HID_HANDSHAKE_NOT_READY, /**< Handshake error code Not Ready */
+ BT_HID_HANDSHAKE_ERR_INVALID_REPORT_ID, /**< Handshake error code send invalid report id */
+ BT_HID_HANDSHAKE_ERR_UNSUPPORTED_REQUEST, /**< Handshake error code request unsupported request */
+ BT_HID_HANDSHAKE_ERR_INVALID_PARAMETER, /**< Handshake error code received invalid parameter */
+ BT_HID_HANDSHAKE_ERR_UNKNOWN = 0x0e, /**< unknown error */
+ BT_HID_HANDSHAKE_ERR_FATAL /**< Fatal error */
+} bt_hid_handshake_type_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief The structure type containing data received from the HID Host.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ */
+typedef struct {
+ const char *address; /**< The remote device's address */
+ bt_hid_header_type_e header_type; /**< The header type */
+ bt_hid_param_type_e param_type; /**< The parameter type */
+ int data_size; /**< The length of the received data */
+ const char *data; /**< The received data */
+} bt_hid_device_received_data_s;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Called when the Bluetooth HID Device connection state changes.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of changing the connection state.
+ * @param[in] connected The requested state. @a true means the connection is enabled, @a false means the connection is disabled.
+ * @param[in] remote_address The remote device's address
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_hid_device_activate()
+ */
+typedef void (*bt_hid_device_connection_state_changed_cb) (int result,
+ bool connected, const char *remote_address, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
+ * @brief Called when the HID Device receives data from the HID Host.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] data The data received from the HID Host.
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_hid_device_set_data_received_cb()
+ */
+typedef void (*bt_hid_device_data_received_cb)(const bt_hid_device_received_data_s *data, void *user_data);
+/* HID device related type */
+
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief The structure type containing vCard information.
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @see bt_pbap_client_pull_vcard()
+ */
+typedef struct {
+ int index; /**< The vcard index, used as a parameter for bt_pbap_client_pull_vcard() */
+ const char *contact_name; /**< The contact name of the vCard */
+} bt_pbap_vcard_info_s;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Called when PBAP is Connected or Disconnected.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of connecting to or disconnecting from the remote device
+ * @param[in] connected The PBAP connection status (@c true = connected, @c false = disconnected)
+ * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ */
+typedef void (*bt_pbap_connection_state_changed_cb)(int result, bool connected,
+ const char *remote_address, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Called when PBAP Phonebook size calculation completes.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of getting the phone book size
+ * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
+ * @param[in] size Size of Phonebook
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_pbap_client_get_phone_book_size()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ */
+typedef void (*bt_pbap_phone_book_size_cb)(int result, const char *remote_address,
+ int size, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Called when PBAP Phonebook Pull completes.
+ * @details The received phone book file will be saved in the platform downloads folder. \n
+ * The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of getting the phone book
+ * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
+ * @param[in] vcf_file The absolute path of the file in which the vCards are saved (@a vcf_file is valid only inside this function. To use outside the callback, make a copy. @a vcf_file should not be freed.)
+ * @param[in] successful true if the operation was successful, false if not
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_pbap_client_get_phone_book()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ */
+typedef void (*bt_pbap_phone_book_received_cb)(int result, const char *remote_address,
+ const char *vcf_file, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
+ * @brief Called when PBAP List vCards completes.
+ * @details The following error codes can be delivered: \n
+ * #BT_ERROR_NONE \n
+ * #BT_ERROR_OPERATION_FAILED \n
+ * @since_tizen @if WEARABLE 3.0 @endif
+ *
+ * @param[in] result The result of getting the vcard list
+ * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
+ * @param[in] vcard_info List of vcard information (@a vcard_info is valid only inside this function. To use outside the callback, make a copy. @a vcard_info should not be freed.)
+ * @param[in] count Number of contacts in the list
+ * @param[in] successful true if the operation was successful, false if not
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_pbap_client_get_list()
+ * @see bt_pbap_client_connect()
+ * @see bt_pbap_client_disconnect()
+ */
+typedef void (*bt_pbap_list_vcards_cb)(int result, const char *remote_address,
+ const bt_pbap_vcard_info_s *vcard_info, int count, void *user_data);
+
#ifdef __cplusplus
}
#endif /* __cplusplus */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when the SCO(Synchronous Connection Oriented link) state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the SCO state is changed.
* When you call bt_ag_open_sco() or bt_ag_close_sco(), this callback is also called with error result even though these functions failed.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth adapter le state.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_DISABLED = 0x00, /**< Bluetooth le is disabled */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Called when the Bluetooth adapter le state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the adapter state changing
* @param[in] adapter_le_state The adapter le state to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the call state
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_CALL_EVENT_IDLE = 0x00, /**< Idle */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the call state
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_CALL_STATE_IDLE = 0x00, /**< Idle state */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the connectable state changes.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the connectable state changing
* @param[in] connectable The connectable to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when the push is requested.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details You must call bt_opp_server_accept() if you want to accept.
* Otherwise, you must call bt_opp_server_reject().
} bt_adapter_le_scan_type_e;
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Enumerations for the call handling event
+ * @since_tizen @if WEARABLE 2.3 @endif
+ */
+typedef enum {
+ BT_HF_CALL_HANDLING_EVENT_ANSWER = 0x00, /**< Request to answer an incoming call */
+ BT_HF_CALL_HANDLING_EVENT_RELEASE, /**< Request to release a call */
+ BT_HF_CALL_HANDLING_EVENT_REJECT, /**< Request to reject an incoming call */
+ BT_HF_CALL_HANDLING_EVENT_RING, /**< Request of ringing call */
+ BT_HF_CALL_HANDLING_EVENT_CALL_STARTED, /**< Request of Call started */
+ BT_HF_CALL_HANDLING_EVENT_CALL_ENDED, /**< Request of Call Ended */
+ BT_HF_CALL_HANDLING_EVENT_VOICE_RECOGNITION_ENABLED, /**< Request of voice recognition enabled */
+ BT_HF_CALL_HANDLING_EVENT_VOICE_RECOGNITION_DISABLED, /**< Request of voice recognition disabled */
+ BT_HF_CALL_HANDLING_EVENT_VENDOR_DEP_CMD, /**< Request of Vendor command */
+ BT_HF_CALL_HANDLING_EVENT_WAITING, /**< Request to waiting a call */
+ BT_HF_CALL_HANDLING_EVENT_HELD, /**< Request to hold a call */
+ BT_HF_CALL_HANDLING_EVENT_UNHELD, /**< Request to unhold calls */
+ BT_HF_CALL_HANDLING_EVENT_SWAPPED, /**< Request to swap calls */
+} bt_hf_call_handling_event_e;
+
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Enumerations for the multi call handling event
+ * @since_tizen @if WEARABLE 2.3 @endif
+ */
+typedef enum {
+ BT_HF_MULTI_CALL_HANDLING_EVENT_RELEASE_HELD_CALLS = 0x00, /**< Request to release held calls */
+ BT_HF_MULTI_CALL_HANDLING_EVENT_RELEASE_ACTIVE_CALLS, /**< Request to release active calls */
+ BT_HF_MULTI_CALL_HANDLING_EVENT_ACTIVATE_HELD_CALL, /**< Request to put active calls into hold state and activate another (held or waiting) call */
+ BT_HF_MULTI_CALL_HANDLING_EVENT_MERGE_CALLS, /**< Request to add a held call to the conversation */
+ BT_HF_MULTI_CALL_HANDLING_EVENT_EXPLICIT_CALL_TRANSFER, /**< Request to let a user who has two calls to connect these two calls together and release its connections to both other parties */
+} bt_hf_multi_call_handling_event_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Enumerations for the call state
+ * @since_tizen @if WEARABLE 2.3 @endif
+ */
+typedef enum {
+ BT_HF_CALL_EVENT_IDLE = 0x00, /**< Idle */
+ BT_HF_CALL_EVENT_ANSWER, /**< Answered */
+ BT_HF_CALL_EVENT_HOLD, /**< Held */
+ BT_HF_CALL_EVENT_RETRIEVE, /**< Retrieved */
+ BT_HF_CALL_EVENT_DIAL, /**< Dialing */
+ BT_HF_CALL_EVENT_ALERT, /**< Alerting */
+ BT_HF_CALL_EVENT_INCOMING, /**< Incoming */
+ BT_HF_CALL_EVENT_REDIAL, /**< Redialling */
+ BT_HF_CALL_EVENT_RELEASE_ALL_NONACTIVE_CALLS, /**< Release all nonactive calls */
+ BT_HF_CALL_EVENT_ACCEPT_AND_RELEASE, /**< Accept and Release */
+ BT_HF_CALL_EVENT_ACCEPT_AND_HOLD, /**< Accept and Hold */
+ BT_HF_CALL_EVENT_ADD_TO_CONVERSATION, /**< Add to the conversation */
+} bt_hf_call_event_e;
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief HF Call status information.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ */
+typedef struct {
+ char *number; /**< Phone Number */
+ int direction; /**< Direction :Incoming(1), Outgoing(0) */
+ int status; /**< Call Status :Active(0), Held(1), Waiting(5), Dailing(2) */
+ int multi_party; /**< Multiparty/conf call: Yes(1), No(0) */
+ int index; /**< Call index/ID */
+} bt_hf_call_status_info_s;
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the manufacturer dat changes.
* @since_tizen 2.3
typedef bool (*bt_adapter_profile_connected_devices_cb)(const char *remote_address, void *user_data);
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when the SCO(Synchronous Connection Oriented link) state is changed.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ *
+ * @details This callback is called when the SCO state is changed.
+ * When you call bt_ag_open_sco() or bt_ag_close_sco(), this callback is also called with error result even though these functions failed.
+ * @param[in] result The result of changing the connection state
+ * @param[in] opened The state to be changed: (@c true = opened, @c false = not opened)
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_ag_set_sco_state_changed_cb()
+ * @see bt_ag_unset_sco_state_changed_cb()
+ * @see bt_ag_open_sco()
+ * @see bt_ag_close_sco()
+ */
+typedef void (*bt_hf_sco_state_changed_cb) (int result, bool opened, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when a call handling event happened from Hands-Free.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ *
+ * @param[in] event The call handling event happened from Hands-Free
+ * @param[in] call_id The call ID
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_ag_set_call_handling_event_cb()
+ * @see bt_ag_unset_call_handling_event_cb()
+ */
+typedef void (*bt_hf_call_handling_event_cb) (bt_hf_call_handling_event_e event, char *phone_number, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when a multi call handling event happened from Hands-Free.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ *
+ * @param[in] event The call handling event happened from Hands-Free
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_ag_set_multi_call_handling_event_cb()
+ * @see bt_ag_unset_multi_call_handling_event_cb()
+ */
+typedef void (*bt_hf_multi_call_handling_event_cb) (bt_hf_multi_call_handling_event_e event, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when the speaker gain of the remote device is changed.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ *
+ * @param[in] gain The gain of speaker (0 ~ 15)
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_hf_set_speaker_gain_changed_cb()
+ * @see bt_hf_unset_speaker_gain_changed_cb()
+ */
+typedef void (*bt_hf_speaker_gain_changed_cb) (int gain, void *user_data);
+
+/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
+ * @brief Called when a call status updated event happened from Hands-Free.
+ * @since_tizen @if WEARABLE 2.3 @endif
+ * @remarks call_info_list has elements which consist of bt_hf_call_status_info_s
+ * @remarks The @a call_info_list must be released with bt_hf_free_call_status_info_list() by you.
+ *
+ * @param[in] event The call handling event happened from Hands-Free
+ * @param[in] call_id The call ID
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see bt_hf_call_status_info_s
+ * @see bt_hf_set_call_status_updated_event_cb()
+ * @see bt_hf_unset_call_status_updated_event_cb()
+ */
+typedef void (*bt_hf_call_status_updated_event_cb) (GSList *call_info_list, void *user_data);
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DPM_MODULE
* @brief DPM BT allowance state
* @since_tizen 3.0
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Device LE connection update structure.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef struct {
unsigned int interval_min; /**< Minimum value for the connection event interval (msec) */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID mouse's button.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef enum {
BT_HID_MOUSE_BUTTON_NONE = 0x00, /**<The mouse's none value*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief The structure type containing the HID mouse event information.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*
* @see bt_hid_device_send_mouse_event()
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief The structure type containing the HID keyboard event information.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
* @details If you want to know more detail values, refer to http://www.usb.org/developers/hidpage/ and see "HID Usage Tables"
*
* @see bt_hid_device_send_key_event()
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID header type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef enum {
BT_HID_HEADER_HANDSHAKE, /**< The Bluetooth HID header type: Handshake */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID parameter type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef enum {
BT_HID_PARAM_DATA_RTYPE_INPUT, /**< Parameter type: Input */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID handshake type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef enum {
BT_HID_HANDSHAKE_SUCCESSFUL = 0x00, /**< Handshake error code none */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief The structure type containing data received from the HID Host.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*/
typedef struct {
const char *address; /**< The remote device's address */
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*
* @param[in] result The result of changing the connection state.
* @param[in] connected The requested state. @a true means the connection is enabled, @false means the connection is disabled.
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE @else 3.0 @endif
*
* @param[in] data The data received from the HID Host.
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
* @brief Initializes the Bluetooth API.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
* @brief Releases all resources of the Bluetooth API.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks This function must be called if Bluetooth API is no longer needed.
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the current state of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] adapter_state The current adapter state
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the address of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks The @a local_address must be released with free() by you.
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the name of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details Use this function to get the friendly name associated with Bluetooth
* device, retrieved by the remote Bluetooth devices.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the name of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the visibility mode of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Starts the device discovery, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Stops the device discovery, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Checks for the device discovery is in progress or not.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @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,
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Get the service mask from the uuid list.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] uuids The UUID list of the device.
* @param[in] no_of_service The number of the UUID list count.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Retrieves the device information of all bonded devices.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param [in] callback The callback function to invoke
* @param [in] user_data The user data passed from the foreach function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the device information of a bonded device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Frees device info.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param [in] device_info The bonded device information
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Checks whether the UUID of service is used or not
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the visibility mode changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked every second
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* 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,
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Get the Hash and Randmoizer value, synchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] hash The hash value received from the controller
* @param[out] randomizer The hash value received from the controller
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the Hash and Randmoizer value, synchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Deletes the Hash and Randomizer value, synchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] advertiser The handle of advertiser
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Destroy advertiser.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] advertiser The handle of advertiser
*
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] advertiser The handle of advertiser
* @param[in] pkt_type The packet type to be cleared
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Stops the advertising.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Creates a bond with a remote Bluetooth device, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Cancels the bonding process.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Destroys the bond, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Sets an alias for the bonded device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Sets the authorization of a bonded device, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @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 @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Gets the connected profiles.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Gets the profile connected status.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the bond creates.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Registers a callback function to be invoked when the bond destroys.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Registers a rfcomm server socket with a specific UUID.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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,
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Starts listening on passed rfcomm socket and accepts connection requests.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @details Pop-up is shown automatically when a RFCOMM connection is requested.
/**
* @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 @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @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 @if WEARABLE 2.3.1 @else 2.3 @endif
* @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().
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Sends data to the connected device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Register a callback function that will be invoked when you receive data.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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().
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Deinitializes the Bluetooth OPP server.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Accepts the push request from the remote device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
*
* @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 @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Cancels the transfer.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] transfer_id The ID of transfer
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Sets the destination path of file to be pushed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] destination The destination path of file to be pushed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Initializes the Bluetooth OPP client.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Deinitializes the Bluetooth OPP client.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Adds file to be pushed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] file The path of file to be pushed
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Adds file to be pushed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Pushes the file to the remote device, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @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
* @brief Cancels the push request in progress, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
int bt_opp_client_cancel_push(void);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Initializes the Bluetooth HID(Human Interface Device) Host.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
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 @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Deinitializes the Bluetooth HID(Human Interface Device) Host.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
int bt_hid_host_deinitialize(void);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Connects the remote device with the HID(Human Interface Device) service, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
int bt_hid_host_connect(const char *remote_address);
/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE
+ * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif
* @brief Disconnects the remote device with the HID(Human Interface Device) service, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Activates the Bluetooth HID Device role.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel pubilc
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Deactivates the Bluetooth HID Device role.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel pubilc
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Initiates the HID device connection with the Device role, asynchronously.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel pubilc
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Disconnects from the HID Host device, asynchronously.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel pubilc
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Sends the mouse event data to the remote device.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel pubilc
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Sends the keyboard event data to the remote device.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel pubilc
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Sets the callback called when the device receives data from the HID Host.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @param[in] callback The callback function to be set when data is received.
* @param[in] user_data The user data to be passed to the callback.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Unsets the data received callback.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Responds to reports from the HID Host.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel pubilc
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Initializes the Bluetooth profiles related with audio.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Deinitializes the Bluetooth profiles related with audio.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Connects the remote device with the given audio profile, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Disconnects the remote device with the given audio profile, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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 @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Deinitializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the equalizer state to the remote device.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] state The state of equalizer
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the repeat mode to the remote device.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] mode The repeat mode
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the shuffle mode to the remote device.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] mode The repeat mode
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the scan mode to the remote device.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] mode The scan mode
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the player state to the remote device.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] state The player state
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the current position of song to the remote device.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] position The current position in milliseconds
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_TARGET_MODULE
* @brief Notifies the track to the remote device.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] title The title of track
/**
* @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. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @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
+ * @brief Unregisters a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @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
+ * @brief Unregisters a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devi)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @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
+ * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @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.
/**
* @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
+ * @brief Unregisters a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices)
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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. (e.g., by a TV remote control or other input devices)
* @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
* @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. (e.g., by a TV remote control or other input devices)
* @since_tizen 3.0
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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. (e.g., by a TV remote control or other input devices)
* @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
/**
* @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. (e.g., by a TV remote control or other input devices)
* @since_tizen 3.0
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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. (e.g., by a TV remote control or other input devices)
* @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
/**
* @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. (e.g., by a TV remote control or other input devices)
* @since_tizen 3.0
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @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 @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @remarks The @a app_id must be released with free() by you.
/**
* @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 @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] app_id The ID of application
/**
* @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 @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Disconnects the remote device, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Sends the data to the remote device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] channel The connected data channel
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Disconnect to LE connection with the given remote Bluetooth device address, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
*
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register.
* @param[in] user_data The user data to be passed to the callback function.
/**
* @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
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @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
* @retval #BT_ERROR_NONE Successful
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.
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Initializes the Bluetooth PBAP Client.
* @details This initialization is necessary to call other PBAP client APIs.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @remarks This function must be called to initialize Bluetooth PBAP client. You must free all resources of the Bluetooth service
* by calling bt_pbap_client_deinitialize() if Bluetooth PBAP Client is no longer needed.
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Deinitializes the Bluetooth PBAP Client.
* @details This deinitialization must be done to free resources when the PBAP client is not longer needed.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Registers a callback function that will be invoked when the connection state is changed.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @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.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Unregisters a callback function that will be invoked when the connection state is changed.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Connects to PBAP server, asynchronously.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Disconnects from PBAP server, asynchronously.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Gets size of phone book from PBAP server, asynchronously.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Gets all contacts and call logs as vCard from PBAP server, asynchronously.
* @details The received phone book file will be saved in the platform downloads folder.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
* http://tizen.org/privilege/mediastorage
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Gets contact and call log information from the PBAP server, asynchronously.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
* @details The received phone book file will be saved in the platform downloads folder.
* The @a index value should be equal to the value of the @a index field in the #bt_pbap_vcard_info_s structure,
* which can be obtained with bt_pbap_client_get_list() or bt_pbap_client_search_phone_book().
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
* http://tizen.org/privilege/mediastorage
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Finds and fetches the contact and call log information from the PBAP server, asynchronously.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enables the local Bluetooth adapter, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Disables the local Bluetooth adapter, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Recover the local Bluetooth adapter, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Reset the local Bluetooth adapter, synchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the version of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @remarks The @a local_version must be released with free() by you.
*
* @param[out] local_version The version of local Bluetooth adapter
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the information regarding local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @remarks The @a all parameters must be released with free() by you.
*
* @param[out] chipset Chipset name of local Bluetooth adapter
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the visibility mode.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Registers a callback function to be invoked when the connectable state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Gets the connectable state of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks When connectable state is false, no device can connect to this device and visibility mode cannot be changed.
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Sets the connectable state of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enables the local Bluetooth le adapter, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Disables the local Bluetooth le adapter, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Gets the current state of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] adapter_le_state The current adapter le state
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Registers a callback function to be invoked when the Bluetooth adapter le state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Unregisters the callback function.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief add address to whitelist for accepting scanning request.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief remove address from the whitelist for not accepting scanning request.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Sets the Privacy feature state of local Bluetooth adapter.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @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
+ * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
*
* @pre The Bluetooth service must be initialized with bt_initialize().
*
* @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
+ * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
*
* @pre The Bluetooth service must be initialized with bt_initialize().
*
* @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
+ * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
*
* @pre The Bluetooth service must be initialized with bt_initialize().
*
* @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
+ * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
*
* @pre The Bluetooth service must be initialized with bt_initialize().
*
* @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
+ * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
*
* @pre The Bluetooth service must be initialized with bt_initialize().
*
* @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
+ * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
*
* @pre The Bluetooth service must be initialized with bt_initialize().
*
* @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
+ * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
*
* @pre The Bluetooth service must be initialized with bt_initialize().
*
* @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
+ * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
*
* @pre The Bluetooth service must be initialized with bt_initialize().
*
* @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
+ * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #BT_ERROR_NOT_SUPPORTED Not supported
*
* @pre The Bluetooth service must be initialized with bt_initialize().
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Creates a bond with a remote Bluetooth device, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Cancels service search process.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Gets a connection state
- * @since_tizen 2.4
+ * @since_tizen @if WEARABLE 2.4 @endif
*
* @param[in] remote_address The address of the remote Bluetooth device
* @param[in] link_type The link type to get a connection state
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Starts listening on passed rfcomm socket.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @details bt_socket_connection_requested_cb() will be called when a RFCOMM connection is requested.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Accepts a connection request.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] requested_socket_fd The file descriptor of socket on which a connection is requested
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Rejects a connection request.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] socket_fd The file descriptor of socket on which a connection is requested
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Initializes the Bluetooth OPP server requested by bt_opp_server_push_requested_cb().
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @details The popup appears when an OPP connection is requested from a remote device.
* If you accept the request, then connection will be established and bt_opp_server_push_requested_cb() will be called.
* At that time, you can call either bt_opp_server_accept() or bt_opp_server_reject().
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Notifies the call event to the remote bluetooth device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @remarks Before notifying #BT_AG_CALL_EVENT_ANSWERED or #BT_AG_CALL_EVENT_DIALING, you should open SCO(Synchronous Connection Oriented link)
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Notifies the call list to the remote bluetooth device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] list The call list
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Notifies the state of voice recognition.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @param[in] state The state of voice recognition: (@c true = enabled, @c false = disabled)
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Registers a callback function that will be invoked when a call handling event happened from Hands-Free.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Unregisters a callback function that will be invoked when a call handling event happened from Hands-Free.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Registers a callback function that will be invoked when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Unregisters a callback function that will be invoked when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Registers a callback function that will be invoked when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Unregisters a callback function that will be invoked when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Checks whether the remoted device enables NREC(Noise Reduction and Echo Canceling) or not.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[out] enabled The NREC status: (@c true = enabled, @c false = not enabled)
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Creates a handle of call list.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[out] list The handle of call list
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Destroys the handle of call list.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] list The handle of call list
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Resets the handle of call list.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] list The handle of call list
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_CALL_MODULE
* @brief Adds a call to the handle of call list.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @param[in] list The handle of call list
* @param[in] call_id The call ID
* @param[in] state The state of audio gate call
* @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_OPERATION_FAILED Operation failed
* @retval #BT_ERROR_NOT_SUPPORTED Not supported
* @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED.
*/
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Activates the NAP(Network Access Point).
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Deactivates the NAP(Network Access Point).
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Disconnects the all PANUs(Personal Area Networking User) which are connected to you.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @return 0 on success, otherwise a negative error value.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Disconnects the specified PANU(Personal Area Networking User) which is connected to you.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Registers a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Unregisters a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Registers a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @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.
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Unregisters a callback function that will be invoked when the connection state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Connects the remote device with the PAN(Personal Area Networking) service, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Disconnects the remote device with the PAN(Personal Area Networking) service, asynchronously.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth
* @param[in] remote_address The remote address
* @internal
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief update LE connection.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
* @return 0 on success, otherwise a negative error value.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE
* @brief Sends the custom event data.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of PBAP fields.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_PBAP_FIELD_ALL = (0xFFFFFFFFU), /**< All field */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
* @brief Enumerations of Bluetooth error codes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enumerations of the Bluetooth adapter state.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_DISABLED = 0x00, /**< Bluetooth adapter is disabled */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enumerations of the Bluetooth visibility mode.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE = 0x00, /**< Other devices cannot find your device via discovery */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Enumerations of the discovery state of Bluetooth device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_DEVICE_DISCOVERY_STARTED, /**< Device discovery is started */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth advertising state.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_ADVERTISING_STOPPED = 0x00, /**< Bluetooth advertising is stopped */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth advertising filter policy.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_ADVERTISING_FILTER_DEFAULT = 0x00, /**< White list is not in use */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth LE packet type.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_PACKET_ADVERTISING, /**< Advertising packet */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of device disconnect reason.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_DISCONNECT_REASON_UNKNOWN, /**< Disconnected by unknown reason */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of connection link type.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_CONNECTION_LINK_BREDR, /**< BR/EDR link */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of device authorization state.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_AUTHORIZED, /**< The remote Bluetooth device is authorized */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of Bluetooth profile.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_PROFILE_RFCOMM = 0x01, /**< RFCOMM Profile */
- BT_PROFILE_A2DP = 0x02, /**< Advanced Audio Distribution Profile */
+ BT_PROFILE_A2DP = 0x02, /**< Advanced Audio Distribution Profile Source role */
BT_PROFILE_HSP = 0x04, /**< Headset Profile */
BT_PROFILE_HID = 0x08, /**< Human Interface Device Profile */
BT_PROFILE_NAP = 0x10, /**< Network Access Point Profile */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of device address type.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_DEVICE_PUBLIC_ADDRESS = 0x00, /**< Public address */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of service class.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_SC_NONE = 0, /**< No service class */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of major service class.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_MAJOR_SERVICE_CLASS_LIMITED_DISCOVERABLE_MODE = 0x002000, /**< Limited discoverable mode */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of major device class.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_MAJOR_DEVICE_CLASS_MISC = 0x00, /**< Miscellaneous major device class*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of minor device class.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_MINOR_DEVICE_CLASS_COMPUTER_UNCATEGORIZED = 0x00, /**< Uncategorized minor device class of computer */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Enumerations of gap appearance type.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_APPEARANCE_TYPE_UNKNOWN = 0x00, /**< Unknown appearance type */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Enumerations of connected Bluetooth device event role.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_SOCKET_UNKNOWN = 0x00, /**< Unknown role*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Enumerations of Bluetooth socket connection state.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_SOCKET_CONNECTED, /**< RFCOMM is connected */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Enumerations for the types of profiles related with audio
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AUDIO_PROFILE_TYPE_ALL = 0, /**< All supported profiles related with audio */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the call handling event
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_CALL_HANDLING_EVENT_ANSWER = 0x00, /**< Request to answer an incoming call */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the multi call handling event
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_MULTI_CALL_HANDLING_EVENT_RELEASE_HELD_CALLS = 0x00, /**< Request to release held calls */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the equalizer state
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_EQUALIZER_STATE_OFF = 0x01, /**< Equalizer Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the repeat mode
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_REPEAT_MODE_OFF = 0x01, /**< Repeat Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the shuffle mode
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_SHUFFLE_MODE_OFF = 0x01, /**< Shuffle Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Enumerations for the scan mode
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef enum {
BT_AVRCP_SCAN_MODE_OFF = 0x01, /**< Scan Off */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Enumerations for the data channel type
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_HDP_CHANNEL_TYPE_RELIABLE = 0x01, /**< Reliable Data Channel */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Enumerations for the types of PAN(Personal Area Networking) service.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_PANU_SERVICE_TYPE_NAP = 0, /**< Network Access Point */
} bt_panu_service_type_e;
/**
+ * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
+ * @brief The handle to control Bluetooth LE advertising.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ */
+typedef void *bt_advertiser_h;
+
+/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of address book location for PBAP.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_PBAP_SOURCE_DEVICE = 0x00, /**< Request for Addressbook from remote device */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of folder type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_PBAP_FOLDER_PHONE_BOOK = 0x00, /**< Request for address book */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of phone book search fields.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_PBAP_SEARCH_NAME = 0x00, /**< Request for search by name (default) */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of vCard Formats.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_PBAP_VCARD_FORMAT_VCARD21 = 0x00, /**< vCard format 2.1 (default) */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of sorting orders.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_PBAP_ORDER_INDEXED = 0x00, /**< Filter order indexed (default) */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
- * @brief The handle to control Bluetooth LE advertising.
- * @since_tizen 2.3.1
- */
-typedef void *bt_advertiser_h;
-
-/**
- * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief The handle of a service, characteristic or descriptor.
* @since_tizen 2.3.1
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief The handle of calls state.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef void *bt_call_list_h;
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Class structure of device and service.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see #bt_device_info_s
* @see #bt_adapter_device_discovery_info_s
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Structure of device discovery information.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see #bt_class_s
* @see bt_adapter_device_discovery_state_changed_cb()
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Device information structure used for identifying pear device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see #bt_class_s
* @see bt_device_bond_created_cb()
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Service Discovery Protocol (SDP) data structure.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This protocol is used for discovering available services or pear device,
* and finding one to connect with.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Device connection information structure.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see bt_device_connection_state_changed_cb()
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Rfcomm connection data used for exchanging data between Bluetooth devices.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @see bt_socket_connection_state_changed_cb()
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Structure of RFCOMM received data.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks User can use standard linux functions for reading/writing
* data from/to sockets.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the Bluetooth adapter state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the adapter state changing
* @param[in] adapter_state The adapter state to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when adapter name changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] device_name The name of the Bluetooth device to be changed
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the visibility mode changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the visibility mode changing
* @param[in] visibility_mode The visibility mode to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called every second until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks This callback function is called only if visibility mode is #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE.
* @param[in] duration The duration until the visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE (in seconds)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the state of device discovery changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks If \a discovery_state is #BT_ADAPTER_DEVICE_DISCOVERY_FOUND,
* then you can get some information, such as remote device address, remote device name, rssi, and bonding state.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when you get bonded devices repeatedly.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] device_info The bonded device information
* @param[in] user_data The user data passed from the foreach function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Called when the state of advertiser changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[out] result The result of the requested state change of advertiser
* @param[out] advertiser The handle of the state changed advertiser
typedef void (*bt_adapter_le_advertising_state_changed_cb)(int result,
bt_advertiser_h advertiser, bt_adapter_le_advertising_state_e adv_state, void *user_data);
-
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the process of creating bond finishes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks If the remote user does not respond within 60 seconds, a time out will happen with #BT_ERROR_TIMED_OUT result code.\n
* If bt_device_cancel_bonding() is called and it returns #BT_ERROR_NONE, then this callback function will be called
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when you get connected profiles repeatedly.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] profile The connected Bluetooth profile
* @param[in] user_data The user data passed from the foreach function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the bond destroys.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result that a bond is destroyed
* @param[in] remote_address The address of the remote Bluetooth device to destroy bond with
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the authorization of device changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] authorization The authorization of device
* @param[in] remote_address The address of the remote Bluetooth device which is (un)authorized
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the process of service search finishes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remark
*
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] connected The connection status: (@c true = connected, @c false = disconnected)
* @param[in] conn_info The connection information
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Called when you receive data.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] data The received data from the remote device
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Called when the socket connection state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of connection state changing
* @param[in] connection_state The connection state
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE
* @brief Called when a RFCOMM connection is requested.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] socket_fd The file descriptor of socket on which a connection is requested
* @param[in] remote_address The address of remote device
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when an OPP connection is requested.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details You must call bt_opp_server_accept_connection() if you want to accept.
* Otherwise, you must call bt_opp_server_reject_connection().
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when a file is being transferred.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] file The path of file to be pushed
* @param[in] size The file size (bytes)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when a transfer is finished.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] error_code The result of push
* @param[in] file The path of file to be pushed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Called when OPP server responds to the push request.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of OPP server response
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Called when each file is being transferred.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] file The path of file to be pushed
* @param[in] size The file size (bytes)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE
* @brief Called when the push request is finished.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the push request
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you call bt_audio_connect() or bt_audio_disconnect(), this callback is also called with error result even though these functions fail.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when a call handling event happened from Hands-Free.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] event The call handling event happened from Hands-Free
* @param[in] call_id The call ID
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] event The call handling event happened from Hands-Free
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] dtmf The DTMF transmitted from Hands-Free
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when the speaker gain of the remote device is changed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] gain The gain of speaker (0 ~ 15)
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when the microphone gain of the remote device is changed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] gain The gain of microphone (0 ~ 15)
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] connected The state to be changed. @a true means connected state, Otherwise, @a false.
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the equalizer state is changed by the remote control device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] equalizer The equalizer state
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the repeat mode is changed by the remote control device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] repeat The repeat mode
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the shuffle mode is changed by the remote control device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] shuffle The shuffle mode
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
* @brief Called when the scan mode is changed by the remote control device.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] shuffle The shuffle mode
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Called when the connection is established.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of connecting to the remote device
* @param[in] remote_address The address of connected remote device
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Called when the connection is disconnected.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of disconnecting from the remote device
* @param[in] remote_address The address of disconnected remote device
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
* @brief Called when the you receive the data.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] channel The connected data channel
* @param[in] data The received data
typedef void (*bt_gatt_client_characteristic_value_changed_cb) (bt_gatt_h characteristic,
char *value, int len, void *user_data);
-
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when a service of a remote GATT server has been changed.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you called bt_gatt_connect() or bt_gatt_disconnect(), this callback is also called with error result even though these functions fail.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] connected Indicates whether a client is connected or disconnected
* @param[in] remote_address The remote address
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE
* @brief Called when the connection state is changed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the connection state is changed.
* When you call bt_panu_connect() or bt_panu_disconnect(), this callback is also called with error result even though these functions fail.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID mouse's button.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_HID_MOUSE_BUTTON_NONE = 0x00, /**<The mouse's none value*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief The structure type containing the HID mouse event information.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @see bt_hid_device_send_mouse_event()
*/
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief The structure type containing the HID keyboard event information.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
* @details If you want to know more detail values, refer to http://www.usb.org/developers/hidpage/ and see "HID Usage Tables"
*
* @see bt_hid_device_send_key_event()
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID header type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_HID_HEADER_HANDSHAKE, /**< The Bluetooth HID header type: Handshake */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID parameter type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_HID_PARAM_DATA_RTYPE_INPUT, /**< Parameter type: Input */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief Enumerations of the Bluetooth HID handshake type.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef enum {
BT_HID_HANDSHAKE_SUCCESSFUL = 0x00, /**< Handshake error code none */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE
* @brief The structure type containing data received from the HID Host.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*/
typedef struct {
const char *address; /**< The remote device's address */
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @param[in] result The result of changing the connection state.
* @param[in] connected The requested state. @a true means the connection is enabled, @a false means the connection is disabled.
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @param[in] data The data received from the HID Host.
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief The structure type containing vCard information.
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @see bt_pbap_client_pull_vcard()
*/
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @param[in] result The result of connecting to or disconnecting from the remote device
* @param[in] connected The PBAP connection status (@c true = connected, @c false = disconnected)
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @param[in] result The result of getting the phone book size
* @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
* The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @param[in] result The result of getting the phone book
* @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen 3.0
+ * @since_tizen @if WEARABLE 3.0 @endif
*
* @param[in] result The result of getting the vcard list
* @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Called when the SCO(Synchronous Connection Oriented link) state is changed.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details This callback is called when the SCO state is changed.
* When you call bt_ag_open_sco() or bt_ag_close_sco(), this callback is also called with error result even though these functions failed.
#ifndef __TIZEN_NETWORK_BLUETOOTH_TYPE_INTERNAL_H__
#define __TIZEN_NETWORK_BLUETOOTH_TYPE_INTERNAL_H__
-#include <glib.h>
-
#ifdef __cplusplus
extern "C"
{
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth adapter le state.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_ADAPTER_LE_DISABLED = 0x00, /**< Bluetooth le is disabled */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Called when the Bluetooth adapter le state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the adapter state changing
* @param[in] adapter_le_state The adapter le state to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the call state
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_CALL_EVENT_IDLE = 0x00, /**< Idle */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE
* @brief Enumerations for the call state
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
BT_AG_CALL_STATE_IDLE = 0x00, /**< Idle state */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE
* @brief Called when the connectable state changes.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @param[in] result The result of the connectable state changing
* @param[in] connectable The connectable to be changed
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE
* @brief Called when the push is requested.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @details You must call bt_opp_server_accept() if you want to accept.
* Otherwise, you must call bt_opp_server_reject().
*/
typedef void (*bt_opp_server_push_requested_cb)(const char *file, int size, void *user_data);
-
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE
* @brief Enumerations of the Bluetooth adapter le scan type.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
* @brief Enumerations for the call handling event
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3 @endif
*/
typedef enum {
BT_HF_CALL_HANDLING_EVENT_ANSWER = 0x00, /**< Request to answer an incoming call */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
* @brief Enumerations for the multi call handling event
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3 @endif
*/
typedef enum {
BT_HF_MULTI_CALL_HANDLING_EVENT_RELEASE_HELD_CALLS = 0x00, /**< Request to release held calls */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
* @brief Enumerations for the call state
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3 @endif
*/
typedef enum {
BT_HF_CALL_EVENT_IDLE = 0x00, /**< Idle */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
* @brief HF Call status information.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3 @endif
*/
typedef struct {
char *number; /**< Phone Number */
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
* @brief Called when the SCO(Synchronous Connection Oriented link) state is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3 @endif
*
* @details This callback is called when the SCO state is changed.
* When you call bt_ag_open_sco() or bt_ag_close_sco(), this callback is also called with error result even though these functions failed.
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
* @brief Called when a call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3 @endif
*
* @param[in] event The call handling event happened from Hands-Free
* @param[in] call_id The call ID
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
* @brief Called when a multi call handling event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3 @endif
*
* @param[in] event The call handling event happened from Hands-Free
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
* @brief Called when the speaker gain of the remote device is changed.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3 @endif
*
* @param[in] gain The gain of speaker (0 ~ 15)
* @param[in] user_data The user data passed from the callback registration function
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_HF_MODULE
* @brief Called when a call status updated event happened from Hands-Free.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3 @endif
* @remarks call_info_list has elements which consist of bt_hf_call_status_info_s
* @remarks The @a call_info_list must be released with bt_hf_free_call_status_info_list() by you.
*
BT_DPM_ENABLE = 1, /**< DPM Policy status enabled. */
BT_DPM_DISABLE = 0, /**< DPM Policy status disabled. */
- BT_DPM_FALSE = 0, /**< DPM Policy status false. */
+ BT_DPM_FALSE = 0, /**< DPM Policy status false. */
BT_DPM_TRUE = 1, /**< DPM Policy status true. */
} bt_dpm_status_e;
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE
* @brief Device LE connection update structure.
- * @since_tizen 2.3.1
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef struct {
unsigned int interval_min; /**< Minimum value for the connection event interval (msec) */
/**
* @internal
+ * @ingroup
* @brief IPSP Init state changed callback
+ * @since_tizen 3.0
*/
typedef void (*bt_ipsp_init_state_changed_cb)
(int result, bool ipsp_initialized, void *user_data);
/**
* @internal
+ * @ingroup
+ * @since_tizen 3.0
+
* @brief IPSP Connection state changed callback
*/
typedef void (*bt_ipsp_connection_state_changed_cb)
projects / platform / core / api / bluetooth.git / commitdiff