TizenRT Public API  v2.0 M2
bluetooth_type.h File Reference

API to control the Bluetooth adapter, devices and communications. More...

#include <stdlib.h>
#include <unistd.h>
#include <stdbool.h>
#include "tizen_error.h"
Include dependency graph for bluetooth_type.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  bt_avrcp_metadata_attributes_info_s
 Structure of Track metadata information. 3.0. More...
 
struct  bt_class_s
 Class structure of device and service. 2.3. More...
 
struct  bt_adapter_device_discovery_info_s
 Structure of device discovery information. 2.3. More...
 
struct  bt_adapter_le_device_scan_result_info_s
 Structure of le scan result information. 2.3.1. More...
 
struct  bt_adapter_le_ibeacon_scan_result_info_s
 The structure for LE iBeacon scan result information. 4.0. More...
 
struct  bt_adapter_le_service_data_s
 LE service data structure. 2.3.1. More...
 
struct  bt_device_info_s
 Device information structure used for identifying pear device. 2.3. More...
 
struct  bt_device_sdp_info_s
 Service Discovery Protocol (SDP) data structure. More...
 
struct  bt_device_connection_info_s
 Device connection information structure. 2.3. More...
 
struct  bt_socket_connection_s
 Rfcomm connection data used for exchanging data between Bluetooth devices. 2.3. More...
 
struct  bt_socket_received_data_s
 Structure of RFCOMM received data. 2.3. More...
 
struct  bt_gatt_client_att_mtu_info_s
 Attribute protocol MTU change information structure. 4.0. More...
 
struct  bt_hid_mouse_data_s
 The structure type containing the HID mouse event information. . More...
 
struct  bt_hid_key_data_s
 The structure type containing the HID keyboard event information. More...
 
struct  bt_hid_device_received_data_s
 The structure type containing data received from the HID Host. . More...
 
struct  bt_pbap_vcard_info_s
 The structure type containing vCard information. 3.0. More...
 

Typedefs

typedef void(* bt_avrcp_control_connection_state_changed_cb) (bool connected, const char *remote_address, void *user_data)
 Called when the connection state is changed. 3.0. More...
 
typedef void(* bt_avrcp_position_changed_cb) (unsigned int position, void *user_data)
 Called when the Song position mode is changed by the remote target device. 3.0. More...
 
typedef void(* bt_avrcp_track_info_changed_cb) (bt_avrcp_metadata_attributes_info_s *track, void *user_data)
 Called when the Song metadata information is changed by the remote target device. 3.0. More...
 
typedef void(* bt_avrcp_play_status_changed_cb) (bt_avrcp_player_state_e play_state, void *user_data)
 Called when the Song Play status mode is changed by the remote target device. 3.0. More...
 
typedef void * bt_advertiser_h
 The handle to control Bluetooth LE advertising. 2.3. More...
 
typedef void * bt_gatt_h
 The handle of a service, characteristic or descriptor. 2.3.1. More...
 
typedef void * bt_gatt_client_h
 The handle of a GATT client which is associated with a remote device. 2.3.1. More...
 
typedef void * bt_gatt_server_h
 The handle of a GATT server. 3.0. More...
 
typedef void * bt_call_list_h
 The handle of calls state. 2.3. More...
 
typedef void(* bt_ipsp_init_state_changed_cb) (int result, bool ipsp_initialized, void *user_data)
 Called when the IPSP initialization state changes. 4.0. More...
 
typedef void(* bt_ipsp_connection_state_changed_cb) (int result, bool connected, const char *remote_address, const char *iface_name, void *user_data)
 Called when the IPSP connection state changes. 4.0. More...
 
typedef void(* bt_adapter_state_changed_cb) (int result, bt_adapter_state_e adapter_state, void *user_data)
 Called when the Bluetooth adapter state changes. 2.3. More...
 
typedef void(* bt_adapter_name_changed_cb) (char *device_name, void *user_data)
 Called when adapter name changes. 2.3. More...
 
typedef void(* bt_adapter_visibility_mode_changed_cb) (int result, bt_adapter_visibility_mode_e visibility_mode, void *user_data)
 Called when the visibility mode changes. 2.3. More...
 
typedef void(* bt_adapter_visibility_duration_changed_cb) (int duration, void *user_data)
 Called every second until the visibility mode is changed to BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. 2.3. More...
 
typedef void(* bt_adapter_device_discovery_state_changed_cb) (int result, bt_adapter_device_discovery_state_e discovery_state, bt_adapter_device_discovery_info_s *discovery_info, void *user_data)
 Called when the state of device discovery changes. 2.3. More...
 
typedef bool(* bt_adapter_bonded_device_cb) (bt_device_info_s *device_info, void *user_data)
 Called when you get bonded devices repeatedly. 2.3. More...
 
typedef void(* bt_adapter_le_scan_result_cb) (int result, bt_adapter_le_device_scan_result_info_s *info, void *user_data)
 Called when the LE advertisement has been found. 2.3.1. More...
 
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)
 Called when the state of advertiser changes. 2.3. More...
 
typedef void(* bt_device_bond_created_cb) (int result, bt_device_info_s *device_info, void *user_data)
 Called when the process of creating bond finishes. 2.3. More...
 
typedef bool(* bt_device_connected_profile) (bt_profile_e profile, void *user_data)
 Called when you get connected profiles repeatedly. 2.3. More...
 
typedef void(* bt_device_bond_destroyed_cb) (int result, char *remote_address, void *user_data)
 Called when the bond destroys. 2.3. More...
 
typedef void(* bt_device_authorization_changed_cb) (bt_device_authorization_e authorization, char *remote_address, void *user_data)
 Called when the authorization of device changes. 2.3. More...
 
typedef void(* bt_device_service_searched_cb) (int result, bt_device_sdp_info_s *sdp_info, void *user_data)
 Called when the process of service search finishes. 2.3. More...
 
typedef void(* bt_device_connection_state_changed_cb) (bool connected, bt_device_connection_info_s *conn_info, void *user_data)
 Called when the connection state is changed. 2.3. More...
 
typedef void(* bt_socket_data_received_cb) (bt_socket_received_data_s *data, void *user_data)
 Called when you receive data. 2.3. More...
 
typedef void(* bt_socket_connection_state_changed_cb) (int result, bt_socket_connection_state_e connection_state, bt_socket_connection_s *connection, void *user_data)
 Called when the socket connection state changes. 2.3. More...
 
typedef void(* bt_socket_connection_requested_cb) (int socket_fd, const char *remote_address, void *user_data)
 Called when a RFCOMM connection is requested. 2.3. More...
 
typedef void(* bt_opp_server_connection_requested_cb) (const char *remote_address, void *user_data)
 Called when an OPP connection is requested. More...
 
typedef void(* bt_opp_server_transfer_progress_cb) (const char *file, long long size, int percent, void *user_data)
 Called when a file is being transferred. 2.3. More...
 
typedef void(* bt_opp_server_transfer_finished_cb) (int result, const char *file, long long size, void *user_data)
 Called when a transfer is finished. 2.3. More...
 
typedef void(* bt_opp_client_push_responded_cb) (int result, const char *remote_address, void *user_data)
 Called when OPP server responds to the push request. 2.3. More...
 
typedef void(* bt_opp_client_push_progress_cb) (const char *file, long long size, int percent, void *user_data)
 Called when each file is being transferred. 2.3. More...
 
typedef void(* bt_opp_client_push_finished_cb) (int result, const char *remote_address, void *user_data)
 Called when the push request is finished. 2.3. More...
 
typedef void(* bt_audio_connection_state_changed_cb) (int result, bool connected, const char *remote_address, bt_audio_profile_type_e type, void *user_data)
 Called when the connection state is changed. More...
 
typedef void(* bt_ag_call_handling_event_cb) (bt_ag_call_handling_event_e event, unsigned int call_id, void *user_data)
 Called when a call handling event happened from Hands-Free. 2.3. More...
 
typedef void(* bt_ag_multi_call_handling_event_cb) (bt_ag_multi_call_handling_event_e event, void *user_data)
 Called when a multi call handling event happened from Hands-Free. 2.3. More...
 
typedef void(* bt_ag_dtmf_transmitted_cb) (const char *dtmf, void *user_data)
 Called when a DTMF (Dual Tone Multi Frequency) is transmitted from Hands-Free. 2.3. More...
 
typedef void(* bt_ag_speaker_gain_changed_cb) (int gain, void *user_data)
 Called when the speaker gain of the remote device is changed. 2.3. More...
 
typedef void(* bt_ag_microphone_gain_changed_cb) (int gain, void *user_data)
 Called when the microphone gain of the remote device is changed. 2.3. More...
 
typedef void(* bt_avrcp_target_connection_state_changed_cb) (bool connected, const char *remote_address, void *user_data)
 Called when the connection state is changed. 2.3. More...
 
typedef void(* bt_avrcp_equalizer_state_changed_cb) (bt_avrcp_equalizer_state_e equalizer, void *user_data)
 Called when the equalizer state is changed by the remote control device. 2.3. More...
 
typedef void(* bt_avrcp_repeat_mode_changed_cb) (bt_avrcp_repeat_mode_e repeat, void *user_data)
 Called when the repeat mode is changed by the remote control device. 2.3. More...
 
typedef void(* bt_avrcp_shuffle_mode_changed_cb) (bt_avrcp_shuffle_mode_e shuffle, void *user_data)
 Called when the shuffle mode is changed by the remote control device. 2.3. More...
 
typedef void(* bt_avrcp_scan_mode_changed_cb) (bt_avrcp_scan_mode_e scan, void *user_data)
 Called when the scan mode is changed by the remote control device. 2.3. More...
 
typedef void(* bt_hid_host_connection_state_changed_cb) (int result, bool connected, const char *remote_address, void *user_data)
 Called when the connection state is changed. More...
 
typedef void(* bt_hdp_connected_cb) (int result, const char *remote_address, const char *app_id, bt_hdp_channel_type_e type, unsigned int channel, void *user_data)
 Called when the connection is established. 2.3. More...
 
typedef void(* bt_hdp_disconnected_cb) (int result, const char *remote_address, unsigned int channel, void *user_data)
 Called when the connection is disconnected. 2.3. More...
 
typedef void(* bt_hdp_data_received_cb) (unsigned int channel, const char *data, unsigned int size, void *user_data)
 Called when the you receive the data. 2.3. More...
 
typedef bool(* bt_gatt_foreach_cb) (int total, int index, bt_gatt_h gatt_handle, void *user_data)
 Called when you get GATT handles repeatedly. 2.3.1. More...
 
typedef void(* bt_gatt_client_att_mtu_changed_cb) (bt_gatt_client_h client, const bt_gatt_client_att_mtu_info_s *mtu_info, void *user_data)
 Called when the ATT MTU value is changed. 4.0. More...
 
