RDK Documentation (Open Sourced RDK Components)
Bluetooth Manager Data Types and API(s)

Description

This file provides the data types and API(s) used by the bluetooth manager.

Data Structures

struct  _BTRMGR_MediaTrackInfo_t
 Represents the media track info. More...
 
struct  _BTRMGR_MediaPositionInfo_t
 Represents the media position info. More...
 
struct  _BTRMGR_LeUUID_t
 
struct  _BTRMGR_DeviceService_t
 Represents the supported service of the device. More...
 
struct  _BTRMGR_DeviceServiceList_t
 Represents device services list. More...
 
union  _BTRMGR_DeviceServiceList_t.__unnamed__
 
struct  _BTRMGR_DeviceAdServiceData_t
 
struct  _BTRMGR_DevicesProperty_t
 Represents the property of the device. More...
 
struct  _BTRMGR_ConnectedDevice_t
 Represents the details of device connected. More...
 
struct  _BTRMGR_PairedDevices_t
 Represents the paired devices information. More...
 
struct  _BTRMGR_DiscoveredDevices_t
 Represents the discovered device's details. More...
 
struct  _BTRMGR_ConnectedDevicesList_t
 Represents the connected devices list. More...
 
struct  _BTRMGR_PairedDevicesList_t
 Represents the list of paired devices. More...
 
struct  _BTRMGR_DiscoveredDevicesList_t
 Represents the list of scanned devices. More...
 
struct  _BTRMGR_ExternalDevice_t
 Represents the details of external devices connected. More...
 
struct  _BTRMGR_MediaElementInfo_t
 Represents Media Element details. More...
 
struct  _BTRMGR_MediaElementListInfo_t
 Represents Media Element List. More...
 
struct  _BTRMGR_MediaDeviceStatus_t
 Represents Media Element List. More...
 
struct  _BTRMGR_MediaInfo_t
 Represents the media info. More...
 
union  _BTRMGR_MediaInfo_t.__unnamed__
 
struct  _BTRMGR_DeviceOpInfo_t
 Represents the notification data. More...
 
union  _BTRMGR_DeviceOpInfo_t.__unnamed__
 
struct  _BTRMGR_EventMessage_t
 Represents the event message info. More...
 
union  _BTRMGR_EventMessage_t.__unnamed__
 
struct  _BTRMGR_EventResponse_t
 Represents the event response. More...
 
union  _BTRMGR_EventResponse_t.__unnamed__
 
struct  _BTRMGR_UUID_t
 
struct  _BTRMGR_DiscoveryFilterHandle_t
 
struct  _BTRMGR_LeCustomAdvertisement_t
 Structure for the custom advertisement payload. More...
 

Macros

#define BTRMGR_MAX_STR_LEN   256
 
#define BTRMGR_NAME_LEN_MAX   64
 
#define BTRMGR_STR_LEN   32
 
#define BTRMGR_DEVICE_COUNT_MAX   32
 
#define BTRMGR_ADAPTER_COUNT_MAX   16
 
#define BTRMGR_MAX_DEVICE_PROFILE   32
 
#define BTRMGR_LE_FLAG_LIST_SIZE   10
 
#define BTRMGR_MEDIA_ELEMENT_COUNT_MAX   64
 
#define BTRMGR_DEVICE_MAC_LEN   6
 
#define BTRMGR_MAX_DEV_OP_DATA_LEN   BTRMGR_MAX_STR_LEN * 3
 
#define BTRMGR_SERVICE_DATA_LEN_MAX   32
 
#define BTRMGR_UUID_STR_LEN_MAX   64
 
#define BTRMGR_DEVICE_INFORMATION_UUID   "0x180a"
 
#define BTRMGR_RDKDIAGNOSTICS_UUID   "0xFDB9"
 
#define BTRMGR_COLUMBO_UUID   "64d9f574-7756-4ebc-9ebe-ed5f7f2871ab"
 
#define BTRMGR_SYSTEM_ID_UUID   "0x2a23"
 
#define BTRMGR_MODEL_NUMBER_UUID   "0x2a24"
 
#define BTRMGR_SERIAL_NUMBER_UUID   "0x2a25"
 
#define BTRMGR_FIRMWARE_REVISION_UUID   "0x2a26"
 
#define BTRMGR_HARDWARE_REVISION_UUID   "0x2a27"
 
#define BTRMGR_SOFTWARE_REVISION_UUID   "0x2a28"
 
#define BTRMGR_MANUFACTURER_NAME_UUID   "0x2a29"
 
#define BTRMGR_DEVICE_STATUS_UUID   "1f113f2c-cc01-4f03-9c5c-4b273ed631bb"
 
#define BTRMGR_FWDOWNLOAD_STATUS_UUID   "915f96a6-3788-4271-a7ea-6820e98896b8"
 
#define BTRMGR_WEBPA_STATUS_UUID   "9d5d3aae-51e3-4767-a055-59febd71de9d"
 
#define BTRMGR_WIFIRADIO1_STATUS_UUID   "59a99d5a-3d2f-4265-af13-316c7c76b1f0"
 
#define BTRMGR_WIFIRADIO2_STATUS_UUID   "9d6cf473-4fa6-4868-bf2b-c310f38df0c8"
 
#define BTRMGR_RF_STATUS_UUID   "91b9497e-634c-408a-9f77-8375b1461b8b"
 
#define BTRMGR_COLUMBO_START   "7c3fea2e-c082-4e17-b78b-1e69ca3889b9"
 
#define BTRMGR_COLUMBO_STOP   "5a7e479b-9fac-4d73-b5b0-906669946720"
 
#define BTRMGR_COLUMBO_STATUS   "26f05ee1-cefa-460d-8985-98c0dc078d6c"
 
#define BTRMGR_COLUMBO_REPORT   "c1e62616-b4de-4f72-86ca-9d9469041b6d"
 
#define BTRMGR_DEVICE_MAC   "device_mac"
 
#define BTRMGR_WIFI_CONNECT_DUMMY_UUID   "4ffab12b-e545-1baf-1dc6-bd3fd749716a"
 
#define BTRMGR_WIFI_SSID_DUMMY_UUID   "22d68435-f7af-1156-b2e2-c7d17211b026"
 
#define BTRMGR_WIFI_PWD_DUMMY_UUID   "6bfebfe7-294d-2f4e-a4b3-b04f2a66f2f0"
 
#define BTRMGR_WIFI_SEC_MODE_DUMMY_UUID   "112f9c72-82c1-93a3-d4fc-3dba3441b2c8"
 
#define BTRMGR_LEONBRDG_SERVICE_UUID_SETUP   "8DF5AD72-9BBC-4167-BCD9-E8EB9E4D671B"
 
#define BTRMGR_LEONBRDG_UUID_QR_CODE   "12984C43-3B43-4952-A387-715DCF9795C6"
 
#define BTRMGR_LEONBRDG_UUID_PROVISION_STATUS   "79DEFBC1-EB45-448D-9F2A-1ECC3A47A242"
 
#define BTRMGR_LEONBRDG_UUID_PUBLIC_KEY   "CB9FEE4D-C6ED-48C1-AB46-C3F2DA38EEDD"
 
#define BTRMGR_LEONBRDG_UUID_WIFI_CONFIG   "B87A896B-4052-4CAB-A7E7-A71594D9C353"
 
#define BTRMGR_LEONBRDG_UUID_SSID_LIST   "AAF92F88-7F35-48F1-9C3E-1FE5C3978B7A"
 

Typedefs

