btmgr_iarm_interface.h

Go to the documentation of this file.

/*
 * If not stated otherwise in this file or this component's Licenses.txt file the
 * following copyright and licenses apply:
 *
 * Copyright 2016 RDK Management
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/
#include "libIBus.h"
#include "libIARM.h"
 
#ifndef __BT_MGR_IARM_INTERFACE_H__
#define __BT_MGR_IARM_INTERFACE_H__
 
/**
 * @file  btmgr_iarm_interface.h
 *
 * @defgroup  IARM_Interface IARM Interface
 * This file defines bluetooth manager's iarm interfaces to external BT devices.
 * @ingroup  BTR_MGR
 */
 
/**
 * @addtogroup  IARM_Interface
 * @{
 *
 */
#define IARM_BUS_BTRMGR_NAME                                         "BTRMgrBus"
#define BTRMGR_IARM_METHOD_CALL_TIMEOUT_DEFAULT_MS                   15000
 
 
#define BTRMGR_IARM_METHOD_GET_NUMBER_OF_ADAPTERS                    "GetNumberOfAdapters"
#define BTRMGR_IARM_METHOD_SET_ADAPTER_NAME                          "SetAdapterName"
#define BTRMGR_IARM_METHOD_GET_ADAPTER_NAME                          "GetAdapterName"
#define BTRMGR_IARM_METHOD_SET_ADAPTER_POWERSTATUS                   "SetAdapterPowerStatus"
#define BTRMGR_IARM_METHOD_GET_ADAPTER_POWERSTATUS                   "GetAdapterPowerStatus"
#define BTRMGR_IARM_METHOD_SET_ADAPTER_DISCOVERABLE                  "SetAdapterDiscoverable"
#define BTRMGR_IARM_METHOD_IS_ADAPTER_DISCOVERABLE                   "IsAdapterDiscoverable"
#define BTRMGR_IARM_METHOD_CHANGE_DEVICE_DISCOVERY_STATUS            "SetDeviceDiscoveryStatus"
#define BTRMGR_IARM_METHOD_GET_DISCOVERY_STATUS                      "GetDeviceDiscoveryStatus"
#define BTRMGR_IARM_METHOD_GET_DISCOVERED_DEVICES                    "GetDiscoveredDevices"
#define BTRMGR_IARM_METHOD_PAIR_DEVICE                               "PairDevice"
#define BTRMGR_IARM_METHOD_UNPAIR_DEVICE                             "UnpairDevice"
#define BTRMGR_IARM_METHOD_GET_PAIRED_DEVICES                        "GetPairedDevices"
#define BTRMGR_IARM_METHOD_CONNECT_TO_DEVICE                         "ConnectToDevice"
#define BTRMGR_IARM_METHOD_DISCONNECT_FROM_DEVICE                    "DisconnectFromDevice"
#define BTRMGR_IARM_METHOD_GET_CONNECTED_DEVICES                     "GetConnectedDevices"
#define BTRMGR_IARM_METHOD_GET_DEVICE_PROPERTIES                     "GetDeviceProperties"
#define BTRMGR_IARM_METHOD_START_AUDIO_STREAMING_OUT                 "StartAudioStreamingOut"
#define BTRMGR_IARM_METHOD_STOP_AUDIO_STREAMING_OUT                  "StopAudioStreamingOut"
#define BTRMGR_IARM_METHOD_IS_AUDIO_STREAMING_OUT                    "IsAudioStreamingOut"
#define BTRMGR_IARM_METHOD_SET_AUDIO_STREAM_OUT_TYPE                 "SetAudioStreamOutType"
#define BTRMGR_IARM_METHOD_START_AUDIO_STREAMING_IN                  "StartAudioStreamingIn"
#define BTRMGR_IARM_METHOD_STOP_AUDIO_STREAMING_IN                   "StopAudioStreamingIn"
#define BTRMGR_IARM_METHOD_IS_AUDIO_STREAMING_IN                     "IsAudioStreamingIn"
#define BTRMGR_IARM_METHOD_SET_EVENT_RESPONSE                        "SetEventResponse"
#define BTRMGR_IARM_METHOD_MEDIA_CONTROL                             "MediaControl"
#define BTRMGR_IARM_METHOD_SET_DEVICE_VOLUME_MUTE_INFO               "SetDeviceVolumeMuteInfo"
#define BTRMGR_IARM_METHOD_GET_DEVICE_VOLUME_MUTE_INFO               "GetDeviceVolumeMuteInfo"
#define BTRMGR_IARM_METHOD_GET_MEDIA_TRACK_INFO                      "GetMediaTrackInfo"
#define BTRMGR_IARM_METHOD_GET_MEDIA_ELEMENT_TRACK_INFO              "GetMediaElementTrackInfo"
#define BTRMGR_IARM_METHOD_GET_MEDIA_CURRENT_POSITION                "GetMediaCurrentPosition"
#define BTRMGR_IARM_METHOD_SET_MEDIA_ELEMENT_ACTIVE                  "SetMediaElementActive"
#define BTRMGR_IARM_METHOD_GET_MEDIA_ELEMENT_LIST                    "GetMediaElementList"
#define BTRMGR_IARM_METHOD_SELECT_MEDIA_ELEMENT                      "SelectMediaElement"
#define BTRMGR_IARM_METHOD_GET_LE_PROPERTY                           "GetLeProperty"
#define BTRMGR_IARM_METHOD_PERFORM_LE_OP                             "PerformLeOperation"
#define BTRMGR_IARM_METHOD_SET_AUDIO_IN_SERVICE_STATE                "SetAudioInServiceState"
#define BTRMGR_IARM_METHOD_SET_HID_GAMEPAD_SERVICE_STATE             "SetGamePadServiceState"
#define BTRMGR_IARM_METHOD_RESET_ADAPTER                             "ResetAdapter"
#define BTRMGR_IARM_METHOD_DEINIT                                    "DeInit"
#define BTRMGR_IARM_METHOD_SET_LIMIT_BEACON_DETECTION                "SetLimitBeaconDetection"
#define BTRMGR_IARM_METHOD_GET_LIMIT_BEACON_DETECTION                "GetLimitBeaconDetection"
#define BTRMGR_IARM_METHOD_LE_START_ADVERTISEMENT                    "StartAdvertisement"
#define BTRMGR_IARM_METHOD_LE_STOP_ADVERTISEMENT                     "StopAdvertisement"
#define BTRMGR_IARM_METHOD_LE_GET_PROP_VALUE                         "GetPropertyValue"
#define BTRMGR_IARM_METHOD_LE_SET_GATT_SERVICE_INFO                  "SetGattServiceInfo"
#define BTRMGR_IARM_METHOD_LE_SET_GATT_CHAR_INFO                     "SetGattCharInfo"
#define BTRMGR_IARM_METHOD_LE_SET_GATT_PROPERTY_VALUE                "SetGattPropertyValue"
#define BTRMGR_IARM_METHOD_GET_SYS_DIAG_INFO                         "SysDiagInfo"
#define BTRMGR_IARM_METHOD_WIFI_CONNECT_INFO                         "ConnectToWifi"
 