typedef void(* bt_gatt_client_request_completed_cb) (int result, bt_gatt_h request_handle, void *user_data)
 Called when the client request(e.g. read / write) has been completed. 2.3.1. More...
 
typedef void(* bt_gatt_client_characteristic_value_changed_cb) (bt_gatt_h characteristic, char *value, int len, void *user_data)
 Called when a value of a watched characteristic's GATT handle has been changed. 2.3.1. More...
 
typedef void(* bt_hrp_connection_state_changed_cb) (int result, bool connected, const char *remote_address)
 Called when the connection state is changed. More...
 
typedef void(* bt_gatt_client_service_changed_cb) (bt_gatt_client_h client, bt_gatt_client_service_change_type_e change_type, const char *service_uuid, void *user_data)
 Called when a service of a remote GATT server has been changed. 3.0. More...
 
typedef void(* bt_gatt_connection_state_changed_cb) (int result, bool connected, const char *remote_address, void *user_data)
 Called when the connection state is changed. More...
 
typedef void(* bt_gatt_server_write_value_requested_cb) (const char *remote_address, int request_id, bt_gatt_server_h server, bt_gatt_h gatt_handle, bool response_needed, int offset, const char *value, int len, void *user_data)
 Called when a value of a characteristic or descriptor's GATT handle has been changed. More...
 
typedef void(* bt_gatt_server_read_value_requested_cb) (const char *remote_address, int request_id, bt_gatt_server_h server, bt_gatt_h gatt_handle, int offset, void *user_data)
 Called when the remote device requests to read a value on a GATT server. More...
 
typedef void(* bt_gatt_server_characteristic_notification_state_changed_cb) (bool notify, bt_gatt_server_h server, bt_gatt_h gatt_handle, void *user_data)
 Called when the remote device enables or disables the Notification/Indication for particular characteristics. More...
 
typedef void(* bt_hrp_sensor_characteristic_notification_state_changed_cb) (bool notify, bt_gatt_server_h server, bt_gatt_h gatt_handle, void *user_data)
 Called when the remote device enables or disables the Notification/Indication for particular characteristics for HRP. More...
 
typedef void(* bt_gatt_server_notification_sent_cb) (int result, const char *remote_address, bt_gatt_server_h server, bt_gatt_h characteristic, bool completed, void *user_data)
 Called when the sending notification / indication is done. 3.0. More...
 
typedef void(* bt_nap_connection_state_changed_cb) (bool connected, const char *remote_address, const char *interface_name, void *user_data)
 Called when the connection state is changed. 2.3. More...
 
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)
 Called when the connection state is changed. More...
 
typedef void(* bt_hid_device_connection_state_changed_cb) (int result, bool connected, const char *remote_address, void *user_data)
 Called when the Bluetooth HID Device connection state changes. More...
 
typedef void(* bt_hid_device_data_received_cb) (const bt_hid_device_received_data_s *data, void *user_data)
 Called when the HID Device receives data from the HID Host. More...
 
typedef void(* bt_pbap_connection_state_changed_cb) (int result, bool connected, const char *remote_address, void *user_data)
 Called when PBAP is Connected or Disconnected. More...
 
typedef void(* bt_pbap_phone_book_size_cb) (int result, const char *remote_address, int size, void *user_data)
 Called when PBAP Phonebook size calculation completes. More...
 
typedef void(* bt_pbap_phone_book_received_cb) (int result, const char *remote_address, const char *vcf_file, void *user_data)
 Called when PBAP Phonebook Pull completes. More...
 
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)
 Called when PBAP List vCards completes. More...
 
typedef void * bt_scan_filter_h
 The handle of a Bluetooth LE scan filter. 4.0. More...
 

Enumerations

Detailed Description

API to control the Bluetooth adapter, devices and communications.

Definition in file bluetooth_type.h.

Typedef Documentation

typedef bool(* bt_adapter_bonded_device_cb) (bt_device_info_s *device_info, void *user_data)

Called when you get bonded devices repeatedly. 2.3.

Parameters
[in]device_infoThe bonded device information
[in]user_dataThe user data passed from the foreach function
Returns
true to continue with the next iteration of the loop,
false to break out of the loop.
Precondition
bt_adapter_foreach_bonded_device() will invoke this function.
See also
bt_adapter_foreach_bonded_device()

Definition at line 1156 of file bluetooth_type.h.

typedef void(* bt_adapter_device_discovery_state_changed_cb) (int result, bt_adapter_device_discovery_state_e discovery_state, bt_adapter_device_discovery_info_s *discovery_info, void *user_data)

Called when the state of device discovery changes. 2.3.

Remarks
If 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.
Parameters
[in]resultThe result of the device discovery
[in]discovery_stateThe discovery state to be changed
[in]discovery_infoThe information of the discovered device
If discovery_state is BT_ADAPTER_DEVICE_DISCOVERY_STARTED or BT_ADAPTER_DEVICE_DISCOVERY_FINISHED, then discovery_info is NULL.
[in]user_dataThe user data passed from the callback registration function
Precondition
Either bt_adapter_start_device_discovery() or bt_adapter_stop_device_discovery() will invoke this function if you register this callback using bt_adapter_set_device_discovery_state_changed_cb().
See also
bt_adapter_start_device_discovery()
bt_adapter_stop_device_discovery()
bt_adapter_set_device_discovery_state_changed_cb()
bt_adapter_unset_device_discovery_state_changed_cb()

Definition at line 1140 of file bluetooth_type.h.

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)

Called when the state of advertiser changes. 2.3.

Parameters
[out]resultThe result of the requested state change of advertiser
[out]advertiserThe handle of the state changed advertiser
[out]adv_stateThe advertiser state to be changed
[out]user_dataThe user data passed from the start function
See also
bt_adapter_le_start_advertising_new()
bt_adapter_le_stop_advertising()

Definition at line 1186 of file bluetooth_type.h.

typedef void(* bt_adapter_le_scan_result_cb) (int result, bt_adapter_le_device_scan_result_info_s *info, void *user_data)

Called when the LE advertisement has been found. 2.3.1.

Parameters
[in]resultThe result of the LE scan
[in]infoThe information of the found LE advertisement.
[in]user_dataThe user data passed from the start function
See also
bt_adapter_le_start_scan()

Definition at line 1170 of file bluetooth_type.h.

typedef void(* bt_adapter_name_changed_cb) (char *device_name, void *user_data)

Called when adapter name changes. 2.3.

Parameters
[in]device_nameThe name of the Bluetooth device to be changed
[in]user_dataThe user data passed from the callback registration function
Precondition
This function will be invoked when the name of Bluetooth adapter changes if you register this callback using bt_adapter_set_name_changed_cb().
See also
bt_adapter_set_name()
bt_adapter_set_name_changed_cb()
bt_adapter_unset_name_changed_cb()

Definition at line 1081 of file bluetooth_type.h.

typedef void(* bt_adapter_state_changed_cb) (int result, bt_adapter_state_e adapter_state, void *user_data)

Called when the Bluetooth adapter state changes. 2.3.

Parameters
[in]resultThe result of the adapter state changing
[in]adapter_stateThe adapter state to be changed
[in]user_dataThe user data passed from the callback registration function
See also
bt_adapter_set_state_changed_cb()
bt_adapter_unset_state_changed_cb()

Definition at line 1066 of file bluetooth_type.h.

typedef void(* bt_adapter_visibility_duration_changed_cb) (int duration, void *user_data)

Called every second until the visibility mode is changed to BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. 2.3.

Remarks
This callback function is called only if visibility mode is BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE.
Parameters
[in]durationThe duration until the visibility mode is changed to BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE (in seconds)
[in]user_dataThe user data passed from the callback registration function
Precondition
This function will be invoked if you register this callback using bt_adapter_set_visibility_duration_changed_cb().
See also
bt_adapter_set_visibility_duration_changed_cb()
bt_adapter_unset_visibility_duration_changed_cb()

Definition at line 1113 of file bluetooth_type.h.

typedef void(* bt_adapter_visibility_mode_changed_cb) (int result, bt_adapter_visibility_mode_e visibility_mode, void *user_data)

Called when the visibility mode changes. 2.3.

Parameters
[in]resultThe result of the visibility mode changing
[in]visibility_modeThe visibility mode to be changed
[in]user_dataThe user data passed from the callback registration function
Precondition
This function will be invoked when the visibility of Bluetooth adapter changes if you register this callback using bt_adapter_set_visibility_mode_changed_cb().
See also
bt_adapter_set_visibility_mode_changed_cb()
bt_adapter_unset_visibility_mode_changed_cb()

Definition at line 1099 of file bluetooth_type.h.

typedef void* bt_advertiser_h

The handle to control Bluetooth LE advertising. 2.3.

Definition at line 772 of file bluetooth_type.h.

typedef void(* bt_ag_call_handling_event_cb) (bt_ag_call_handling_event_e event, unsigned int call_id, void *user_data)

Called when a call handling event happened from Hands-Free. 2.3.

Parameters
[in]eventThe call handling event happened from Hands-Free
[in]call_idThe call ID
[in]user_dataThe user data passed from the callback registration function
See also
bt_ag_set_call_handling_event_cb()
bt_ag_unset_call_handling_event_cb()

Definition at line 1451 of file bluetooth_type.h.

typedef void(* bt_ag_dtmf_transmitted_cb) (const char *dtmf, void *user_data)

Called when a DTMF (Dual Tone Multi Frequency) is transmitted from Hands-Free. 2.3.

Parameters
[in]dtmfThe DTMF transmitted from Hands-Free
[in]user_dataThe user data passed from the callback registration function
See also
bt_ag_set_dtmf_transmitted_cb()
bt_ag_unset_dtmf_transmitted_cb()

Definition at line 1475 of file bluetooth_type.h.

typedef void(* bt_ag_microphone_gain_changed_cb) (int gain, void *user_data)

Called when the microphone gain of the remote device is changed. 2.3.

Parameters
[in]gainThe gain of microphone (0 ~ 15)
[in]user_dataThe user data passed from the callback registration function
See also
bt_ag_set_microphone_gain_changed_cb()
bt_ag_unset_microphone_gain_changed_cb()

Definition at line 1499 of file bluetooth_type.h.

typedef void(* bt_ag_multi_call_handling_event_cb) (bt_ag_multi_call_handling_event_e event, void *user_data)

Called when a multi call handling event happened from Hands-Free. 2.3.

Parameters
[in]eventThe call handling event happened from Hands-Free
[in]user_dataThe user data passed from the callback registration function
See also
bt_ag_set_multi_call_handling_event_cb()
bt_ag_unset_multi_call_handling_event_cb()

Definition at line 1463 of file bluetooth_type.h.