typedef unsigned long long int BTRMgrDeviceHandle
 
typedef unsigned long long int BTRMgrMediaElementHandle
 
typedef enum _BTRMGR_Result_t BTRMGR_Result_t
 Represents the status of the operation.
 
typedef enum _BTRMGR_Events_t BTRMGR_Events_t
 Represents the event status.
 
typedef enum _BTRMGR_DeviceType_t BTRMGR_DeviceType_t
 Represents the bluetooth device types.
 
typedef enum _BTRMGR_StreamOut_Type_t BTRMGR_StreamOut_Type_t
 Represents the stream output types.
 
typedef enum _BTRMGR_DeviceOperationType_t BTRMGR_DeviceOperationType_t
 Represents the operation type for bluetooth device.
 
typedef enum _BTRMGR_DevicePower_t BTRMGR_DevicePower_t
 Represents the bluetooth power states.
 
typedef enum _BTRMGR_RSSIValue_type_t BTRMGR_RSSIValue_t
 Represents the bluetooth signal strength.
 
typedef enum _BTRMGR_DiscoveryStatus_t BTRMGR_DiscoveryStatus_t
 Represents the bluetooth Discovery Status.
 
typedef enum _BTRMGR_MediaControlCommand_t BTRMGR_MediaControlCommand_t
 Represents the commands to control the media files.
 
typedef enum _BTRMGR_LeProperty_t BTRMGR_LeProperty_t
 Represents LE properties.
 
typedef enum _BTRMGR_LeOp_t BTRMGR_LeOp_t
 Represents the Low energy operations.
 
typedef enum _BTRMGR_GattCharFlags_t BTRMGR_GattCharFlags_t
 Represents Gatt Characteristic Flags.
 
typedef enum _BTRMGR_ScanFilter_t BTRMGR_ScanFilter_t
 
typedef enum _BTRMGR_MediaElementType_t BTRMGR_MediaElementType_t
 Represents Media Element Types.
 
typedef struct _BTRMGR_MediaTrackInfo_t BTRMGR_MediaTrackInfo_t
 Represents the media track info.
 
typedef struct _BTRMGR_MediaPositionInfo_t BTRMGR_MediaPositionInfo_t
 Represents the media position info.
 
typedef struct _BTRMGR_LeUUID_t BTRMGR_LeUUID_t
 
typedef struct _BTRMGR_DeviceService_t BTRMGR_DeviceService_t
 Represents the supported service of the device.
 
typedef struct _BTRMGR_DeviceServiceList_t BTRMGR_DeviceServiceList_t
 Represents device services list.
 
typedef struct _BTRMGR_DeviceAdServiceData_t BTRMGR_DeviceAdServiceData_t
 
typedef struct _BTRMGR_DevicesProperty_t BTRMGR_DevicesProperty_t
 Represents the property of the device.
 
typedef struct _BTRMGR_ConnectedDevice_t BTRMGR_ConnectedDevice_t
 Represents the details of device connected.
 
typedef struct _BTRMGR_PairedDevices_t BTRMGR_PairedDevices_t
 Represents the paired devices information.
 
typedef struct _BTRMGR_DiscoveredDevices_t BTRMGR_DiscoveredDevices_t
 Represents the discovered device's details.
 
typedef struct _BTRMGR_ConnectedDevicesList_t BTRMGR_ConnectedDevicesList_t
 Represents the connected devices list.
 
typedef struct _BTRMGR_PairedDevicesList_t BTRMGR_PairedDevicesList_t
 Represents the list of paired devices.
 
typedef struct _BTRMGR_DiscoveredDevicesList_t BTRMGR_DiscoveredDevicesList_t
 Represents the list of scanned devices.
 
typedef struct _BTRMGR_ExternalDevice_t BTRMGR_ExternalDevice_t
 Represents the details of external devices connected.
 
typedef struct _BTRMGR_MediaElementInfo_t BTRMGR_MediaElementInfo_t
 Represents Media Element details.
 
typedef struct _BTRMGR_MediaElementListInfo_t BTRMGR_MediaElementListInfo_t
 Represents Media Element List.
 
typedef struct _BTRMGR_MediaDeviceStatus_t BTRMGR_MediaDeviceStatus_t
 Represents Media Element List.
 
typedef struct _BTRMGR_MediaInfo_t BTRMGR_MediaInfo_t
 Represents the media info.
 
typedef struct _BTRMGR_DeviceOpInfo_t BTRMGR_DeviceOpInfo_t
 Represents the notification data.
 
typedef struct _BTRMGR_EventMessage_t BTRMGR_EventMessage_t
 Represents the event message info.
 
typedef struct _BTRMGR_EventResponse_t BTRMGR_EventResponse_t
 Represents the event response.
 
typedef struct _BTRMGR_UUID_t BTRMGR_UUID_t
 
typedef struct _BTRMGR_DiscoveryFilterHandle_t BTRMGR_DiscoveryFilterHandle_t
 
typedef struct _BTRMGR_LeCustomAdvertisement_t BTRMGR_LeCustomAdvertisement_t
 Structure for the custom advertisement payload.
 
typedef BTRMGR_Result_t(* BTRMGR_EventCallback) (BTRMGR_EventMessage_t astEventMessage)
 

Enumerations

enum  _BTRMGR_Result_t
 Represents the status of the operation.
 
enum  _BTRMGR_Events_t
 Represents the event status.
 
enum  _BTRMGR_DeviceType_t
 Represents the bluetooth device types.
 
enum  _BTRMGR_StreamOut_Type_t
 Represents the stream output types.
 
enum  _BTRMGR_DeviceOperationType_t
 Represents the operation type for bluetooth device.
 
enum  _BTRMGR_DevicePower_t
 Represents the bluetooth power states.
 
enum  _BTRMGR_RSSIValue_type_t
 Represents the bluetooth signal strength. More...
 
enum  _BTRMGR_DiscoveryStatus_t
 Represents the bluetooth Discovery Status.
 
enum  _BTRMGR_MediaControlCommand_t
 Represents the commands to control the media files.
 
enum  _BTRMGR_LeProperty_t
 Represents LE properties.
 
enum  _BTRMGR_LeOp_t
 Represents the Low energy operations.
 
enum  _BTRMGR_GattCharFlags_t
 Represents Gatt Characteristic Flags.
 
enum  _BTRMGR_ScanFilter_t
 
enum  _BTRMGR_MediaElementType_t
 Represents Media Element Types.
 

Functions

BTRMGR_Result_t BTRMGR_Init (void)
 This API initializes the bluetooth manager. More...
 
BTRMGR_Result_t BTRMGR_DeInit (void)
 This API invokes the deinit function of bluetooth core and persistant interface module. More...
 
BTRMGR_Result_t BTRMGR_RegisterForCallbacks (const char *apcProcessName)
 This API registers all the IARM call backs for BTRMGR and Third party Clients. More...
 
BTRMGR_Result_t BTRMGR_UnRegisterFromCallbacks (const char *apcProcessName)
 This API Unregisters all the IARM call backs for BTRMGR and Third party Clients. More...
 
BTRMGR_Result_t BTRMGR_GetNumberOfAdapters (unsigned char *pNumOfAdapters)
 This API returns the number of bluetooth adapters available. More...
 
BTRMGR_Result_t BTRMGR_ResetAdapter (unsigned char aui8AdapterIdx)
 This API is designed to reset the bluetooth adapter. More...
 
BTRMGR_Result_t BTRMGR_SetAdapterName (unsigned char aui8AdapterIdx, const char *pNameOfAdapter)
 This API is used to set the new name to the bluetooth adapter. More...
 