/**
 * @brief Represents the events supported by bluetooth manager.
 */
typedef enum _BTRMGR_IARMEvents_t {
    BTRMGR_IARM_EVENT_DEVICE_OUT_OF_RANGE,
    BTRMGR_IARM_EVENT_DEVICE_DISCOVERY_UPDATE,
    BTRMGR_IARM_EVENT_DEVICE_DISCOVERY_COMPLETE,
    BTRMGR_IARM_EVENT_DEVICE_PAIRING_COMPLETE,
    BTRMGR_IARM_EVENT_DEVICE_UNPAIRING_COMPLETE,
    BTRMGR_IARM_EVENT_DEVICE_CONNECTION_COMPLETE,
    BTRMGR_IARM_EVENT_DEVICE_DISCONNECT_COMPLETE,
    BTRMGR_IARM_EVENT_DEVICE_PAIRING_FAILED,
    BTRMGR_IARM_EVENT_DEVICE_UNPAIRING_FAILED,
    BTRMGR_IARM_EVENT_DEVICE_CONNECTION_FAILED,
    BTRMGR_IARM_EVENT_DEVICE_DISCONNECT_FAILED,
    BTRMGR_IARM_EVENT_RECEIVED_EXTERNAL_PAIR_REQUEST,
    BTRMGR_IARM_EVENT_RECEIVED_EXTERNAL_CONNECT_REQUEST,
    BTRMGR_IARM_EVENT_RECEIVED_EXTERNAL_PLAYBACK_REQUEST,
    BTRMGR_IARM_EVENT_DEVICE_FOUND,
    BTRMGR_IARM_EVENT_MEDIA_TRACK_STARTED,
    BTRMGR_IARM_EVENT_MEDIA_TRACK_PLAYING,
    BTRMGR_IARM_EVENT_MEDIA_TRACK_PAUSED,
    BTRMGR_IARM_EVENT_MEDIA_TRACK_STOPPED,
    BTRMGR_IARM_EVENT_MEDIA_TRACK_POSITION,
    BTRMGR_IARM_EVENT_MEDIA_TRACK_CHANGED,
    BTRMGR_IARM_EVENT_MEDIA_PLAYBACK_ENDED,
    BTRMGR_IARM_EVENT_DEVICE_DISCOVERY_STARTED,
    BTRMGR_IARM_EVENT_DEVICE_OP_READY,
    BTRMGR_IARM_EVENT_DEVICE_OP_INFORMATION,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_NAME,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_VOLUME,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_EQUALIZER_OFF,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_EQUALIZER_ON,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_SHUFFLE_OFF,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_SHUFFLE_ALLTRACKS,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_SHUFFLE_GROUP,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_REPEAT_OFF,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_REPEAT_SINGLETRACK,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_REPEAT_ALLTRACKS,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_REPEAT_GROUP,
    BTRMGR_IARM_EVENT_MEDIA_ALBUM_INFO,
    BTRMGR_IARM_EVENT_MEDIA_ARTIST_INFO,
    BTRMGR_IARM_EVENT_MEDIA_GENRE_INFO,
    BTRMGR_IARM_EVENT_MEDIA_COMPILATION_INFO,
    BTRMGR_IARM_EVENT_MEDIA_PLAYLIST_INFO,
    BTRMGR_IARM_EVENT_MEDIA_TRACKLIST_INFO,
    BTRMGR_IARM_EVENT_MEDIA_TRACK_INFO,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_MUTE,
    BTRMGR_IARM_EVENT_MEDIA_PLAYER_UNMUTE,
    BTRMGR_IARM_EVENT_DEVICE_MEDIA_STATUS,
    BTRMGR_IARM_EVENT_MAX
} BTRMGR_IARM_Events_t;
 