typedef void(* bt_ag_speaker_gain_changed_cb) (int gain, void *user_data)

Called when the speaker gain of the remote device is changed. 2.3.

Parameters
[in]gainThe gain of speaker (0 ~ 15)
[in]user_dataThe user data passed from the callback registration function
See also
bt_ag_set_speaker_gain_changed_cb()
bt_ag_unset_speaker_gain_changed_cb()

Definition at line 1487 of file bluetooth_type.h.

typedef void(* bt_audio_connection_state_changed_cb) (int result, bool connected, const char *remote_address, bt_audio_profile_type_e type, void *user_data)

Called when the connection state is changed.

This callback is called when the connection state is changed. 2.3 When you call bt_audio_connect() or bt_audio_disconnect(), this callback is also called with error result even though these functions fail.

Parameters
[in]resultThe result of changing the connection state
[in]connectedThe state to be changed. true means connected state, Otherwise, false.
[in]remote_addressThe remote address
[in]typeThe type of audio profile except BT_AUDIO_PROFILE_TYPE_ALL
[in]user_dataThe user data passed from the callback registration function
See also
bt_audio_set_connection_state_changed_cb()
bt_audio_unset_connection_state_changed_cb()

Definition at line 1438 of file bluetooth_type.h.

typedef void(* bt_avrcp_control_connection_state_changed_cb) (bool connected, const char *remote_address, void *user_data)

Called when the connection state is changed. 3.0.

Parameters
[in]connectedThe state to be changed. true means connected state, Otherwise, false.
[in]remote_addressThe remote address
[in]user_dataThe user data passed from the callback registration function
See also
bt_avrcp_control_initialize()
bt_avrcp_control_deinitialize()

Definition at line 606 of file bluetooth_type.h.

typedef void(* bt_avrcp_equalizer_state_changed_cb) (bt_avrcp_equalizer_state_e equalizer, void *user_data)

Called when the equalizer state is changed by the remote control device. 2.3.

Parameters
[in]equalizerThe equalizer state
[in]user_dataThe user data passed from the callback registration function
See also
bt_avrcp_set_equalizer_state_changed_cb()
bt_avrcp_unset_equalizer_state_changed_cb()

Definition at line 1524 of file bluetooth_type.h.

typedef void(* bt_avrcp_play_status_changed_cb) (bt_avrcp_player_state_e play_state, void *user_data)

Called when the Song Play status mode is changed by the remote target device. 3.0.

Parameters
[in]play_stateThe song play status
[in]user_dataThe user data passed from the callback registration function
See also
bt_avrcp_set_play_status_changed_cb()
bt_avrcp_unset_play_status_changed_cb()

Definition at line 639 of file bluetooth_type.h.

typedef void(* bt_avrcp_position_changed_cb) (unsigned int position, void *user_data)

Called when the Song position mode is changed by the remote target device. 3.0.

Parameters
[in]positionPlayback position in milliseconds. When position is 0 it means the track is starting and when it's greater than or equal to track's duration the track has ended.
[in]user_dataThe user data passed from the callback registration function
See also
bt_avrcp_set_position_changed_cb()
bt_avrcp_unset_position_changed_cb()

Definition at line 617 of file bluetooth_type.h.

typedef void(* bt_avrcp_repeat_mode_changed_cb) (bt_avrcp_repeat_mode_e repeat, void *user_data)

Called when the repeat mode is changed by the remote control device. 2.3.

Parameters
[in]repeatThe repeat mode
[in]user_dataThe user data passed from the callback registration function
See also
bt_avrcp_set_repeat_mode_changed_cb()
bt_avrcp_unset_repeat_mode_changed_cb()

Definition at line 1536 of file bluetooth_type.h.

typedef void(* bt_avrcp_scan_mode_changed_cb) (bt_avrcp_scan_mode_e scan, void *user_data)

Called when the scan mode is changed by the remote control device. 2.3.

Parameters
[in]scanThe scan mode
[in]user_dataThe user data passed from the callback registration function
See also
bt_avrcp_set_scan_mode_changed_cb()
bt_avrcp_unset_scan_mode_changed_cb()

Definition at line 1560 of file bluetooth_type.h.

typedef void(* bt_avrcp_shuffle_mode_changed_cb) (bt_avrcp_shuffle_mode_e shuffle, void *user_data)

Called when the shuffle mode is changed by the remote control device. 2.3.

Parameters
[in]shuffleThe shuffle mode
[in]user_dataThe user data passed from the callback registration function
See also
bt_avrcp_set_shuffle_mode_changed_cb()
bt_avrcp_unset_shuffle_mode_changed_cb()

Definition at line 1548 of file bluetooth_type.h.

typedef void(* bt_avrcp_target_connection_state_changed_cb) (bool connected, const char *remote_address, void *user_data)

Called when the connection state is changed. 2.3.

Parameters
[in]connectedThe state to be changed. true means connected state, Otherwise, false.
[in]remote_addressThe remote address
[in]user_dataThe user data passed from the callback registration function
See also
bt_avrcp_target_initialize()
bt_avrcp_target_deinitialize()

Definition at line 1512 of file bluetooth_type.h.

typedef void(* bt_avrcp_track_info_changed_cb) (bt_avrcp_metadata_attributes_info_s *track, void *user_data)

Called when the Song metadata information is changed by the remote target device. 3.0.

Parameters
[in]trackThe song metadata information
[in]user_dataThe user data passed from the callback registration function
See also
bt_avrcp_set_track_info_changed_cb()
bt_avrcp_unset_track_info_changed_cb()

Definition at line 628 of file bluetooth_type.h.

typedef void* bt_call_list_h

The handle of calls state. 2.3.

Definition at line 860 of file bluetooth_type.h.

typedef void(* bt_device_authorization_changed_cb) (bt_device_authorization_e authorization, char *remote_address, void *user_data)

Called when the authorization of device changes. 2.3.

Parameters
[in]authorizationThe authorization of device
[in]remote_addressThe address of the remote Bluetooth device which is (un)authorized
[in]user_dataThe user data passed from the callback registration function
Precondition
bt_device_set_authorization() will invoke this function if you register this callback using bt_device_set_authorization_changed_cb().
See also
bt_device_set_authorization()
bt_device_set_authorization_changed_cb()
bt_device_unset_authorization_changed_cb()

Definition at line 1260 of file bluetooth_type.h.

typedef void(* bt_device_bond_created_cb) (int result, bt_device_info_s *device_info, void *user_data)

Called when the process of creating bond finishes. 2.3.

Remarks
If the remote user does not respond within 60 seconds, a time out will happen with BT_ERROR_TIMED_OUT result code.
If bt_device_cancel_bonding() is called and it returns BT_ERROR_NONE, then this callback function will be called
with BT_ERROR_CANCELLED result.
If creating a bond succeeds but service search fails, then this callback will be called with BT_ERROR_SERVICE_SEARCH_FAILED.
In this case, you should try service search again by bt_device_start_service_search() to get the supported service list.
Parameters
[in]resultThe result of the bonding device
[in]device_infoThe device information which you creates bond with
[in]user_dataThe user data passed from the callback registration function
Precondition
Either bt_device_create_bond() will invoke this function if you register this callback using bt_device_set_bond_created_cb().
See also
bt_device_create_bond()
bt_device_cancel_bonding()
bt_device_set_bond_created_cb()
bt_device_unset_bond_created_cb()

Definition at line 1212 of file bluetooth_type.h.

typedef void(* bt_device_bond_destroyed_cb) (int result, char *remote_address, void *user_data)

Called when the bond destroys. 2.3.

Parameters
[in]resultThe result that a bond is destroyed
[in]remote_addressThe address of the remote Bluetooth device to destroy bond with
[in]user_dataThe user data passed from the callback registration function
Precondition
bt_device_destroy_bond() will invoke this function if you register this callback using bt_device_set_bond_destroyed_cb().
See also
bt_device_destroy_bond()
bt_device_set_bond_destroyed_cb()
bt_device_unset_bond_destroyed_cb()

Definition at line 1243 of file bluetooth_type.h.

typedef bool(* bt_device_connected_profile) (bt_profile_e profile, void *user_data)

Called when you get connected profiles repeatedly. 2.3.

Parameters
[in]profileThe connected Bluetooth profile
[in]user_dataThe user data passed from the foreach function
Returns
true to continue with the next iteration of the loop,
false to break out of the loop.
Precondition
bt_device_foreach_connected_profiles() will invoke this function.
See also
bt_device_foreach_connected_profiles()

Definition at line 1226 of file bluetooth_type.h.

typedef void(* bt_device_connection_state_changed_cb) (bool connected, bt_device_connection_info_s *conn_info, void *user_data)

Called when the connection state is changed. 2.3.

Parameters
[in]connectedThe connection status: (true = connected, false = disconnected)
[in]conn_infoThe connection information
[in]user_dataThe user data passed from the callback registration function
See also
bt_device_set_connection_state_changed_cb()
bt_device_unset_connection_state_changed_cb()

Definition at line 1291 of file bluetooth_type.h.

typedef void(* bt_device_service_searched_cb) (int result, bt_device_sdp_info_s *sdp_info, void *user_data)

Called when the process of service search finishes. 2.3.

Parameters
[in]resultThe result of the service searching
[in]sdp_infoThe structure of service lists found on a device
[in]user_dataThe user data passed from the callback registration function
Precondition
Either bt_device_start_service_search() will invoke this function if you register this callback using bt_device_set_service_searched_cb().
See also
bt_device_start_service_search()
bt_device_set_service_searched_cb()
bt_device_unset_service_searched_cb()

Definition at line 1278 of file bluetooth_type.h.

typedef void(* bt_gatt_client_att_mtu_changed_cb) (bt_gatt_client_h client, const bt_gatt_client_att_mtu_info_s *mtu_info, void *user_data)

Called when the ATT MTU value is changed. 4.0.

Remarks
The mtu_info must not be freed by application.
mtu_info can be used only inside the callback.
If it's needed outside, make a copy.
Parameters
[in]clientThe handle of a GATT client which is associated with a remote device
[in]mtu_infoThe MTU information
[in]user_dataThe user data passed from the callback registration function
See also
bt_gatt_client_set_connection_state_changed_cb()
bt_gatt_client_unset_connection_state_changed_cb()

Definition at line 1675 of file bluetooth_type.h.

typedef void(* bt_gatt_client_characteristic_value_changed_cb) (bt_gatt_h characteristic, char *value, int len, void *user_data)

Called when a value of a watched characteristic's GATT handle has been changed. 2.3.1.

Remarks
After this function is returned, a changed value is automatically
applied to characteristic. Before that, characteristic has an old value.
Parameters
[in]characteristicThe characteristic's GATT handle of which value change is informed. It has an old value.
[in]valueThe new value
[in]lenThe length of value
[in]user_dataThe user data passed from the registering function
See also
bt_gatt_client_set_characteristic_value_changed_cb()