BTRMGR_Result_t BTRMGR_GetAdapterName (unsigned char aui8AdapterIdx, char *pNameOfAdapter)
 This API fetches the bluetooth adapter name. More...
 
BTRMGR_Result_t BTRMGR_SetAdapterPowerStatus (unsigned char aui8AdapterIdx, unsigned char power_status)
 This API sets the bluetooth adapter power to ON/OFF. More...
 
BTRMGR_Result_t BTRMGR_GetAdapterPowerStatus (unsigned char aui8AdapterIdx, unsigned char *pPowerStatus)
 This API fetches the power status, either 0 or 1. More...
 
BTRMGR_Result_t BTRMGR_SetAdapterDiscoverable (unsigned char aui8AdapterIdx, unsigned char discoverable, int timeout)
 This API is to make the adapter discoverable until the given timeout. More...
 
BTRMGR_Result_t BTRMGR_IsAdapterDiscoverable (unsigned char aui8AdapterIdx, unsigned char *pDiscoverable)
 This API checks the adapter is discoverable or not. More...
 
BTRMGR_Result_t BTRMGR_StartDeviceDiscovery (unsigned char aui8AdapterIdx, BTRMGR_DeviceOperationType_t aenBTRMgrDevOpT)
 This API initiates the scanning process. More...
 
BTRMGR_Result_t BTRMGR_StopDeviceDiscovery (unsigned char aui8AdapterIdx, BTRMGR_DeviceOperationType_t aenBTRMgrDevOpT)
 This API terminates the scanning process. More...
 
BTRMGR_Result_t BTRMGR_GetDiscoveryStatus (unsigned char aui8AdapterIdx, BTRMGR_DiscoveryStatus_t *aeDiscoveryStatus, BTRMGR_DeviceOperationType_t *aenBTRMgrDevOpT)
 This API gives the discovery status. More...
 
BTRMGR_Result_t BTRMGR_GetDiscoveredDevices (unsigned char aui8AdapterIdx, BTRMGR_DiscoveredDevicesList_t *pDiscoveredDevices)
 This API fetches the list of devices scanned. More...
 
BTRMGR_Result_t BTRMGR_PairDevice (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl)
 This API is used to pair the device that you wish to pair. More...
 
BTRMGR_Result_t BTRMGR_UnpairDevice (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl)
 This API is used to remove the pairing information of the device selected. More...
 
BTRMGR_Result_t BTRMGR_GetPairedDevices (unsigned char aui8AdapterIdx, BTRMGR_PairedDevicesList_t *pPairedDevices)
 This API returns the list of devices paired. More...
 
BTRMGR_Result_t BTRMGR_ConnectToDevice (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMGR_DeviceOperationType_t connectAs)
 This API connects the device as audio sink/headset/audio src based on the device type specified. More...
 
BTRMGR_Result_t BTRMGR_DisconnectFromDevice (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl)
 This API terminates the current connection. More...
 
BTRMGR_Result_t BTRMGR_GetConnectedDevices (unsigned char aui8AdapterIdx, BTRMGR_ConnectedDevicesList_t *pConnectedDevices)
 This API returns the list of devices connected. More...
 
BTRMGR_Result_t BTRMGR_GetDeviceProperties (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMGR_DevicesProperty_t *pDeviceProperty)
 This API returns the device information that includes the device name, mac address, RSSI value etc. More...
 
BTRMGR_Result_t BTRMGR_StartAudioStreamingOut_StartUp (unsigned char aui8AdapterIdx, BTRMGR_DeviceOperationType_t aenBTRMgrDevConT)
 This API initates the streaming from the device with default operation type. More...
 
BTRMGR_Result_t BTRMGR_StartAudioStreamingOut (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMGR_DeviceOperationType_t connectAs)
 This API initates the streaming from the device with the selected operation type. More...
 
BTRMGR_Result_t BTRMGR_StopAudioStreamingOut (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl)
 This API terminates the streaming from the device. More...
 
BTRMGR_Result_t BTRMGR_IsAudioStreamingOut (unsigned char aui8AdapterIdx, unsigned char *pStreamingStatus)
 This API returns the stream out status. More...
 
BTRMGR_Result_t BTRMGR_SetAudioStreamingOutType (unsigned char aui8AdapterIdx, BTRMGR_StreamOut_Type_t type)
 This API is to set the audio type as primary or secondary. More...
 
BTRMGR_Result_t BTRMGR_StartAudioStreamingIn (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMGR_DeviceOperationType_t connectAs)
 This API starts the audio streaming. More...
 
BTRMGR_Result_t BTRMGR_StopAudioStreamingIn (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl)
 This API termines the audio streaming. More...
 
BTRMGR_Result_t BTRMGR_IsAudioStreamingIn (unsigned char aui8AdapterIdx, unsigned char *pStreamingStatus)
 This API returns the audio streaming status. More...
 
BTRMGR_Result_t BTRMGR_SetEventResponse (unsigned char aui8AdapterIdx, BTRMGR_EventResponse_t *apstBTRMgrEvtRsp)
 This API handles the events received. More...
 
BTRMGR_Result_t BTRMGR_MediaControl (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMGR_MediaControlCommand_t mediaCtrlCmd)
 This API is used to perform the media control operations. More...
 
BTRMGR_Result_t BTRMGR_GetDeviceVolumeMute (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMGR_DeviceOperationType_t deviceOpType, unsigned char *pui8Volume, unsigned char *pui8Mute)
 This API is used to fetch the media volume and mute data. More...
 
BTRMGR_Result_t BTRMGR_SetDeviceVolumeMute (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMGR_DeviceOperationType_t deviceOpType, unsigned char ui8Volume, unsigned char ui8Mute)
 This API is used to set the media volume and mute data. More...
 
BTRMGR_Result_t BTRMGR_GetMediaTrackInfo (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMGR_MediaTrackInfo_t *mediaTrackInfo)
 This API fetches the media track info like title, genre, duration, number of tracks, current track number. More...
 
BTRMGR_Result_t BTRMGR_GetMediaElementTrackInfo (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMgrMediaElementHandle ahBTRMgrMedElementHdl, BTRMGR_MediaTrackInfo_t *mediaTrackInfo)
 This API fetches the media track info like title, genre, duration, number of tracks, current track number. More...
 
BTRMGR_Result_t BTRMGR_GetMediaCurrentPosition (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMGR_MediaPositionInfo_t *mediaPositionInfo)
 This API fetches the current position and total duration of the media. More...
 
BTRMGR_Result_t BTRMGR_SetMediaElementActive (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMgrMediaElementHandle ahBTRMgrMedElementHdl, BTRMGR_MediaElementType_t aMediaElementType)
 This API sets the mentioned media element list active/in_scope for further operations on it. More...
 
BTRMGR_Result_t BTRMGR_GetMediaElementList (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMgrMediaElementHandle ahBTRMgrMedElementHdl, unsigned short aui16MediaElementStartIdx, unsigned short aui16MediaElementEndIdx, unsigned char abMediaElementListDepth, BTRMGR_MediaElementType_t aMediaElementType, BTRMGR_MediaElementListInfo_t *aMediaElementListInfo)
 This API gets the media element list. More...
 
BTRMGR_Result_t BTRMGR_SelectMediaElement (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, BTRMgrMediaElementHandle ahBTRMgrMedElementHdl, BTRMGR_MediaElementType_t aMediaElementType)
 This API performs operation based on the element type selected. More...
 