typedef struct _BTRMGR_IARMBeaconDetection_t {
    unsigned char m_adapterIndex;
    unsigned char m_limitBeaconDetection;
} BTRMGR_IARMBeaconDetection_t;
 
typedef struct _BTRMGR_IARMAdapterName_t {
    unsigned char m_adapterIndex;
    char m_name[BTRMGR_NAME_LEN_MAX];
} BTRMGR_IARMAdapterName_t;
 
typedef struct _BTRMGR_IARMPairDevice_t {
    unsigned char m_adapterIndex;
    BTRMgrDeviceHandle m_deviceHandle;
} BTRMGR_IARMPairDevice_t;
 
typedef struct _BTRMGR_IARMConnectDevice_t {
    unsigned char m_adapterIndex;
    BTRMgrDeviceHandle m_deviceHandle;
    BTRMGR_DeviceOperationType_t m_connectAs;
} BTRMGR_IARMConnectDevice_t;
 
typedef struct _BTRMGR_IARMAdapterPower_t {
    unsigned char m_adapterIndex;
    unsigned char m_powerStatus;
} BTRMGR_IARMAdapterPower_t;
 
typedef struct _BTRMGR_IARMAdapterDiscoverable_t {
    unsigned char m_adapterIndex;
    unsigned char m_isDiscoverable;
    int m_timeout;
} BTRMGR_IARMAdapterDiscoverable_t;
 