Definition at line 1709 of file bluetooth_type.h.

typedef void* bt_gatt_client_h

The handle of a GATT client which is associated with a remote device. 2.3.1.

Definition at line 846 of file bluetooth_type.h.

typedef void(* bt_gatt_client_request_completed_cb) (int result, bt_gatt_h request_handle, void *user_data)

Called when the client request(e.g. read / write) has been completed. 2.3.1.

Parameters
[in]resultThe result of a request
[in]request_handleThe requesting GATT handle
[in]user_dataThe user data passed from the requesting function
See also
bt_gatt_client_read_value()
bt_gatt_client_write_value()

Definition at line 1691 of file bluetooth_type.h.

typedef void(* bt_gatt_client_service_changed_cb) (bt_gatt_client_h client, bt_gatt_client_service_change_type_e change_type, const char *service_uuid, void *user_data)

Called when a service of a remote GATT server has been changed. 3.0.

Parameters
[in]clientThe handle of a GATT client which is associated with a remote device.
[in]change_typeThe changed type
[in]service_uuidThe changed service uuid
[in]user_dataThe user data passed from the registering function
See also
bt_gatt_client_set_characteristic_value_changed_cb()

Definition at line 1740 of file bluetooth_type.h.

typedef void(* bt_gatt_connection_state_changed_cb) (int result, bool connected, const char *remote_address, void *user_data)

Called when the connection state is changed.

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.

2.3

Parameters
[in]resultThe result of changing the connection state.
[in]connectedThe state to be changed, true means connected state, Otherwise, false.
[in]remote_addressThe remote_address
[in]user_dataThe user data passed from the callback registration function.
See also
bt_gatt_connect()
bt_gatt_disconnect()
bt_gatt_set_connection_state_changed_cb()
bt_gatt_unset_connection_state_changed_cb()

Definition at line 1762 of file bluetooth_type.h.

typedef bool(* bt_gatt_foreach_cb) (int total, int index, bt_gatt_h gatt_handle, void *user_data)

Called when you get GATT handles repeatedly. 2.3.1.

Parameters
[in]totalThe total number of GATT handles to be called
[in]indexThe index of current GATT handle. It starts from 0.
[in]gatt_handleThe GATT handle
[in]user_dataThe user data passed from the foreach function
See also
bt_gatt_service_foreach_characteristics()
bt_gatt_service_foreach_included_services()
bt_gatt_characteristic_foreach_descriptors()
bt_gatt_client_foreach_services()

Definition at line 1644 of file bluetooth_type.h.

typedef void* bt_gatt_h

The handle of a service, characteristic or descriptor. 2.3.1.

Definition at line 839 of file bluetooth_type.h.

typedef void(* bt_gatt_server_characteristic_notification_state_changed_cb) (bool notify, bt_gatt_server_h server, bt_gatt_h gatt_handle, void *user_data)

Called when the remote device enables or disables the Notification/Indication for particular characteristics.

By using this callback function, server can know notification state.

3.0

Remarks
The server must not be freed by application.
The gatt_handle must not be freed by application.
Parameters
[in]notifyIndicates whether the Notification/Indication is enabled or not
[in]serverThe GATT server handle
[in]gatt_handleThe characteristic's GATT handle to be read
[in]user_dataThe user data passed from the registration function
See also
bt_gatt_server_set_read_value_requested_cb()

Definition at line 1838 of file bluetooth_type.h.

typedef void* bt_gatt_server_h

The handle of a GATT server. 3.0.

Definition at line 853 of file bluetooth_type.h.

typedef void(* bt_gatt_server_notification_sent_cb) (int result, const char *remote_address, bt_gatt_server_h server, bt_gatt_h characteristic, bool completed, void *user_data)

Called when the sending notification / indication is done. 3.0.

Remarks
The remote_address must not be freed by application.
The server must not be freed by application.
The characteristic must not be freed by application.
In case of an indication, once a confirmation is received from the remote device this callback will be called.
This callback will be called several times if there are two or more remote devices which enable a Client Characteristic Configuration Descriptor(CCCD).
For the last remote device, completed will be set as true.
Parameters
[in]resultThe result of a sending operation
[in]remote_addressThe address of the remote device
[in]serverThe GATT server handle
[in]characteristicThe characteristic's GATT handle
[in]completedIf this callback is for the last remote device which enables a CCCD, it will be true. Or it will be false.
[in]user_dataThe user data passed from the requesting function
See also
bt_gatt_server_notify_characteristic_changed_value()

Definition at line 1883 of file bluetooth_type.h.

typedef void(* bt_gatt_server_read_value_requested_cb) (const char *remote_address, int request_id, bt_gatt_server_h server, bt_gatt_h gatt_handle, int offset, void *user_data)

Called when the remote device requests to read a value on a GATT server.

For finishing the request, call the function bt_gatt_server_send_response in callback.

3.0

Remarks
The remote_address must not be freed by application.
The server must not be freed by application.
The gatt_handle must not be freed by application.
Parameters
[in]remote_addressThe address of the requesting remote device
[in]request_idThe identification of this request. It will be used to send a response.
[in]serverThe GATT server handle
[in]gatt_handleThe characteristic or descriptor's GATT handle to be read
[in]offsetThe requested offset from where the GATT handle's value is read
[in]user_dataThe user data passed from the registration function
See also
bt_gatt_server_set_read_value_requested_cb()
bt_gatt_server_send_response()

Definition at line 1817 of file bluetooth_type.h.

typedef void(* bt_gatt_server_write_value_requested_cb) (const char *remote_address, int request_id, bt_gatt_server_h server, bt_gatt_h gatt_handle, bool response_needed, int offset, const char *value, int len, void *user_data)

Called when a value of a characteristic or descriptor's GATT handle has been changed.

For finishing the request, call the function bt_gatt_server_send_response in callback.

3.0

Remarks
After this function is returned, a changed value is automatically
applied to gatt_handle. Before that, gatt_handle has an old value.
The remote_address must not be freed by application.
The server must not be freed by application.
The gatt_handle must not be freed by application.
The value must not be freed by application.
Parameters
[in]remote_addressThe address of the remote device which requests a change
[in]request_idThe identification of this request. It will be used to send a response.
[in]serverThe GATT server handle
[in]gatt_handleThe characteristic or descriptor's GATT handle which has an old value
[in]response_neededIndicates whether a response is required by the remote device - true if required, false if not
[in]offsetThe requested offset from where the gatt_handle value will be updated
[in]valueThe new value
[in]lenThe length of value
[in]user_dataThe user data passed from the registration function
See also
bt_gatt_server_set_write_value_requested_cb()
bt_gatt_server_send_response()

Definition at line 1791 of file bluetooth_type.h.

typedef void(* bt_hdp_connected_cb) (int result, const char *remote_address, const char *app_id, bt_hdp_channel_type_e type, unsigned int channel, void *user_data)

Called when the connection is established. 2.3.

Deprecated:
Deprecated since 5.0.
Remarks
Deprecated, because of no usecase and supported devices.
Parameters
[in]resultThe result of connecting to the remote device
[in]remote_addressThe address of connected remote device
[in]app_idThe ID of application
[in]typeThe type of HDP (Health Device Profile) channel
[in]channelThe connected data channel
[in]user_dataThe user data passed from the callback registration function
See also
bt_hdp_set_connection_state_changed_cb()
bt_hdp_unset_connection_state_changed_cb()

Definition at line 1594 of file bluetooth_type.h.

typedef void(* bt_hdp_data_received_cb) (unsigned int channel, const char *data, unsigned int size, void *user_data)

Called when the you receive the data. 2.3.

Deprecated:
Deprecated since 5.0.
Remarks
Deprecated, because of no usecase and supported devices.
Parameters
[in]channelThe connected data channel
[in]dataThe received data
[in]sizeThe size of received data (byte)
[in]user_dataThe user data passed from the callback registration function
See also
bt_hdp_set_data_received_cb()
bt_hdp_unset_data_received_cb()

Definition at line 1627 of file bluetooth_type.h.

typedef void(* bt_hdp_disconnected_cb) (int result, const char *remote_address, unsigned int channel, void *user_data)

Called when the connection is disconnected. 2.3.

Deprecated:
Deprecated since 5.0.
Remarks
Deprecated, because of no usecase and supported devices.
Parameters
[in]resultThe result of disconnecting from the remote device
[in]remote_addressThe address of disconnected remote device
[in]channelThe connected data channel
[in]user_dataThe user data passed from the callback registration function
See also
bt_hdp_set_connection_state_changed_cb()
bt_hdp_unset_connection_state_changed_cb()

Definition at line 1611 of file bluetooth_type.h.

typedef void(* bt_hid_device_connection_state_changed_cb) (int result, bool connected, const char *remote_address, void *user_data)

Called when the Bluetooth HID Device connection state changes.

The following error codes can be delivered:
BT_ERROR_NONE
BT_ERROR_OPERATION_FAILED

Parameters
[in]resultThe result of changing the connection state.
[in]connectedThe requested state. true means the connection is enabled, false means the connection is disabled.
[in]remote_addressThe remote device's address
[in]user_dataThe user data passed from the callback registration function
See also
bt_hid_device_activate()

Definition at line 2025 of file bluetooth_type.h.

typedef void(* bt_hid_device_data_received_cb) (const bt_hid_device_received_data_s *data, void *user_data)

Called when the HID Device receives data from the HID Host.

The following error codes can be delivered:
BT_ERROR_NONE
BT_ERROR_OPERATION_FAILED

Parameters
[in]dataThe data received from the HID Host.
[in]user_dataThe user data passed from the callback registration function
See also
bt_hid_device_set_data_received_cb()

Definition at line 2040 of file bluetooth_type.h.

typedef void(* bt_hid_host_connection_state_changed_cb) (int result, bool connected, const char *remote_address, void *user_data)

Called when the connection state is changed.

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. 2.3

Parameters
[in]resultThe result of changing the connection state
[in]connectedThe state to be changed. true means connected state, Otherwise, false.
[in]remote_addressThe remote address
[in]user_dataThe user data passed from the callback registration function
See also
bt_hid_host_connect()
bt_hid_host_disconnect()

Definition at line 1576 of file bluetooth_type.h.

typedef void(* bt_hrp_connection_state_changed_cb) (int result, bool connected, const char *remote_address)

Called when the connection state is changed.

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.

4.0

Parameters
[in]resultThe result of changing the connection state.
[in]connectedThe state to be changed, true means connected state, Otherwise, false.
[in]remote_addressThe remote_address
[in]user_dataThe user data passed from the callback registration function.

Definition at line 1726 of file bluetooth_type.h.