const char * BTRMGR_GetDeviceTypeAsString (BTRMGR_DeviceType_t type)
 This API fetches the Device name of the media. More...
 
BTRMGR_Result_t BTRMGR_SetAudioInServiceState (unsigned char aui8AdapterIdx, unsigned char aui8State)
 This API Enable/Disables Audio-In on the specified bluetooth adapter. More...
 
BTRMGR_Result_t BTRMGR_SetHidGamePadServiceState (unsigned char aui8AdapterIdx, unsigned char aui8State)
 This API Enable/Disables Hid GamePad on the specified bluetooth adapter. More...
 
BTRMGR_Result_t BTRMGR_GetLimitBeaconDetection (unsigned char aui8AdapterIdx, unsigned char *isLimited)
 This API Gets Beacon Detection status on the specified bluetooth adapter. More...
 
BTRMGR_Result_t BTRMGR_SetLimitBeaconDetection (unsigned char aui8AdapterIdx, unsigned char isLimited)
 This API Sets Beacon Detection status on the specified bluetooth adapter. More...
 
BTRMGR_Result_t BTRMGR_GetLeProperty (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, const char *apBtrPropUuid, BTRMGR_LeProperty_t aenLeProperty, void *vpPropValue)
 
BTRMGR_Result_t BTRMGR_GetLeCharacteristicUUID (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, const char *apBtrServiceUuid, char *apBtrCharUuidList)
 This API fetches the characteristic uuid of Le device. More...
 
BTRMGR_Result_t BTRMGR_PerformLeOp (unsigned char aui8AdapterIdx, BTRMgrDeviceHandle ahBTRMgrDevHdl, const char *aBtrLeUuid, BTRMGR_LeOp_t aLeOpType, char *aLeOpArg, char *rOpResult)
 This API performs LE operations on the specified bluetooth adapter. More...
 
BTRMGR_Result_t BTRMGR_LE_StartAdvertisement (unsigned char aui8AdapterIdx, BTRMGR_LeCustomAdvertisement_t *pstBTMGR_LeCustomAdvt)
 
BTRMGR_Result_t BTRMGR_LE_StopAdvertisement (unsigned char aui8AdapterIdx)
 
BTRMGR_Result_t BTRMGR_LE_GetPropertyValue (unsigned char aui8AdapterIdx, char *lUUID, char *aValue, BTRMGR_LeProperty_t aElement)
 
BTRMGR_Result_t BTRMGR_LE_SetServiceUUIDs (unsigned char aui8AdapterIdx, char *aUUID)
 
BTRMGR_Result_t BTRMGR_LE_SetServiceInfo (unsigned char aui8AdapterIdx, char *aUUID, unsigned char aServiceType)
 
BTRMGR_Result_t BTRMGR_LE_SetGattInfo (unsigned char aui8AdapterIdx, char *aParentUUID, char *aCharUUID, unsigned short aFlags, char *aValue, BTRMGR_LeProperty_t aElement)
 
BTRMGR_Result_t BTRMGR_LE_SetGattPropertyValue (unsigned char aui8AdapterIdx, char *aUUID, char *aValue, BTRMGR_LeProperty_t aElement)
 
BTRMGR_Result_t BTRMGR_SysDiagInfo (unsigned char aui8AdapterIdx, char *apDiagElement, char *apValue, BTRMGR_LeOp_t aOpType)
 
BTRMGR_Result_t BTRMGR_ConnectToWifi (unsigned char aui8AdapterIdx, char *apSSID, char *apPassword, int aSecMode)
 
BTRMGR_Result_t BTRMGR_RegisterEventCallback (BTRMGR_EventCallback afpcBBTRMgrEventOut)
 

Data Structure Documentation

◆ _BTRMGR_MediaTrackInfo_t

struct _BTRMGR_MediaTrackInfo_t

Represents the media track info.

Definition at line 346 of file btmgr.h.

Collaboration diagram for _BTRMGR_MediaTrackInfo_t:
Collaboration graph
Data Fields
char pcAlbum[256]
char pcGenre[256]
char pcTitle[256]
char pcArtist[256]
unsigned int ui32TrackNumber
unsigned int ui32Duration
unsigned int ui32NumberOfTracks

◆ _BTRMGR_MediaPositionInfo_t

struct _BTRMGR_MediaPositionInfo_t

Represents the media position info.

Definition at line 359 of file btmgr.h.

Collaboration diagram for _BTRMGR_MediaPositionInfo_t:
Collaboration graph
Data Fields
unsigned int m_mediaDuration
unsigned int m_mediaPosition

◆ _BTRMGR_LeUUID_t

struct _BTRMGR_LeUUID_t

Definition at line 364 of file btmgr.h.

Collaboration diagram for _BTRMGR_LeUUID_t:
Collaboration graph
Data Fields
unsigned short flags
char m_uuid[64]

◆ _BTRMGR_DeviceService_t

struct _BTRMGR_DeviceService_t

Represents the supported service of the device.

Definition at line 372 of file btmgr.h.

Collaboration diagram for _BTRMGR_DeviceService_t:
Collaboration graph
Data Fields
unsigned short m_uuid
char m_profile[64]

◆ _BTRMGR_DeviceServiceList_t

struct _BTRMGR_DeviceServiceList_t

Represents device services list.

Definition at line 380 of file btmgr.h.

Collaboration diagram for _BTRMGR_DeviceServiceList_t:
Collaboration graph
Data Fields
unsigned short m_numOfService
union _BTRMGR_DeviceServiceList_t __unnamed__

◆ _BTRMGR_DeviceServiceList_t.__unnamed__

union _BTRMGR_DeviceServiceList_t.__unnamed__

Definition at line 383 of file btmgr.h.

Collaboration diagram for _BTRMGR_DeviceServiceList_t.__unnamed__:
Collaboration graph
Data Fields
BTRMGR_DeviceService_t m_profileInfo[32]
BTRMGR_LeUUID_t m_uuidInfo[32]

◆ _BTRMGR_DeviceAdServiceData_t

struct _BTRMGR_DeviceAdServiceData_t

Definition at line 391 of file btmgr.h.

Collaboration diagram for _BTRMGR_DeviceAdServiceData_t:
Collaboration graph
Data Fields
char m_UUIDs[64]
unsigned char m_ServiceData[32]
unsigned int m_len

◆ _BTRMGR_DevicesProperty_t

struct _BTRMGR_DevicesProperty_t

Represents the property of the device.

Definition at line 400 of file btmgr.h.

Collaboration diagram for _BTRMGR_DevicesProperty_t:
Collaboration graph
Data Fields
BTRMgrDeviceHandle m_deviceHandle
BTRMGR_DeviceType_t m_deviceType
char m_name[64]
char m_deviceAddress[64]
BTRMGR_RSSIValue_t m_rssi
int m_signalLevel
unsigned short m_vendorID
unsigned char m_isPaired
unsigned char m_isConnected
unsigned char m_isLowEnergyDevice
BTRMGR_DeviceServiceList_t m_serviceInfo
BTRMGR_DeviceAdServiceData_t m_adServiceData[32]

◆ _BTRMGR_ConnectedDevice_t

struct _BTRMGR_ConnectedDevice_t

Represents the details of device connected.

Definition at line 418 of file btmgr.h.

Collaboration diagram for _BTRMGR_ConnectedDevice_t:
Collaboration graph
Data Fields
BTRMgrDeviceHandle m_deviceHandle
BTRMGR_DeviceType_t m_deviceType
char m_name[64]
char m_deviceAddress[64]
BTRMGR_DeviceServiceList_t m_serviceInfo
unsigned short m_vendorID
unsigned char m_isLowEnergyDevice
unsigned char m_isConnected
BTRMGR_DevicePower_t m_powerStatus