typedef struct _BTRMGR_IARMAdapterDiscover_t {
    unsigned char m_adapterIndex;
    unsigned char m_setDiscovery;
    BTRMGR_DeviceOperationType_t m_enBTRMgrDevOpT;
} BTRMGR_IARMAdapterDiscover_t;
 
typedef struct _BTRMGR_IARMDDeviceProperty_t {
    unsigned char m_adapterIndex;
    BTRMgrDeviceHandle m_deviceHandle;
    BTRMGR_DevicesProperty_t m_deviceProperty;
} BTRMGR_IARMDDeviceProperty_t;
 
typedef struct _BTRMGR_IARMDiscoveredDevices_t{
    unsigned char m_adapterIndex;
    BTRMGR_DiscoveredDevicesList_t m_devices;
} BTRMGR_IARMDiscoveredDevices_t;
 
typedef struct _BTRMGR_IARMPairedDevices_t{
    unsigned char m_adapterIndex;
    BTRMGR_PairedDevicesList_t m_devices;
} BTRMGR_IARMPairedDevices_t;
 
typedef struct _BTRMGR_IARMConnectedDevices_t{
    unsigned char m_adapterIndex;
    BTRMGR_ConnectedDevicesList_t m_devices;
} BTRMGR_IARMConnectedDevices_t;
 
typedef struct _BTRMGR_IARMStreaming_t {
    unsigned char m_adapterIndex;
    BTRMgrDeviceHandle m_deviceHandle;
    BTRMGR_DeviceOperationType_t m_audioPref;
} BTRMGR_IARMStreaming_t;
 
typedef struct _BTRMGR_IARMStreamingStatus_t {
    unsigned char m_adapterIndex;
    unsigned char m_streamingStatus;
} BTRMGR_IARMStreamingStatus_t;
 
typedef struct _BTRMGR_IARMStreamingType_t {
    unsigned char m_adapterIndex;
    BTRMGR_StreamOut_Type_t m_audioOutType;
} BTRMGR_IARMStreamingType_t;
 
typedef struct _BTRMGR_IARMEventResp_t {
    unsigned char   m_adapterIndex;
    BTRMGR_EventResponse_t m_stBTRMgrEvtRsp;
} BTRMGR_IARMEventResp_t;
 
typedef struct _BTRMGR_IARMDeviceVolumeMute_t {
    unsigned char m_adapterIndex;
    BTRMgrDeviceHandle m_deviceHandle;
    BTRMGR_DeviceOperationType_t m_deviceOpType;
    unsigned char m_volume;
    unsigned char m_mute;
} BTRMGR_IARMDeviceVolumeMute_t;
 
typedef struct _BTRMGR_IARMMediaProperty_t {
    unsigned char           m_adapterIndex;
    BTRMgrDeviceHandle      m_deviceHandle;
    BTRMgrMediaElementHandle      m_mediaElementHandle;
 
    union {
       BTRMGR_MediaControlCommand_t  m_mediaControlCmd;
       BTRMGR_MediaTrackInfo_t       m_mediaTrackInfo;
       BTRMGR_MediaPositionInfo_t    m_mediaPositionInfo; /* To have a media property list */
    };
} BTRMGR_IARMMediaProperty_t;
 
typedef struct _BTRMGR_IARMMediaElementListInfo_t {
    unsigned char                 m_adapterIndex;
    BTRMgrDeviceHandle            m_deviceHandle;
    BTRMgrMediaElementHandle      m_mediaElementHandle;
    unsigned short                m_mediaElementStartIdx;
    unsigned short                m_mediaElementEndIdx;
    unsigned char                 m_mediaElementListDepth;
    BTRMGR_MediaElementType_t     m_mediaElementType;
 
    union {
        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;
    };
} BTRMGR_IARMMediaElementListInfo_t;
 