typedef void(* bt_hrp_sensor_characteristic_notification_state_changed_cb) (bool notify, bt_gatt_server_h server, bt_gatt_h gatt_handle, void *user_data)

Called when the remote device enables or disables the Notification/Indication for particular characteristics for HRP.

By using this callback function, server can know notification state.

3.0

Remarks
The server must not be freed by application.
The gatt_handle must not be freed by application.
Parameters
[in]notifyIndicates whether the Notification/Indication is enabled or not
[in]serverThe GATT server handle
[in]gatt_handleThe characteristic's GATT handle to be read
[in]user_dataThe user data passed from the registration function

Definition at line 1858 of file bluetooth_type.h.

typedef void(* bt_ipsp_connection_state_changed_cb) (int result, bool connected, const char *remote_address, const char *iface_name, void *user_data)

Called when the IPSP connection state changes. 4.0.

Parameters
[in]resultThe result of the connection or disconnection request
[in]connectedThe connection status: (true = connected, false = disconnected)
[in]remote_addressAddress of remote device
[in]iface_nameThe network interface name for IPv6 network interface
[in]user_dataThe user data passed from the callback registration function
See also
bt_ipsp_connect()
bt_ipsp_disconnect()

Definition at line 972 of file bluetooth_type.h.

typedef void(* bt_ipsp_init_state_changed_cb) (int result, bool ipsp_initialized, void *user_data)

Called when the IPSP initialization state changes. 4.0.

Parameters
[in]resultThe result of the initialization or deinitialization request
[in]ipsp_initializedThe initialized state: (true = initialized, false = deinitialized)
[in]user_dataThe user data passed from the initialization request function
See also
bt_ipsp_initialize()
bt_ipsp_deinitialize()

Definition at line 957 of file bluetooth_type.h.

typedef void(* bt_nap_connection_state_changed_cb) (bool connected, const char *remote_address, const char *interface_name, void *user_data)

Called when the connection state is changed. 2.3.

Parameters
[in]connectedIndicates whether a client is connected or disconnected
[in]remote_addressThe remote address
[in]interface_nameThe interface name. For example, bnep0, bnep1.
[in]user_dataThe user data passed from the callback registration function
See also
bt_nap_set_connection_state_changed_cb()
bt_nap_unset_connection_state_changed_cb()

Definition at line 1899 of file bluetooth_type.h.

typedef void(* bt_opp_client_push_finished_cb) (int result, const char *remote_address, void *user_data)

Called when the push request is finished. 2.3.

Parameters
[in]resultThe result of the push request
[in]remote_addressThe remote address
[in]user_dataThe user data passed from the callback registration function
See also
bt_opp_client_push_files()

Definition at line 1421 of file bluetooth_type.h.

typedef void(* bt_opp_client_push_progress_cb) (const char *file, long long size, int percent, void *user_data)

Called when each file is being transferred. 2.3.

Parameters
[in]fileThe path of file to be pushed
[in]sizeThe file size (bytes)
[in]percentThe progress in percentage (1 ~ 100). 100 means that a file is transferred completely.
[in]user_dataThe user data passed from the callback registration function
Precondition
bt_opp_client_push_files() will invoke this function.
See also
bt_opp_client_push_files()

Definition at line 1409 of file bluetooth_type.h.

typedef void(* bt_opp_client_push_responded_cb) (int result, const char *remote_address, void *user_data)

Called when OPP server responds to the push request. 2.3.

Parameters
[in]resultThe result of OPP server response
[in]remote_addressThe remote address
[in]user_dataThe user data passed from the callback registration function
Precondition
bt_opp_client_push_files() will invoke this function.
See also
bt_opp_client_push_files()

Definition at line 1395 of file bluetooth_type.h.

typedef void(* bt_opp_server_connection_requested_cb) (const char *remote_address, void *user_data)

Called when an OPP connection is requested.

You must call bt_opp_server_accept_connection() if you want to accept. Otherwise, you must call bt_opp_server_reject_connection(). 2.3

Parameters
[in]remote_addressThe address of remote device
[in]user_dataThe user data passed from the callback registration function
See also
bt_opp_server_accept()
bt_opp_server_reject()

Definition at line 1354 of file bluetooth_type.h.

typedef void(* bt_opp_server_transfer_finished_cb) (int result, const char *file, long long size, void *user_data)

Called when a transfer is finished. 2.3.

Parameters
[in]resultThe result of push
[in]fileThe path of file to be pushed
[in]sizeThe file size (bytes)
[in]user_dataThe user data passed from the callback registration function
See also
bt_opp_server_accept()
bt_opp_server_accept_connection()

Definition at line 1382 of file bluetooth_type.h.

typedef void(* bt_opp_server_transfer_progress_cb) (const char *file, long long size, int percent, void *user_data)

Called when a file is being transferred. 2.3.

Parameters
[in]fileThe path of file to be pushed
[in]sizeThe file size (bytes)
[in]percentThe progress in percentage (1 ~ 100)
[in]user_dataThe user data passed from the callback registration function
See also
bt_opp_server_accept()
bt_opp_server_accept_connection()

Definition at line 1368 of file bluetooth_type.h.

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)

Called when the connection state is changed.

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. 2.3

Parameters
[in]resultThe result of changing the connection state
[in]connectedThe state to be changed. true means connected state, Otherwise, false.
[in]remote_addressThe remote address
[in]typeThe type of PAN service
[in]user_dataThe user data passed from the callback registration function
See also
bt_nap_set_connection_state_changed_cb()
bt_nap_unset_connection_state_changed_cb()

Definition at line 1916 of file bluetooth_type.h.

typedef void(* bt_pbap_connection_state_changed_cb) (int result, bool connected, const char *remote_address, void *user_data)

Called when PBAP is Connected or Disconnected.

The following error codes can be delivered:
BT_ERROR_NONE
BT_ERROR_AUTH_REJECTED
BT_ERROR_AUTHORIZATION_REJECTED
BT_ERROR_SERVICE_NOT_FOUND
BT_ERROR_TIMED_OUT
BT_ERROR_OPERATION_FAILED
3.0

Parameters
[in]resultThe result of connecting to or disconnecting from the remote device
[in]connectedThe PBAP connection status (true = connected, false = disconnected)
[in]remote_addressThe remote device address (remote_address is valid only inside this function. To use outside the callback, make a copy. remote_address should not be freed.)
[in]user_dataThe user data passed from the callback registration function
See also
bt_pbap_client_connect()
bt_pbap_client_disconnect()

Definition at line 2077 of file bluetooth_type.h.

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)

Called when PBAP List vCards completes.

The following error codes can be delivered:
BT_ERROR_NONE
BT_ERROR_OPERATION_FAILED
3.0

Parameters
[in]resultThe result of getting the vcard list
[in]remote_addressThe remote device address (remote_address is valid only inside this function. To use outside the callback, make a copy. remote_address should not be freed.)
[in]vcard_infoList of vcard information (vcard_info is valid only inside this function. To use outside the callback, make a copy. vcard_info should not be freed.)
[in]countNumber of contacts in the list
[in]user_dataThe user data passed from the callback registration function
See also
bt_pbap_client_get_list()
bt_pbap_client_connect()
bt_pbap_client_disconnect()

Definition at line 2139 of file bluetooth_type.h.

typedef void(* bt_pbap_phone_book_received_cb) (int result, const char *remote_address, const char *vcf_file, void *user_data)

Called when PBAP Phonebook Pull completes.

The received phone book file will be saved in the platform downloads folder.
The following error codes can be delivered:
BT_ERROR_NONE
BT_ERROR_OPERATION_FAILED
3.0

Parameters
[in]resultThe result of getting the phone book
[in]remote_addressThe remote device address (remote_address is valid only inside this function. To use outside the callback, make a copy. remote_address should not be freed.)
[in]vcf_fileThe absolute path of the file in which the vCards are saved (vcf_file is valid only inside this function. To use outside the callback, make a copy. vcf_file should not be freed.)
[in]user_dataThe user data passed from the callback registration function
See also
bt_pbap_client_get_phone_book()
bt_pbap_client_connect()
bt_pbap_client_disconnect()

Definition at line 2118 of file bluetooth_type.h.

typedef void(* bt_pbap_phone_book_size_cb) (int result, const char *remote_address, int size, void *user_data)

Called when PBAP Phonebook size calculation completes.

The following error codes can be delivered:
BT_ERROR_NONE
BT_ERROR_OPERATION_FAILED
3.0

Parameters
[in]resultThe result of getting the phone book size
[in]remote_addressThe remote device address (remote_address is valid only inside this function. To use outside the callback, make a copy. remote_address should not be freed.)
[in]sizeSize of Phonebook
[in]user_dataThe user data passed from the callback registration function
See also
bt_pbap_client_get_phone_book_size()
bt_pbap_client_connect()
bt_pbap_client_disconnect()

Definition at line 2097 of file bluetooth_type.h.

typedef void* bt_scan_filter_h

The handle of a Bluetooth LE scan filter. 4.0.

Definition at line 2158 of file bluetooth_type.h.

typedef void(* bt_socket_connection_requested_cb) (int socket_fd, const char *remote_address, void *user_data)

Called when a RFCOMM connection is requested. 2.3.

Parameters
[in]socket_fdThe file descriptor of socket on which a connection is requested
[in]remote_addressThe address of remote device
[in]user_dataThe user data passed from the callback registration function
Precondition
If you register this callback function by bt_socket_set_connection_requested_cb(), bt_socket_connection_requested_cb() will be invoked.

Definition at line 1340 of file bluetooth_type.h.

typedef void(* bt_socket_connection_state_changed_cb) (int result, bt_socket_connection_state_e connection_state, bt_socket_connection_s *connection, void *user_data)

Called when the socket connection state changes. 2.3.

Parameters
[in]resultThe result of connection state changing
[in]connection_stateThe connection state
[in]connectionThe connection information which is established or disconnected
[in]user_dataThe user data passed from the callback registration function
Precondition
Either bt_socket_connect_rfcomm() will invoke this function. In addition, bt_socket_connection_state_changed_cb() will be invoked when the socket connection state is changed.
See also
bt_socket_listen_and_accept_rfcomm()
bt_socket_connect_rfcomm()
bt_socket_set_connection_state_changed_cb()
bt_socket_unset_connection_state_changed_cb()

Definition at line 1327 of file bluetooth_type.h.

typedef void(* bt_socket_data_received_cb) (bt_socket_received_data_s *data, void *user_data)

Called when you receive data. 2.3.

Parameters
[in]dataThe received data from the remote device
[in]user_dataThe user data passed from the callback registration function
Precondition
When the connected remote Bluetooth device invokes bt_socket_send_data(), this function will be invoked if you register this function using bt_socket_set_data_received_cb().
See also
bt_socket_set_data_received_cb()
bt_socket_unset_data_received_cb()
bt_socket_send_data()