◆ _BTRMGR_PairedDevices_t

struct _BTRMGR_PairedDevices_t

Represents the paired devices information.

Definition at line 433 of file btmgr.h.

Collaboration diagram for _BTRMGR_PairedDevices_t:
Collaboration graph
Data Fields
BTRMgrDeviceHandle m_deviceHandle
BTRMGR_DeviceType_t m_deviceType
char m_name[64]
char m_deviceAddress[64]
BTRMGR_DeviceServiceList_t m_serviceInfo
unsigned short m_vendorID
unsigned char m_isLowEnergyDevice
unsigned char m_isConnected
unsigned char m_isLastConnectedDevice
unsigned int m_ui32DevClassBtSpec

◆ _BTRMGR_DiscoveredDevices_t

struct _BTRMGR_DiscoveredDevices_t

Represents the discovered device's details.

Definition at line 449 of file btmgr.h.

Collaboration diagram for _BTRMGR_DiscoveredDevices_t:
Collaboration graph
Data Fields
BTRMgrDeviceHandle m_deviceHandle
BTRMGR_DeviceType_t m_deviceType
char m_name[64]
char m_deviceAddress[64]
unsigned short m_vendorID
unsigned char m_isPairedDevice
unsigned char m_isConnected
unsigned char m_isLowEnergyDevice
BTRMGR_RSSIValue_t m_rssi
int m_signalLevel
unsigned char m_isDiscovered
unsigned char m_isLastConnectedDevice
unsigned int m_ui32DevClassBtSpec

◆ _BTRMGR_ConnectedDevicesList_t

struct _BTRMGR_ConnectedDevicesList_t

Represents the connected devices list.

Definition at line 468 of file btmgr.h.

Collaboration diagram for _BTRMGR_ConnectedDevicesList_t:
Collaboration graph
Data Fields
unsigned short m_numOfDevices
BTRMGR_ConnectedDevice_t m_deviceProperty[32]

◆ _BTRMGR_PairedDevicesList_t

struct _BTRMGR_PairedDevicesList_t

Represents the list of paired devices.

Definition at line 476 of file btmgr.h.

Collaboration diagram for _BTRMGR_PairedDevicesList_t:
Collaboration graph
Data Fields
unsigned short m_numOfDevices
BTRMGR_PairedDevices_t m_deviceProperty[32]

◆ _BTRMGR_DiscoveredDevicesList_t

struct _BTRMGR_DiscoveredDevicesList_t

Represents the list of scanned devices.

Definition at line 484 of file btmgr.h.

Collaboration diagram for _BTRMGR_DiscoveredDevicesList_t:
Collaboration graph
Data Fields
unsigned short m_numOfDevices
BTRMGR_DiscoveredDevices_t m_deviceProperty[32]

◆ _BTRMGR_ExternalDevice_t

struct _BTRMGR_ExternalDevice_t

Represents the details of external devices connected.

Definition at line 492 of file btmgr.h.

Collaboration diagram for _BTRMGR_ExternalDevice_t:
Collaboration graph
Data Fields
BTRMgrDeviceHandle m_deviceHandle
BTRMGR_DeviceType_t m_deviceType
char m_name[64]
char m_deviceAddress[64]
BTRMGR_DeviceServiceList_t m_serviceInfo
unsigned short m_vendorID
unsigned char m_isLowEnergyDevice
unsigned int m_externalDevicePIN
unsigned char m_requestConfirmation

◆ _BTRMGR_MediaElementInfo_t

struct _BTRMGR_MediaElementInfo_t

Represents Media Element details.

Definition at line 507 of file btmgr.h.

Collaboration diagram for _BTRMGR_MediaElementInfo_t:
Collaboration graph
Data Fields
BTRMgrMediaElementHandle m_mediaElementHdl
unsigned char m_IsPlayable
char m_mediaElementName[256]
BTRMGR_MediaTrackInfo_t m_mediaTrackInfo

◆ _BTRMGR_MediaElementListInfo_t

struct _BTRMGR_MediaElementListInfo_t

Represents Media Element List.

Definition at line 517 of file btmgr.h.

Collaboration diagram for _BTRMGR_MediaElementListInfo_t:
Collaboration graph
Data Fields
unsigned short m_numberOfElements
BTRMGR_MediaElementInfo_t m_mediaElementInfo[64]

◆ _BTRMGR_MediaDeviceStatus_t

struct _BTRMGR_MediaDeviceStatus_t

Represents Media Element List.

Definition at line 525 of file btmgr.h.

Collaboration diagram for _BTRMGR_MediaDeviceStatus_t:
Collaboration graph
Data Fields
unsigned char m_ui8mediaDevVolume
unsigned char m_ui8mediaDevMute
BTRMGR_MediaControlCommand_t m_enmediaCtrlCmd

◆ _BTRMGR_MediaInfo_t

struct _BTRMGR_MediaInfo_t

Represents the media info.

Definition at line 534 of file btmgr.h.

Collaboration diagram for _BTRMGR_MediaInfo_t:
Collaboration graph
Data Fields
BTRMgrDeviceHandle m_deviceHandle
BTRMGR_DeviceType_t m_deviceType
char m_name[64]
union _BTRMGR_MediaInfo_t __unnamed__

◆ _BTRMGR_MediaInfo_t.__unnamed__

union _BTRMGR_MediaInfo_t.__unnamed__

Definition at line 539 of file btmgr.h.

Collaboration diagram for _BTRMGR_MediaInfo_t.__unnamed__:
Collaboration graph
Data Fields
BTRMGR_MediaTrackInfo_t m_mediaTrackInfo
BTRMGR_MediaPositionInfo_t m_mediaPositionInfo
BTRMGR_MediaElementListInfo_t m_mediaAlbumListInfo
BTRMGR_MediaElementListInfo_t m_mediaArtistListInfo
BTRMGR_MediaElementListInfo_t m_mediaGenreListInfo
BTRMGR_MediaElementListInfo_t m_mediaCompilationInfo
BTRMGR_MediaElementListInfo_t m_mediaPlayListInfo
BTRMGR_MediaElementListInfo_t m_mediaTrackListInfo
char m_mediaPlayerName[256]
unsigned char m_mediaPlayerVolume
BTRMGR_MediaDeviceStatus_t m_mediaDevStatus

◆ _BTRMGR_DeviceOpInfo_t

struct _BTRMGR_DeviceOpInfo_t

Represents the notification data.

Definition at line 557 of file btmgr.h.

Collaboration diagram for _BTRMGR_DeviceOpInfo_t:
Collaboration graph
Data Fields
BTRMgrDeviceHandle m_deviceHandle
BTRMGR_DeviceType_t m_deviceType
BTRMGR_DeviceOperationType_t m_deviceOpType
char m_deviceAddress[64]
char m_name[64]
char m_uuid[256]
BTRMGR_LeOp_t m_leOpType
union _BTRMGR_DeviceOpInfo_t __unnamed__

◆ _BTRMGR_DeviceOpInfo_t.__unnamed__

union _BTRMGR_DeviceOpInfo_t.__unnamed__

Definition at line 566 of file btmgr.h.

Collaboration diagram for _BTRMGR_DeviceOpInfo_t.__unnamed__:
Collaboration graph
Data Fields
char m_readData[256 *3]
char m_writeData[256 *3]
char m_notifyData[256 *3]