typedef struct _BTRMGR_IARMLeProperty_t {
    unsigned char           m_adapterIndex;
    char                    m_propUuid[BTRMGR_MAX_STR_LEN];
    BTRMgrDeviceHandle      m_deviceHandle;
    BTRMGR_LeProperty_t     m_enLeProperty;
 
    union {
        BTRMGR_DeviceServiceList_t  m_uuidList;
        char                        m_devicePath[BTRMGR_MAX_STR_LEN];
        char                        m_servicePath[BTRMGR_MAX_STR_LEN];
        char                        m_characteristicPath[BTRMGR_MAX_STR_LEN];
        char                        m_value[BTRMGR_MAX_STR_LEN];
        char                        m_flags[BTRMGR_LE_FLAG_LIST_SIZE][BTRMGR_NAME_LEN_MAX];
        unsigned char               m_primary;
        unsigned char               m_notifying;
    };
} BTRMGR_IARMLeProperty_t;
 
 
typedef struct _BTRMGR_IARMLeOp_t {
    unsigned char           m_adapterIndex;
    BTRMgrDeviceHandle      m_deviceHandle;
    char                    m_uuid[BTRMGR_MAX_STR_LEN];
    BTRMGR_LeOp_t           m_leOpType;
    char                    m_opArg[BTRMGR_MAX_STR_LEN];
    char                    m_opRes[BTRMGR_MAX_STR_LEN];
} BTRMGR_IARMLeOp_t;    
 
typedef struct _BTRMGR_IARMDiscoveryStatus_t {
    unsigned char                m_adapterIndex;
    BTRMGR_DiscoveryStatus_t     m_discoveryInProgress;
    BTRMGR_DeviceOperationType_t m_discoveryType;
} BTRMGR_IARMDiscoveryStatus_t;
 
typedef struct _BTRMGR_IARMAudioInServiceState_t {
    unsigned char m_adapterIndex;
    unsigned char m_serviceState;
} BTRMGR_IARMAudioInServiceState_t;
 
typedef struct _BTRMGR_IARMHidGamePadServiceState_t {
    unsigned char m_adapterIndex;
    unsigned char m_serviceState;
} BTRMGR_IARMHidGamePadServiceState_t;
 
typedef struct _BTRMGR_IARMGATTValue_t {
    unsigned char   m_adapterIndex;
    char m_UUID[BTRMGR_MAX_STR_LEN];
    char m_Value[BTRMGR_MAX_STR_LEN];
    BTRMGR_LeProperty_t aElement;
}BTRMGR_IARMGATTValue_t;
 
typedef struct _BTRMGR_IARMGATTServiceInfo_t {
    unsigned char m_adapterIndex;
    char m_UUID[BTRMGR_MAX_STR_LEN];
    unsigned char m_ServiceType;
}BTRMGR_IARMGATTServiceInfo_t;
 
typedef struct _BTRMGR_IARMGATTInfo_t {
    unsigned char m_adapterIndex;
    char m_ParentUUID[BTRMGR_MAX_STR_LEN];
    char m_UUID[BTRMGR_MAX_STR_LEN];
    unsigned short m_Flags;
    char m_Value[BTRMGR_MAX_STR_LEN];
    BTRMGR_LeProperty_t m_Element;
}BTRMGR_IARMGATTInfo_t;
 
typedef struct _BTRMGR_IARMAdvtInfo_t {
    unsigned char                   m_adapterIndex;
    BTRMGR_LeCustomAdvertisement_t  m_CustAdvt;
}BTRMGR_IARMAdvtInfo_t;
 
typedef struct _BTRMGR_IARMDiagInfo_t {
    unsigned char m_adapterIndex;
    char          m_UUID[BTRMGR_MAX_STR_LEN];
    char          m_DiagInfo[BTRMGR_MAX_STR_LEN];
    BTRMGR_LeOp_t m_OpType;
}BTRMGR_IARMDiagInfo_t;
 
typedef struct _BTRMGR_IARMWifiConnectInfo_t {
    unsigned char m_adapterIndex;
    char          m_SSID[BTRMGR_MAX_STR_LEN];
    char          m_Password[BTRMGR_MAX_STR_LEN];
    int           m_SecMode;
}BTRMGR_IARMWifiConnectInfo_t;
/** @} */
#endif /* __BT_MGR_IARM_INTERFACE_H__ */