Definition at line 1308 of file bluetooth_type.h.

Enumeration Type Documentation

Enumerations of the discovery state of Bluetooth device. 2.3.

Enumerator
BT_ADAPTER_DEVICE_DISCOVERY_STARTED 

Device discovery is started

BT_ADAPTER_DEVICE_DISCOVERY_FINISHED 

Device discovery is finished

BT_ADAPTER_DEVICE_DISCOVERY_FOUND 

The remote Bluetooth device is found

Definition at line 138 of file bluetooth_type.h.

Enumerations of the Bluetooth advertising filter policy. 2.3.

Enumerator
BT_ADAPTER_LE_ADVERTISING_FILTER_DEFAULT 

White list is not in use

BT_ADAPTER_LE_ADVERTISING_FILTER_ALLOW_SCAN_WL 

Allow the scan request that in the White list

BT_ADAPTER_LE_ADVERTISING_FILTER_ALLOW_CONN_WL 

Allow the connection request that in the White list

BT_ADAPTER_LE_ADVERTISING_FILTER_ALLOW_SCAN_CONN_WL 

Allow the scan and connection request that in the White list

Definition at line 170 of file bluetooth_type.h.

Enumerations of the Bluetooth advertising mode. 2.3.1.

Enumerator
BT_ADAPTER_LE_ADVERTISING_MODE_BALANCED 

Balanced advertising mode

BT_ADAPTER_LE_ADVERTISING_MODE_LOW_LATENCY 

Low latency advertising mode

BT_ADAPTER_LE_ADVERTISING_MODE_LOW_ENERGY 

Low energy advertising mode

Definition at line 159 of file bluetooth_type.h.

Enumerations of the Bluetooth advertising state. 2.3.

Enumerator
BT_ADAPTER_LE_ADVERTISING_STOPPED 

Bluetooth advertising is stopped

BT_ADAPTER_LE_ADVERTISING_STARTED 

Bluetooth advertising is started

Definition at line 149 of file bluetooth_type.h.

Enumerations of the Bluetooth LE packet type. 2.3.

Enumerator
BT_ADAPTER_LE_PACKET_ADVERTISING 

Advertising packet

BT_ADAPTER_LE_PACKET_SCAN_RESPONSE 

Scan response packet

Definition at line 185 of file bluetooth_type.h.

Enumeration for the scan filter type. 4.0.

See also
bt_adapter_le_scan_filter_set_type()
Enumerator
BT_ADAPTER_LE_SCAN_FILTER_TYPE_IBEACON 

iBeacon filter type

BT_ADAPTER_LE_SCAN_FILTER_TYPE_PROXIMITY_UUID 

Proximity UUID filter type

Definition at line 2148 of file bluetooth_type.h.

Enumerations of the Bluetooth le scan mode. 3.0.

Enumerator
BT_ADAPTER_LE_SCAN_MODE_BALANCED 

Balanced mode of power consumption and connection latency

BT_ADAPTER_LE_SCAN_MODE_LOW_LATENCY 

Low connection latency but high power consumption

BT_ADAPTER_LE_SCAN_MODE_LOW_ENERGY 

Low power consumption but high connection latency

Definition at line 195 of file bluetooth_type.h.

Enumerations of the Bluetooth adapter state. 2.3.

Enumerator
BT_ADAPTER_DISABLED 

Bluetooth adapter is disabled

BT_ADAPTER_ENABLED 

Bluetooth adapter is enabled

Definition at line 116 of file bluetooth_type.h.

Enumerations of the Bluetooth visibility mode. 2.3.

Enumerator
BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE 

Other devices cannot find your device via discovery

BT_ADAPTER_VISIBILITY_MODE_GENERAL_DISCOVERABLE 

Discoverable mode

BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE 

Discoverable mode with time limit. After specific period, it is changed to BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE.

Definition at line 126 of file bluetooth_type.h.

Enumerations for the call handling event. 2.3.

Enumerator
BT_AG_CALL_HANDLING_EVENT_ANSWER 

Request to answer an incoming call

BT_AG_CALL_HANDLING_EVENT_RELEASE 

Request to release a call

BT_AG_CALL_HANDLING_EVENT_REJECT 

Request to reject an incoming call

Definition at line 488 of file bluetooth_type.h.

Enumerations for the multi call handling event. 2.3.

Enumerator
BT_AG_MULTI_CALL_HANDLING_EVENT_RELEASE_HELD_CALLS 

Request to release held calls

BT_AG_MULTI_CALL_HANDLING_EVENT_RELEASE_ACTIVE_CALLS 

Request to release active calls

BT_AG_MULTI_CALL_HANDLING_EVENT_ACTIVATE_HELD_CALL 

Request to put active calls into hold state and activate another (held or waiting) call

BT_AG_MULTI_CALL_HANDLING_EVENT_MERGE_CALLS 

Request to add a held call to the conversation

BT_AG_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

Definition at line 499 of file bluetooth_type.h.

Enumerations of gap appearance type. 2.3.

Enumerator
BT_APPEARANCE_TYPE_UNKNOWN 

Unknown appearance type

BT_APPEARANCE_TYPE_GENERIC_PHONE 

Generic Phone type - Generic category

BT_APPEARANCE_TYPE_GENERIC_COMPUTER 

Generic Computer type - Generic category

BT_APPEARANCE_TYPE_GENERIC_WATCH 

Generic Watch type - Generic category

Definition at line 431 of file bluetooth_type.h.

Enumerations for the types of profiles related with audio. 2.3.

Enumerator
BT_AUDIO_PROFILE_TYPE_ALL 

All supported profiles related with audio

BT_AUDIO_PROFILE_TYPE_HSP_HFP 

HSP(Headset Profile) and HFP(Hands-Free Profile)

BT_AUDIO_PROFILE_TYPE_A2DP 

A2DP(Advanced Audio Distribution Profile)

BT_AUDIO_PROFILE_TYPE_AG 

AG(Audio Gateway)

BT_AUDIO_PROFILE_TYPE_A2DP_SINK 

A2DP(Advanced Audio Distribution Profile) Sink role

Definition at line 475 of file bluetooth_type.h.

Enumerations for the equalizer state. 2.4.

Enumerator
BT_AVRCP_EQUALIZER_STATE_OFF 

Equalizer Off

BT_AVRCP_EQUALIZER_STATE_ON 

Equalizer On

Definition at line 512 of file bluetooth_type.h.

Enumeration for the player control commands. 3.0.

Enumerator
BT_AVRCP_CONTROL_PLAY 

Play

BT_AVRCP_CONTROL_PAUSE 

Pause

BT_AVRCP_CONTROL_STOP 

Stop

BT_AVRCP_CONTROL_NEXT 

Next Track

BT_AVRCP_CONTROL_PREVIOUS 

Previous track

BT_AVRCP_CONTROL_FAST_FORWARD 

Fast Forward

BT_AVRCP_CONTROL_REWIND 

Rewind

Definition at line 569 of file bluetooth_type.h.

Enumerations for the player state. 3.0.

Enumerator
BT_AVRCP_PLAYER_STATE_STOPPED 

Stopped

BT_AVRCP_PLAYER_STATE_PLAYING 

Playing

BT_AVRCP_PLAYER_STATE_PAUSED 

Paused

BT_AVRCP_PLAYER_STATE_FORWARD_SEEK 

Seek Forward

BT_AVRCP_PLAYER_STATE_REWIND_SEEK 

Seek Rewind

Definition at line 556 of file bluetooth_type.h.

Enumerations for the repeat mode. 2.4.

Enumerator
BT_AVRCP_REPEAT_MODE_OFF 

Repeat Off

BT_AVRCP_REPEAT_MODE_SINGLE_TRACK 

Single track repeat

BT_AVRCP_REPEAT_MODE_ALL_TRACK 

All track repeat

BT_AVRCP_REPEAT_MODE_GROUP 

Group repeat

Definition at line 522 of file bluetooth_type.h.

Enumerations for the scan mode. 2.4.

Enumerator
BT_AVRCP_SCAN_MODE_OFF 

Scan Off

BT_AVRCP_SCAN_MODE_ALL_TRACK 

All tracks scan

BT_AVRCP_SCAN_MODE_GROUP 

Group scan

Definition at line 545 of file bluetooth_type.h.

Enumerations for the shuffle mode. 2.4.

Enumerator
BT_AVRCP_SHUFFLE_MODE_OFF 

Shuffle Off

BT_AVRCP_SHUFFLE_MODE_ALL_TRACK 

All tracks shuffle

BT_AVRCP_SHUFFLE_MODE_GROUP 

Group shuffle

Definition at line 534 of file bluetooth_type.h.

Enumerations of the float type for GATT handle's value. 2.3.1.

Enumerator
BT_DATA_TYPE_FLOAT 

32 bit float type

BT_DATA_TYPE_SFLOAT 

16 bit float type

Definition at line 672 of file bluetooth_type.h.

Enumerations of the integer type for GATT handle's value. 2.3.1.

Enumerator
BT_DATA_TYPE_SINT8 

8 bit signed int type

BT_DATA_TYPE_SINT16 

16 bit signed int type

BT_DATA_TYPE_SINT32 

32 bit signed int type

BT_DATA_TYPE_UINT8 

8 bit unsigned int type

BT_DATA_TYPE_UINT16 

16 bit unsigned int type

BT_DATA_TYPE_UINT32 

32 bit unsigned int type

Definition at line 658 of file bluetooth_type.h.

Enumerations of device address type. 2.3.

Enumerator
BT_DEVICE_PUBLIC_ADDRESS 

Public address

BT_DEVICE_RANDOM_ADDRESS 

Random address

Definition at line 256 of file bluetooth_type.h.

Enumerations of device authorization state. 2.3.

Enumerator
BT_DEVICE_AUTHORIZED 

The remote Bluetooth device is authorized

BT_DEVICE_UNAUTHORIZED 

The remote Bluetooth device is unauthorized

Definition at line 229 of file bluetooth_type.h.

Enumerations of connection link type. 2.3.

Enumerator
BT_DEVICE_CONNECTION_LINK_BREDR 

BR/EDR link

BT_DEVICE_CONNECTION_LINK_LE 

LE link

BT_DEVICE_CONNECTION_LINK_DEFAULT 

The connection type default

Definition at line 218 of file bluetooth_type.h.

Enumerations of device disconnect reason. 2.3.

Enumerator
BT_DEVICE_DISCONNECT_REASON_UNKNOWN 

Disconnected by unknown reason

BT_DEVICE_DISCONNECT_REASON_TIMEOUT 

Disconnected by timeout

BT_DEVICE_DISCONNECT_REASON_LOCAL_HOST 

Disconnected by local host