◆ _BTRMGR_EventMessage_t

struct _BTRMGR_EventMessage_t

Represents the event message info.

Definition at line 576 of file btmgr.h.

Collaboration diagram for _BTRMGR_EventMessage_t:
Collaboration graph
Data Fields
unsigned char m_adapterIndex
BTRMGR_Events_t m_eventType
union _BTRMGR_EventMessage_t __unnamed__

◆ _BTRMGR_EventMessage_t.__unnamed__

union _BTRMGR_EventMessage_t.__unnamed__

Definition at line 579 of file btmgr.h.

Collaboration diagram for _BTRMGR_EventMessage_t.__unnamed__:
Collaboration graph
Data Fields
BTRMGR_DiscoveredDevices_t m_discoveredDevice
BTRMGR_ExternalDevice_t m_externalDevice
BTRMGR_PairedDevices_t m_pairedDevice
BTRMGR_MediaInfo_t m_mediaInfo
BTRMGR_DeviceOpInfo_t m_deviceOpInfo

◆ _BTRMGR_EventResponse_t

struct _BTRMGR_EventResponse_t

Represents the event response.

Definition at line 591 of file btmgr.h.

Collaboration diagram for _BTRMGR_EventResponse_t:
Collaboration graph
Data Fields
BTRMGR_Events_t m_eventType
BTRMgrDeviceHandle m_deviceHandle
char m_writeData[256 *3]
union _BTRMGR_EventResponse_t __unnamed__

◆ _BTRMGR_EventResponse_t.__unnamed__

union _BTRMGR_EventResponse_t.__unnamed__

Definition at line 595 of file btmgr.h.

Collaboration diagram for _BTRMGR_EventResponse_t.__unnamed__:
Collaboration graph
Data Fields
unsigned char m_eventResp

◆ _BTRMGR_UUID_t

struct _BTRMGR_UUID_t

Definition at line 600 of file btmgr.h.

Collaboration diagram for _BTRMGR_UUID_t:
Collaboration graph
Data Fields
char ** m_uuid
short m_uuidCount

◆ _BTRMGR_DiscoveryFilterHandle_t

struct _BTRMGR_DiscoveryFilterHandle_t

Definition at line 605 of file btmgr.h.

Collaboration diagram for _BTRMGR_DiscoveryFilterHandle_t:
Collaboration graph
Data Fields
BTRMGR_UUID_t m_btuuid
int m_rssi
int m_pathloss

◆ _BTRMGR_LeCustomAdvertisement_t

struct _BTRMGR_LeCustomAdvertisement_t

Structure for the custom advertisement payload.

Definition at line 616 of file btmgr.h.

Collaboration diagram for _BTRMGR_LeCustomAdvertisement_t:
Collaboration graph
Data Fields
unsigned char len_flags
unsigned char type_flags
unsigned char val_flags
unsigned char len_comcastflags
unsigned char type_comcastflags
unsigned char deviceInfo_UUID_LO
unsigned char deviceInfo_UUID_HI
unsigned char rdk_diag_UUID_LO
unsigned char rdk_diag_UUID_HI
unsigned char len_manuf
unsigned char type_manuf
unsigned char company_LO
unsigned char company_HI
unsigned short device_model
unsigned char device_mac[6]

Enumeration Type Documentation

◆ _BTRMGR_RSSIValue_type_t

Represents the bluetooth signal strength.

Enumerator
BTRMGR_RSSI_NONE 

No signal (0 bar)

BTRMGR_RSSI_POOR 

Poor (1 bar)

BTRMGR_RSSI_FAIR 

Fair (2 bars)

BTRMGR_RSSI_GOOD 

Good (3 bars)

BTRMGR_RSSI_EXCELLENT 

Excellent (4 bars)

Definition at line 225 of file btmgr.h.

Function Documentation

◆ BTRMGR_Init()

BTRMGR_Result_t BTRMGR_Init ( void  )

This API initializes the bluetooth manager.

This API performs the following operations:

  • Initializes the bluetooth core layer.
  • Initialize the Paired Device List for Default adapter.
  • Register for callback to get the status of connected Devices.
  • Register for callback to get the Discovered Devices.
  • Register for callback to process incoming pairing requests.
  • Register for callback to process incoming connection requests.
  • Register for callback to process incoming media events.
  • Activates the default agent.
  • Initializes the persistant interface and saves all bluetooth profiles to the database.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

Definition at line 2295 of file btrMgr.c.

◆ BTRMGR_DeInit()

BTRMGR_Result_t BTRMGR_DeInit ( void  )

This API invokes the deinit function of bluetooth core and persistant interface module.

Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

Definition at line 2455 of file btrMgr.c.

◆ BTRMGR_RegisterForCallbacks()

BTRMGR_Result_t BTRMGR_RegisterForCallbacks ( const char *  apcProcessName)

This API registers all the IARM call backs for BTRMGR and Third party Clients.

Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

Definition at line 100 of file btmgr_iarm_external_interface.c.

◆ BTRMGR_UnRegisterFromCallbacks()

BTRMGR_Result_t BTRMGR_UnRegisterFromCallbacks ( const char *  apcProcessName)

This API Unregisters all the IARM call backs for BTRMGR and Third party Clients.

Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

Definition at line 231 of file btmgr_iarm_external_interface.c.

◆ BTRMGR_GetNumberOfAdapters()

BTRMGR_Result_t BTRMGR_GetNumberOfAdapters ( unsigned char *  pNumOfAdapters)

This API returns the number of bluetooth adapters available.

Parameters
[out]pNumOfAdaptersIndicates the number of adapters available.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 2550 of file btrMgr.c.

◆ BTRMGR_ResetAdapter()

BTRMGR_Result_t BTRMGR_ResetAdapter ( unsigned char  aui8AdapterIdx)

This API is designed to reset the bluetooth adapter.

As of now, HAL implementation is not available for this API.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 2589 of file btrMgr.c.

◆ BTRMGR_SetAdapterName()

BTRMGR_Result_t BTRMGR_SetAdapterName ( unsigned char  aui8AdapterIdx,
const char *  pNameOfAdapter 
)

This API is used to set the new name to the bluetooth adapter.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]pNameOfAdapterThe name to set.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 2645 of file btrMgr.c.

◆ BTRMGR_GetAdapterName()

BTRMGR_Result_t BTRMGR_GetAdapterName ( unsigned char  aui8AdapterIdx,
char *  pNameOfAdapter 
)

This API fetches the bluetooth adapter name.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[out]pNameOfAdapterBluetooth adapter name.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 2685 of file btrMgr.c.

◆ BTRMGR_SetAdapterPowerStatus()

BTRMGR_Result_t BTRMGR_SetAdapterPowerStatus ( unsigned char  aui8AdapterIdx,
unsigned char  power_status 
)

This API sets the bluetooth adapter power to ON/OFF.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]power_statusValue to set the power. 0 to OFF & 1 to ON.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 2728 of file btrMgr.c.

◆ BTRMGR_GetAdapterPowerStatus()

BTRMGR_Result_t BTRMGR_GetAdapterPowerStatus ( unsigned char  aui8AdapterIdx,
unsigned char *  pPowerStatus 
)

This API fetches the power status, either 0 or 1.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[out]pPowerStatusIndicates the power status.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 2790 of file btrMgr.c.

◆ BTRMGR_SetAdapterDiscoverable()

BTRMGR_Result_t BTRMGR_SetAdapterDiscoverable ( unsigned char  aui8AdapterIdx,
unsigned char  discoverable,
int  timeout 
)