BT_DEVICE_DISCONNECT_REASON_REMOTE 

Disconnected by remote

Definition at line 206 of file bluetooth_type.h.

Enumerations of the Bluetooth device's LE connection mode. 3.0.

Enumerator
BT_DEVICE_LE_CONNECTION_MODE_BALANCED 

Balanced mode of power consumption and connection latency

BT_DEVICE_LE_CONNECTION_MODE_LOW_LATENCY 

Low connection latency but high power consumption

BT_DEVICE_LE_CONNECTION_MODE_LOW_ENERGY 

Low power consumption but high connection latency

Definition at line 443 of file bluetooth_type.h.

Enumerations of the remote device request types for attributes. 3.0.

Enumerator
BT_GATT_REQUEST_TYPE_READ 

Read Requested

BT_GATT_REQUEST_TYPE_WRITE 

Write Requested

Definition at line 753 of file bluetooth_type.h.

Enumerations of gatt server's service changing mode. 3.0.

Enumerator
BT_GATT_CLIENT_SERVICE_ADDED 

Service added

BT_GATT_CLIENT_SERVICE_REMOVED 

Service removed

Definition at line 729 of file bluetooth_type.h.

Enumerations of the attribute's permission. 3.0.

Enumerator
BT_GATT_PERMISSION_READ 

Readable permission

BT_GATT_PERMISSION_WRITE 

Writable permission

BT_GATT_PERMISSION_ENCRYPT_READ 

Readable permission required encryption

BT_GATT_PERMISSION_ENCRYPT_WRITE 

Writable permission required encryption

BT_GATT_PERMISSION_ENCRYPT_AUTHENTICATED_READ 

Readable permission required encryption and authentication

BT_GATT_PERMISSION_ENCRYPT_AUTHENTICATED_WRITE 

Writable permission required encryption and authentication

Definition at line 739 of file bluetooth_type.h.

Enumerations of the characteristic's property. 2.3.1.

Enumerator
BT_GATT_PROPERTY_BROADCAST 

Broadcast property

BT_GATT_PROPERTY_READ 

Read property

BT_GATT_PROPERTY_WRITE_WITHOUT_RESPONSE 

Write without response property

BT_GATT_PROPERTY_WRITE 

Write property

BT_GATT_PROPERTY_NOTIFY 

Notify property

BT_GATT_PROPERTY_INDICATE 

Indicate property

BT_GATT_PROPERTY_AUTHENTICATED_SIGNED_WRITES 

Authenticated signed writes property

BT_GATT_PROPERTY_EXTENDED_PROPERTIES 

Extended properties

Definition at line 713 of file bluetooth_type.h.

Enumerations of the service type. 2.3.1.

Enumerator
BT_GATT_SERVICE_TYPE_PRIMARY 

GATT primary service type

BT_GATT_SERVICE_TYPE_SECONDARY 

GATT secondary service type

Definition at line 703 of file bluetooth_type.h.

Enumerations of the GATT handle's type. 2.3.1.

Enumerator
BT_GATT_TYPE_SERVICE 

GATT service type

BT_GATT_TYPE_CHARACTERISTIC 

GATT characteristic type

BT_GATT_TYPE_DESCRIPTOR 

GATT descriptor type

Definition at line 692 of file bluetooth_type.h.

Enumerations of the write type. 2.3.1.

Enumerator
BT_GATT_WRITE_TYPE_WRITE_NO_RESPONSE 

Write without response type

BT_GATT_WRITE_TYPE_WRITE 

Write type

Definition at line 682 of file bluetooth_type.h.

Enumerations for the data channel type. 2.3.

Deprecated:
Deprecated since 5.0.
Remarks
Deprecated, because of no usecase and supported devices.
Enumerator
BT_HDP_CHANNEL_TYPE_RELIABLE 

Reliable Data Channel

BT_HDP_CHANNEL_TYPE_STREAMING 

Streaming Data Channel

Definition at line 648 of file bluetooth_type.h.

Enumerations of the Bluetooth HID handshake type. .

Enumerator
BT_HID_HANDSHAKE_SUCCESSFUL 

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 

unknown error

BT_HID_HANDSHAKE_ERR_FATAL 

Fatal error

Definition at line 1988 of file bluetooth_type.h.

Enumerations of the Bluetooth HID header type. .

Enumerator
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

Definition at line 1962 of file bluetooth_type.h.

Enumerations of the Bluetooth HID mouse's button. .

Enumerator
BT_HID_MOUSE_BUTTON_NONE 

The mouse's none value

BT_HID_MOUSE_BUTTON_LEFT 

The mouse's left button value

BT_HID_MOUSE_BUTTON_RIGHT 

The mouse's right button value

BT_HID_MOUSE_BUTTON_MIDDLE 

The mouse's middle button value

Definition at line 1923 of file bluetooth_type.h.

Enumerations of the Bluetooth HID parameter type. .

Enumerator
BT_HID_PARAM_DATA_RTYPE_INPUT 

Parameter type: Input

BT_HID_PARAM_DATA_RTYPE_OUTPUT 

Parameter type: Output

Definition at line 1978 of file bluetooth_type.h.

Enumerations of major device class. 2.3.

Enumerator
BT_MAJOR_DEVICE_CLASS_MISC 

Miscellaneous major device class

BT_MAJOR_DEVICE_CLASS_COMPUTER 

Computer major device class

BT_MAJOR_DEVICE_CLASS_PHONE 

Phone major device class

BT_MAJOR_DEVICE_CLASS_LAN_NETWORK_ACCESS_POINT 

LAN/Network access point major device class

BT_MAJOR_DEVICE_CLASS_AUDIO_VIDEO 

Audio/Video major device class

BT_MAJOR_DEVICE_CLASS_PERIPHERAL 

Peripheral major device class

BT_MAJOR_DEVICE_CLASS_IMAGING 

Imaging major device class

BT_MAJOR_DEVICE_CLASS_WEARABLE 

Wearable device class

BT_MAJOR_DEVICE_CLASS_TOY 

Toy device class

BT_MAJOR_DEVICE_CLASS_HEALTH 

Health device class

BT_MAJOR_DEVICE_CLASS_UNCATEGORIZED 

Uncategorized major device class

Definition at line 317 of file bluetooth_type.h.

Enumerations of major service class. 2.3.

Enumerator
BT_MAJOR_SERVICE_CLASS_LIMITED_DISCOVERABLE_MODE 

Limited discoverable mode

BT_MAJOR_SERVICE_CLASS_POSITIONING 

Positioning class

BT_MAJOR_SERVICE_CLASS_NETWORKING 

Networking class

BT_MAJOR_SERVICE_CLASS_RENDERING 

Rendering class

BT_MAJOR_SERVICE_CLASS_CAPTURING 

Capturing class

BT_MAJOR_SERVICE_CLASS_OBJECT_TRANSFER 

Object transferring class

BT_MAJOR_SERVICE_CLASS_AUDIO 

Audio class

BT_MAJOR_SERVICE_CLASS_TELEPHONY 

Telephony class

BT_MAJOR_SERVICE_CLASS_INFORMATION 

Information class

Definition at line 300 of file bluetooth_type.h.

Enumerations of minor device class. 2.3.

Enumerator
BT_MINOR_DEVICE_CLASS_COMPUTER_UNCATEGORIZED 

Uncategorized minor device class of computer

BT_MINOR_DEVICE_CLASS_COMPUTER_DESKTOP_WORKSTATION 

Desktop workstation minor device class of computer

BT_MINOR_DEVICE_CLASS_COMPUTER_SERVER_CLASS 

Server minor device class of computer

BT_MINOR_DEVICE_CLASS_COMPUTER_LAPTOP 

Laptop minor device class of computer

BT_MINOR_DEVICE_CLASS_COMPUTER_HANDHELD_PC_OR_PDA 

Handheld PC/PDA minor device class of computer

BT_MINOR_DEVICE_CLASS_COMPUTER_PALM_SIZED_PC_OR_PDA 

Palm sized PC/PDA minor device class of computer

BT_MINOR_DEVICE_CLASS_COMPUTER_WEARABLE_COMPUTER 

Wearable(watch sized) minor device class of computer

BT_MINOR_DEVICE_CLASS_PHONE_UNCATEGORIZED 

Uncategorized minor device class of phone

BT_MINOR_DEVICE_CLASS_PHONE_CELLULAR 

Cellular minor device class of phone

BT_MINOR_DEVICE_CLASS_PHONE_CORDLESS 

Cordless minor device class of phone

BT_MINOR_DEVICE_CLASS_PHONE_SMART_PHONE 

Smart phone minor device class of phone

BT_MINOR_DEVICE_CLASS_PHONE_WIRED_MODEM_OR_VOICE_GATEWAY 

Wired modem or voice gateway minor device class of phone

BT_MINOR_DEVICE_CLASS_PHONE_COMMON_ISDN_ACCESS 

Common ISDN minor device class of phone

BT_MINOR_DEVICE_CLASS_LAN_NETWORK_ACCESS_POINT_FULLY_AVAILABLE 

Fully available minor device class of LAN/Network access point

BT_MINOR_DEVICE_CLASS_LAN_NETWORK_ACCESS_POINT_1_TO_17_PERCENT_UTILIZED 

1-17% utilized minor device class of LAN/Network access point

BT_MINOR_DEVICE_CLASS_LAN_NETWORK_ACCESS_POINT_17_TO_33_PERCENT_UTILIZED 

17-33% utilized minor device class of LAN/Network access point

BT_MINOR_DEVICE_CLASS_LAN_NETWORK_ACCESS_POINT_33_TO_50_PERCENT_UTILIZED 

33-50% utilized minor device class of LAN/Network access point

BT_MINOR_DEVICE_CLASS_LAN_NETWORK_ACCESS_POINT_50_to_67_PERCENT_UTILIZED 

50-67% utilized minor device class of LAN/Network access point

BT_MINOR_DEVICE_CLASS_LAN_NETWORK_ACCESS_POINT_67_TO_83_PERCENT_UTILIZED 

67-83% utilized minor device class of LAN/Network access point

BT_MINOR_DEVICE_CLASS_LAN_NETWORK_ACCESS_POINT_83_TO_99_PERCENT_UTILIZED 

83-99% utilized minor device class of LAN/Network access point

BT_MINOR_DEVICE_CLASS_LAN_NETWORK_ACCESS_POINT_NO_SERVICE_AVAILABLE 

No service available minor device class of LAN/Network access point

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_UNCATEGORIZED 

Uncategorized minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_WEARABLE_HEADSET 

Wearable headset minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_HANDS_FREE 

Hands-free minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_MICROPHONE 

Microphone minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_LOUDSPEAKER 

Loudspeaker minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_HEADPHONES 

Headphones minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_PORTABLE_AUDIO 