This API is to make the adapter discoverable until the given timeout.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]discoverableValue to turn on or off the discovery.
[in]timeoutTimeout to turn on discovery.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 2830 of file btrMgr.c.

◆ BTRMGR_IsAdapterDiscoverable()

BTRMGR_Result_t BTRMGR_IsAdapterDiscoverable ( unsigned char  aui8AdapterIdx,
unsigned char *  pDiscoverable 
)

This API checks the adapter is discoverable or not.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[out]pDiscoverableIndicates discoverable or not.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 2894 of file btrMgr.c.

◆ BTRMGR_StartDeviceDiscovery()

BTRMGR_Result_t BTRMGR_StartDeviceDiscovery ( unsigned char  aui8AdapterIdx,
BTRMGR_DeviceOperationType_t  aenBTRMgrDevOpT 
)

This API initiates the scanning process.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]aenBTRMgrDevOpTDevice operation type.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3141 of file btrMgr.c.

◆ BTRMGR_StopDeviceDiscovery()

BTRMGR_Result_t BTRMGR_StopDeviceDiscovery ( unsigned char  aui8AdapterIdx,
BTRMGR_DeviceOperationType_t  aenBTRMgrDevOpT 
)

This API terminates the scanning process.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]aenBTRMgrDevOpTDevice operation type.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3169 of file btrMgr.c.

◆ BTRMGR_GetDiscoveryStatus()

BTRMGR_Result_t BTRMGR_GetDiscoveryStatus ( unsigned char  aui8AdapterIdx,
BTRMGR_DiscoveryStatus_t aeDiscoveryStatus,
BTRMGR_DeviceOperationType_t aenBTRMgrDevOpT 
)

This API gives the discovery status.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[out]aeDiscoveryStatusDevice discovery status.
[out]aenBTRMgrDevOpTDevice operation type.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3195 of file btrMgr.c.

◆ BTRMGR_GetDiscoveredDevices()

BTRMGR_Result_t BTRMGR_GetDiscoveredDevices ( unsigned char  aui8AdapterIdx,
BTRMGR_DiscoveredDevicesList_t pDiscoveredDevices 
)

This API fetches the list of devices scanned.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[out]pDiscoveredDevicesStructure which holds the details of device scanned.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3226 of file btrMgr.c.

◆ BTRMGR_PairDevice()

BTRMGR_Result_t BTRMGR_PairDevice ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl 
)

This API is used to pair the device that you wish to pair.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlIndicates the device handle.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3313 of file btrMgr.c.

◆ BTRMGR_UnpairDevice()

BTRMGR_Result_t BTRMGR_UnpairDevice ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl 
)

This API is used to remove the pairing information of the device selected.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3440 of file btrMgr.c.

◆ BTRMGR_GetPairedDevices()

BTRMGR_Result_t BTRMGR_GetPairedDevices ( unsigned char  aui8AdapterIdx,
BTRMGR_PairedDevicesList_t pPairedDevices 
)

This API returns the list of devices paired.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]pPairedDevicesStructure which holds the paired devices information.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3556 of file btrMgr.c.

◆ BTRMGR_ConnectToDevice()

BTRMGR_Result_t BTRMGR_ConnectToDevice ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMGR_DeviceOperationType_t  connectAs 
)

This API connects the device as audio sink/headset/audio src based on the device type specified.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlIndicates device handle.
[in]connectAsDevice operation type.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3635 of file btrMgr.c.

◆ BTRMGR_DisconnectFromDevice()

BTRMGR_Result_t BTRMGR_DisconnectFromDevice ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl 
)

This API terminates the current connection.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlIndicates device handle.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3674 of file btrMgr.c.

◆ BTRMGR_GetConnectedDevices()

BTRMGR_Result_t BTRMGR_GetConnectedDevices ( unsigned char  aui8AdapterIdx,
BTRMGR_ConnectedDevicesList_t pConnectedDevices 
)

This API returns the list of devices connected.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[out]pConnectedDevicesList of connected devices.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3845 of file btrMgr.c.

◆ BTRMGR_GetDeviceProperties()

BTRMGR_Result_t BTRMGR_GetDeviceProperties ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMGR_DevicesProperty_t pDeviceProperty 
)

This API returns the device information that includes the device name, mac address, RSSI value etc.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlIndicates device handle.
[out]pDevicePropertyDevice property information.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 3961 of file btrMgr.c.

◆ BTRMGR_StartAudioStreamingOut_StartUp()

BTRMGR_Result_t BTRMGR_StartAudioStreamingOut_StartUp ( unsigned char  aui8AdapterIdx,
BTRMGR_DeviceOperationType_t  aenBTRMgrDevConT 
)

This API initates the streaming from the device with default operation type.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]aenBTRMgrDevConTDevice opeartion type.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4100 of file btrMgr.c.

◆ BTRMGR_StartAudioStreamingOut()

BTRMGR_Result_t BTRMGR_StartAudioStreamingOut ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMGR_DeviceOperationType_t  connectAs 
)

This API initates the streaming from the device with the selected operation type.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlIndicates device Handle.
[in]connectAsDevice operation type.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4179 of file btrMgr.c.

◆ BTRMGR_StopAudioStreamingOut()

BTRMGR_Result_t BTRMGR_StopAudioStreamingOut ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl 
)

This API terminates the streaming from the device.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlIndicates device Handle.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4205 of file btrMgr.c.

◆ BTRMGR_IsAudioStreamingOut()

BTRMGR_Result_t BTRMGR_IsAudioStreamingOut ( unsigned char  aui8AdapterIdx,
unsigned char *  pStreamingStatus 
)

This API returns the stream out status.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[out]pStreamingStatusStreaming status.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4252 of file btrMgr.c.

◆ BTRMGR_SetAudioStreamingOutType()

BTRMGR_Result_t BTRMGR_SetAudioStreamingOutType ( unsigned char  aui8AdapterIdx,
BTRMGR_StreamOut_Type_t  type 
)

This API is to set the audio type as primary or secondary.

Secondary audio support is not implemented yet. Always primary audio is played for now.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]typeStreaming type primary/secondary
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4287 of file btrMgr.c.

◆ BTRMGR_StartAudioStreamingIn()

BTRMGR_Result_t BTRMGR_StartAudioStreamingIn ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMGR_DeviceOperationType_t  connectAs 
)

This API starts the audio streaming.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]connectAsDevice opeartion type.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4339 of file btrMgr.c.

◆ BTRMGR_StopAudioStreamingIn()

BTRMGR_Result_t BTRMGR_StopAudioStreamingIn ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl 
)

This API termines the audio streaming.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4530 of file btrMgr.c.

◆ BTRMGR_IsAudioStreamingIn()

BTRMGR_Result_t BTRMGR_IsAudioStreamingIn ( unsigned char  aui8AdapterIdx,
unsigned char *  pStreamingStatus 
)

This API returns the audio streaming status.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[out]pStreamingStatusStreaming status.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4574 of file btrMgr.c.

◆ BTRMGR_SetEventResponse()

BTRMGR_Result_t BTRMGR_SetEventResponse ( unsigned char  aui8AdapterIdx,
BTRMGR_EventResponse_t apstBTRMgrEvtRsp 
)

This API handles the events received.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]apstBTRMgrEvtRspStructure which holds the event response.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4602 of file btrMgr.c.

◆ BTRMGR_MediaControl()

BTRMGR_Result_t BTRMGR_MediaControl ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMGR_MediaControlCommand_t  mediaCtrlCmd 
)

This API is used to perform the media control operations.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]mediaCtrlCmdIndicates the play, pause, resume etc.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4680 of file btrMgr.c.

◆ BTRMGR_GetDeviceVolumeMute()

BTRMGR_Result_t BTRMGR_GetDeviceVolumeMute ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMGR_DeviceOperationType_t  deviceOpType,
unsigned char *  pui8Volume,
unsigned char *  pui8Mute 
)

This API is used to fetch the media volume and mute data.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]deviceOpTypedevice operation type audio out or in etc.
[out]pui8VolumeMedia volume value.
[out]pui8MuteMedia mute set or not.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 4966 of file btrMgr.c.

◆ BTRMGR_SetDeviceVolumeMute()

BTRMGR_Result_t BTRMGR_SetDeviceVolumeMute ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMGR_DeviceOperationType_t  deviceOpType,
unsigned char  ui8Volume,
unsigned char  ui8Mute 
)

This API is used to set the media volume and mute data.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]deviceOpTypedevice operation type audio out or in etc.
[out]ui8VolumeMedia volume value.
[out]ui8MuteMedia mute set or not.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 5051 of file btrMgr.c.

◆ BTRMGR_GetMediaTrackInfo()

BTRMGR_Result_t BTRMGR_GetMediaTrackInfo ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMGR_MediaTrackInfo_t mediaTrackInfo 
)

This API fetches the media track info like title, genre, duration, number of tracks, current track number.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[out]mediaTrackInfoTrack info like title, genre, duration etc.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 5172 of file btrMgr.c.

◆ BTRMGR_GetMediaElementTrackInfo()

BTRMGR_Result_t BTRMGR_GetMediaElementTrackInfo ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMgrMediaElementHandle  ahBTRMgrMedElementHdl,
BTRMGR_MediaTrackInfo_t mediaTrackInfo 
)

This API fetches the media track info like title, genre, duration, number of tracks, current track number.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]ahBTRMgrMedElementHdlMedia Element handle .
[out]mediaTrackInfoTrack info like title, genre, duration etc.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 5210 of file btrMgr.c.

◆ BTRMGR_GetMediaCurrentPosition()

BTRMGR_Result_t BTRMGR_GetMediaCurrentPosition ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMGR_MediaPositionInfo_t mediaPositionInfo 
)

This API fetches the current position and total duration of the media.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[out]mediaPositionInfoMedia position info.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

Definition at line 5251 of file btrMgr.c.

◆ BTRMGR_SetMediaElementActive()

BTRMGR_Result_t BTRMGR_SetMediaElementActive ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMgrMediaElementHandle  ahBTRMgrMedElementHdl,
BTRMGR_MediaElementType_t  aMediaElementType 
)

This API sets the mentioned media element list active/in_scope for further operations on it.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]ahBTRMgrMedElementHdlMedia Element handle
[in]aui16MediaElementStartIdxStarting index of the list.
[in]aui16MediaElementEndIdxEnding index of the list
[in]aMediaElementTypeMedia Element Type.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

Definition at line 5290 of file btrMgr.c.

◆ BTRMGR_GetMediaElementList()

BTRMGR_Result_t BTRMGR_GetMediaElementList ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMgrMediaElementHandle  ahBTRMgrMedElementHdl,
unsigned short  aui16MediaElementStartIdx,
unsigned short  aui16MediaElementEndIdx,
unsigned char  abMediaElementListDepth,
BTRMGR_MediaElementType_t  aMediaElementType,
BTRMGR_MediaElementListInfo_t aMediaElementListInfo 
)

This API gets the media element list.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]ahBTRMgrMedElementHdlMedia Element handle
[in]aui16MediaElementStartIdxStarting index of the list.
[in]aui16MediaElementEndIdxEnding index of the list
[in]aMediaElementTypeMedia Element Type.
[out]aMediaElementListInfoMedia Element List.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

Definition at line 5362 of file btrMgr.c.

◆ BTRMGR_SelectMediaElement()

BTRMGR_Result_t BTRMGR_SelectMediaElement ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
BTRMgrMediaElementHandle  ahBTRMgrMedElementHdl,
BTRMGR_MediaElementType_t  aMediaElementType 
)

This API performs operation based on the element type selected.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]ahBTRMgrMedElementHdlMedia Element handle
[in]aMediaElementTypeMedia Element Type.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

Definition at line 5444 of file btrMgr.c.

◆ BTRMGR_GetDeviceTypeAsString()

const char* BTRMGR_GetDeviceTypeAsString ( BTRMGR_DeviceType_t  type)

This API fetches the Device name of the media.

Parameters
[in]typeDevice type.
Returns
Returns the device name.

Definition at line 5515 of file btrMgr.c.

◆ BTRMGR_SetAudioInServiceState()

BTRMGR_Result_t BTRMGR_SetAudioInServiceState ( unsigned char  aui8AdapterIdx,
unsigned char  aui8State 
)

This API Enable/Disables Audio-In on the specified bluetooth adapter.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]aui8State0/1- Enable or Disable AudioIn service.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success.

Definition at line 5562 of file btrMgr.c.

◆ BTRMGR_SetHidGamePadServiceState()

BTRMGR_Result_t BTRMGR_SetHidGamePadServiceState ( unsigned char  aui8AdapterIdx,
unsigned char  aui8State 
)

This API Enable/Disables Hid GamePad on the specified bluetooth adapter.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]aui8State0/1- Enable or Disable AudioIn service.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success.

Definition at line 5576 of file btrMgr.c.

◆ BTRMGR_GetLimitBeaconDetection()

BTRMGR_Result_t BTRMGR_GetLimitBeaconDetection ( unsigned char  aui8AdapterIdx,
unsigned char *  isLimited 
)

This API Gets Beacon Detection status on the specified bluetooth adapter.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[out]isLimitedCurrent Beacon Detection Status.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success.

Definition at line 5590 of file btrMgr.c.

◆ BTRMGR_SetLimitBeaconDetection()

BTRMGR_Result_t BTRMGR_SetLimitBeaconDetection ( unsigned char  aui8AdapterIdx,
unsigned char  isLimited 
)

This API Sets Beacon Detection status on the specified bluetooth adapter.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]isLimitedCurrent Beacon Detection Status.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success.

Definition at line 5619 of file btrMgr.c.

◆ BTRMGR_GetLeCharacteristicUUID()

BTRMGR_Result_t BTRMGR_GetLeCharacteristicUUID ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
const char *  apBtrServiceUuid,
char *  apBtrCharUuidList 
)

This API fetches the characteristic uuid of Le device.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]apBtrServiceUuidservice UUID.
[out]apBtrCharUuidListuuid list.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

◆ BTRMGR_PerformLeOp()

BTRMGR_Result_t BTRMGR_PerformLeOp ( unsigned char  aui8AdapterIdx,
BTRMgrDeviceHandle  ahBTRMgrDevHdl,
const char *  aBtrLeUuid,
BTRMGR_LeOp_t  aLeOpType,
char *  aLeOpArg,
char *  rOpResult 
)

This API performs LE operations on the specified bluetooth adapter.

Parameters
[in]aui8AdapterIdxIndex of bluetooth adapter.
[in]ahBTRMgrDevHdlDevice handle.
[in]aBtrLeUuidLE device uuid.
[in]aLeOpTypeLE device operation type.
[out]rOpResultLE device operation result.
Returns
Returns the status of the operation.
Return values
BTRMGR_RESULT_SUCCESSon success, appropriate error code otherwise.

Definition at line 5801 of file btrMgr.c.