Portable audio minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_CAR_AUDIO 

Car audio minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_SET_TOP_BOX 

Set-top box minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_HIFI_AUDIO_DEVICE 

Hifi audio minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_VCR 

VCR minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_VIDEO_CAMERA 

Video camera minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_CAMCORDER 

Camcorder minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_VIDEO_MONITOR 

Video monitor minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_VIDEO_DISPLAY_LOUDSPEAKER 

Video display and loudspeaker minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_VIDEO_CONFERENCING 

Video conferencing minor device class of audio/video

BT_MINOR_DEVICE_CLASS_AUDIO_VIDEO_GAMING_TOY 

Gaming/toy minor device class of audio/video

BT_MINOR_DEVICE_CLASS_PERIPHERA_UNCATEGORIZED 

Uncategorized minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_KEY_BOARD 

Key board minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_POINTING_DEVICE 

Pointing device minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_COMBO_KEYBOARD_POINTING_DEVICE 

Combo keyboard or pointing device minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_JOYSTICK 

Joystick minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_GAME_PAD 

Game pad minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_REMOTE_CONTROL 

Remote control minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_SENSING_DEVICE 

Sensing device minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_DIGITIZER_TABLET 

Digitizer minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_CARD_READER 

Card reader minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_DIGITAL_PEN 

Digital pen minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_HANDHELD_SCANNER 

Handheld scanner minor device class of peripheral

BT_MINOR_DEVICE_CLASS_PERIPHERAL_HANDHELD_GESTURAL_INPUT_DEVICE 

Handheld gestural input device minor device class of peripheral

BT_MINOR_DEVICE_CLASS_IMAGING_DISPLAY 

Display minor device class of imaging

BT_MINOR_DEVICE_CLASS_IMAGING_CAMERA 

Camera minor device class of imaging

BT_MINOR_DEVICE_CLASS_IMAGING_SCANNER 

Scanner minor device class of imaging

BT_MINOR_DEVICE_CLASS_IMAGING_PRINTER 

Printer minor device class of imaging

BT_MINOR_DEVICE_CLASS_WEARABLE_WRIST_WATCH 

Wrist watch minor device class of wearable

BT_MINOR_DEVICE_CLASS_WEARABLE_PAGER 

Pager minor device class of wearable

BT_MINOR_DEVICE_CLASS_WEARABLE_JACKET 

Jacket minor device class of wearable

BT_MINOR_DEVICE_CLASS_WEARABLE_HELMET 

Helmet minor device class of wearable

BT_MINOR_DEVICE_CLASS_WEARABLE_GLASSES 

Glasses minor device class of wearable

BT_MINOR_DEVICE_CLASS_TOY_ROBOT 

Robot minor device class of toy

BT_MINOR_DEVICE_CLASS_TOY_VEHICLE 

Vehicle minor device class of toy

BT_MINOR_DEVICE_CLASS_TOY_DOLL_ACTION 

Doll/Action minor device class of toy

BT_MINOR_DEVICE_CLASS_TOY_CONTROLLER 

Controller minor device class of toy

BT_MINOR_DEVICE_CLASS_TOY_GAME 

Game minor device class of toy

BT_MINOR_DEVICE_CLASS_HEALTH_UNCATEGORIZED 

Uncategorized minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_BLOOD_PRESSURE_MONITOR 

Blood pressure monitor minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_THERMOMETER 

Thermometer minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_WEIGHING_SCALE 

Weighing scale minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_GLUCOSE_METER 

Glucose minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_PULSE_OXIMETER 

Pulse oximeter minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_HEART_PULSE_RATE_MONITOR 

Heart/Pulse rate monitor minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_DATA_DISPLAY 

Health data display minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_STEP_COUNTER 

Step counter minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_BODY_COMPOSITION_ANALYZER 

Body composition analyzer minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_PEAK_FLOW_MONITOR 

Peak flow monitor minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_MEDICATION_MONITOR 

Medication monitor minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_KNEE_PROSTHESIS 

Knee prosthesis minor device class of health

BT_MINOR_DEVICE_CLASS_HEALTH_ANKLE_PROSTHESIS 

Ankle prosthesis minor device class of health

Definition at line 336 of file bluetooth_type.h.

Enumerations for the types of PAN (Personal Area Networking) service. 2.3.

Enumerator
BT_PANU_SERVICE_TYPE_NAP 

Network Access Point

Definition at line 763 of file bluetooth_type.h.

Enumeration of address book location for PBAP. 3.0.

Enumerator
BT_PBAP_SOURCE_DEVICE 

Request for Addressbook from remote device

BT_PBAP_SOURCE_SIM 

Request for address book from SIM

Definition at line 780 of file bluetooth_type.h.

Enumeration of PBAP fields. 3.0.

Enumerator
BT_PBAP_FIELD_ALL 

All field

BT_PBAP_FIELD_VERSION 

vCard Version

BT_PBAP_FIELD_FN 

Formatted Name

BT_PBAP_FIELD_N 

Structured Presentation of Name

BT_PBAP_FIELD_PHOTO 

Associated Image or Photo

BT_PBAP_FIELD_BDAY 

Birthday

BT_PBAP_FIELD_ADR 

Delivery Address

BT_PBAP_FIELD_LABEL 

Delivery

BT_PBAP_FIELD_TEL 

Telephone Number

BT_PBAP_FIELD_EMAIL 

Electronic Mail Address

BT_PBAP_FIELD_MAILER 

Electronic Mail

BT_PBAP_FIELD_TZ 

Time Zone

BT_PBAP_FIELD_GEO 

Geographic Position

BT_PBAP_FIELD_TITLE 

Job

BT_PBAP_FIELD_ROLE 

Role within the Organization

BT_PBAP_FIELD_LOGO 

Organization Logo

BT_PBAP_FIELD_AGENT 

vCard of Person Representing

BT_PBAP_FIELD_ORG 

Name of Organization

BT_PBAP_FIELD_NOTE 

Comments

BT_PBAP_FIELD_REV 

Revision

BT_PBAP_FIELD_SOUND 

Pronunciation of Name

BT_PBAP_FIELD_URL 

Uniform Resource Locator

BT_PBAP_FIELD_UID 

Unique ID

BT_PBAP_FIELD_KEY 

Public Encryption Key

BT_PBAP_FIELD_NICKNAME 

Nickname

BT_PBAP_FIELD_CATEGORIES 

Categories

BT_PBAP_FIELD_PROID 

Product ID

BT_PBAP_FIELD_CLASS 

Class information

BT_PBAP_FIELD_SORT_STRING 

String used for sorting operations

BT_PBAP_FIELD_X_IRMC_CALL_DATETIME 

Time stamp

Definition at line 44 of file bluetooth_type.h.

Enumeration of folder type. 3.0.

Enumerator
BT_PBAP_FOLDER_PHONE_BOOK 

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

Definition at line 791 of file bluetooth_type.h.

Enumeration of phone book search fields. 3.0.

Enumerator
BT_PBAP_SEARCH_NAME 

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

Definition at line 805 of file bluetooth_type.h.

Enumeration of sorting orders. 3.0.

Enumerator
BT_PBAP_ORDER_INDEXED 

Filter order indexed (default)

BT_PBAP_ORDER_ALPHANUMERIC 

Filter order alphanumeric

BT_PBAP_ORDER_PHONETIC 

Filter order phonetic

Definition at line 828 of file bluetooth_type.h.

Enumeration of vCard Formats. 3.0.

Enumerator
BT_PBAP_VCARD_FORMAT_VCARD21 

vCard format 2.1 (default)

BT_PBAP_VCARD_FORMAT_VCARD30 

vCard format 3.0

Definition at line 817 of file bluetooth_type.h.

Enumerations of Bluetooth profile. 2.3.

Enumerator
BT_PROFILE_RFCOMM 

RFCOMM Profile

BT_PROFILE_A2DP 

Advanced Audio Distribution Profile Source role

BT_PROFILE_HSP 

Headset Profile

BT_PROFILE_HID 

Human Interface Device Profile

BT_PROFILE_NAP 

Network Access Point Profile

BT_PROFILE_AG 

Audio Gateway Profile

BT_PROFILE_GATT 

Generic Attribute Profile

BT_PROFILE_NAP_SERVER 

NAP server Profile

BT_PROFILE_A2DP_SINK 

Advanced Audio Distribution Profile Sink role

Definition at line 239 of file bluetooth_type.h.

Enumerations of service class. 2.3.

Enumerator
BT_SC_NONE 

No service class

BT_SC_RES_SERVICE_MASK 

RES service class

BT_SC_SPP_SERVICE_MASK 

SPP service class

BT_SC_DUN_SERVICE_MASK 

DUN service class

BT_SC_FAX_SERVICE_MASK 

FAX service class

BT_SC_LAP_SERVICE_MASK 

LAP service class

BT_SC_HSP_SERVICE_MASK 

HSP service class

BT_SC_HFP_SERVICE_MASK 

HFP service class

BT_SC_OPP_SERVICE_MASK 

OPP service class

BT_SC_FTP_SERVICE_MASK 

FTP service class

BT_SC_CTP_SERVICE_MASK 

CTP service class

BT_SC_ICP_SERVICE_MASK 

ICP service class

BT_SC_SYNC_SERVICE_MASK 

SYNC service class

BT_SC_BPP_SERVICE_MASK 

BPP service class

BT_SC_BIP_SERVICE_MASK 

BIP service class

BT_SC_PANU_SERVICE_MASK 

PANU service class

BT_SC_NAP_SERVICE_MASK 

NAP service class

BT_SC_GN_SERVICE_MASK 

GN service class

BT_SC_SAP_SERVICE_MASK 

SAP service class

BT_SC_A2DP_SERVICE_MASK 

A2DP service class

BT_SC_AVRCP_SERVICE_MASK 

AVRCP service class

BT_SC_PBAP_SERVICE_MASK 

PBAP service class

BT_SC_HID_SERVICE_MASK 

HID service class

BT_SC_A2DP_SOURCE_SERVICE_MASK 

A2DP SOURCE service class

BT_SC_ALL_SERVICE_MASK 

ALL service class

BT_SC_MAX 

MAX service class

Definition at line 266 of file bluetooth_type.h.

Enumerations of Bluetooth socket connection state. 2.3.

Enumerator
BT_SOCKET_CONNECTED 

RFCOMM is connected

BT_SOCKET_DISCONNECTED 

RFCOMM is disconnected

Definition at line 465 of file bluetooth_type.h.

Enumerations of connected Bluetooth device event role. 2.3.

Enumerator
BT_SOCKET_UNKNOWN 

Unknown role

BT_SOCKET_SERVER 

Server role

BT_SOCKET_CLIENT 

Client role

Definition at line 454 of file bluetooth_type.h.