1 /* 2 * Copyright (C) 2021-2022 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef BT_DEF_H 17 #define BT_DEF_H 18 19 #include <string> 20 #include <vector> 21 22 namespace OHOS { 23 namespace bluetooth { 24 // Defined here are various status codes 25 /********************************************* 26 * 27 * Interface Return Value Macro Define 28 * 29 *********************************************/ 30 constexpr int RET_NO_ERROR = 0; 31 constexpr int RET_NO_SUPPORT = -1; 32 constexpr int RET_BAD_PARAM = -2; 33 constexpr int RET_BAD_STATUS = -3; 34 constexpr int RET_NO_SPACE = -4; 35 36 /********************************************* 37 * 38 * Bluetooth UUID Macro Define 39 * 40 *********************************************/ 41 const std::string BLUETOOTH_UUID_BASE_UUID = "00000000-0000-1000-8000-00805F9B34FB"; 42 const std::string BLUETOOTH_UUID_A2DP_SINK = "0000110B-0000-1000-8000-00805F9B34FB"; 43 const std::string BLUETOOTH_UUID_A2DP_SRC = "0000110A-0000-1000-8000-00805F9B34FB"; 44 const std::string BLUETOOTH_UUID_GATT = "00001801-0000-1000-8000-00805F9B34FB"; 45 const std::string BLUETOOTH_UUID_AVRCP_CT = "0000110E-0000-1000-8000-00805F9B34FB"; 46 const std::string BLUETOOTH_UUID_AVRCP_TG = "0000110C-0000-1000-8000-00805F9B34FB"; 47 const std::string BLUETOOTH_UUID_HFP_AG = "0000111F-0000-1000-8000-00805F9B34FB"; 48 const std::string BLUETOOTH_UUID_HFP_HF = "0000111E-0000-1000-8000-00805F9B34FB"; 49 const std::string BLUETOOTH_UUID_PBAP_PCE = "0000112E-0000-1000-8000-00805F9B34FB"; 50 const std::string BLUETOOTH_UUID_PBAP_PSE = "0000112F-0000-1000-8000-00805F9B34FB"; 51 const std::string BLUETOOTH_UUID_SPP = "00001101-0000-1000-8000-00805F9B34FB"; 52 const std::string BLUETOOTH_UUID_PNP = "00001200-0000-1000-8000-00805F9B34FB"; 53 const std::string BLUETOOTH_UUID_HID_HOST = "00001124-0000-1000-8000-00805F9B34FB"; 54 const std::string BLUETOOTH_UUID_PAN = "00001116-0000-1000-8000-00805F9B34FB"; 55 const std::string BLUETOOTH_UUID_OPP = "00001105-0000-1000-8000-00805F9B34FB"; 56 57 /********************************************* 58 * 59 * Adapter Macro Define 60 * 61 *********************************************/ 62 /** 63 * @brief bt transport define 64 * use to GetRemoteDevice(),GetPairedDevices()... 65 */ 66 enum BTTransport { 67 ADAPTER_BREDR = 0, 68 ADAPTER_BLE, 69 }; 70 /** 71 * @brief bt adapter/profile state define 72 * use to GetBtConnectionState(),GetBtProfileConnState(),... 73 */ 74 enum BTStateID { 75 STATE_TURNING_ON, 76 STATE_TURN_ON, 77 STATE_TURNING_OFF, 78 STATE_TURN_OFF, 79 }; 80 /** 81 * @brief connect state define 82 * use to ConnectionState()... 83 */ 84 enum class BTConnectState : int { 85 CONNECTING, 86 CONNECTED, 87 DISCONNECTING, 88 DISCONNECTED, 89 }; 90 /** 91 * @brief access permission define 92 * use to 93 * Get/SetPhonebookPermission(),Get/SetMessagePermission() 94 */ 95 enum class BTPermissionType : int { 96 ACCESS_UNKNOWN, 97 ACCESS_ALLOWED, 98 ACCESS_FORBIDDEN, 99 }; 100 /** 101 * @brief connection strategy define 102 * use to 103 * SetConnectionStrategy(),GetConnectionStrategy() 104 */ 105 enum class BTStrategyType : int { 106 CONNECTION_UNKNOWN, 107 CONNECTION_ALLOWED, 108 CONNECTION_FORBIDDEN, 109 }; 110 /** 111 * @brief profile id define 112 * use to 113 * GetBtProfileConnState(),GetProfileList() 114 */ 115 const uint32_t PROFILE_ID_GATT_CLIENT = 0x00000001; 116 const uint32_t PROFILE_ID_GATT_SERVER = 0x00000002; 117 const uint32_t PROFILE_ID_A2DP_SRC = 0x00000004; 118 const uint32_t PROFILE_ID_A2DP_SINK = 0x00000008; 119 const uint32_t PROFILE_ID_AVRCP_CT = 0x00000010; 120 const uint32_t PROFILE_ID_AVRCP_TG = 0x00000020; 121 const uint32_t PROFILE_ID_HFP_AG = 0x00000040; 122 const uint32_t PROFILE_ID_HFP_HF = 0x00000080; 123 const uint32_t PROFILE_ID_MAP_MCE = 0x00000100; 124 const uint32_t PROFILE_ID_MAP_MSE = 0x00000200; 125 const uint32_t PROFILE_ID_PBAP_PCE = 0x00000400; 126 const uint32_t PROFILE_ID_PBAP_PSE = 0x00000800; 127 const uint32_t PROFILE_ID_SPP = 0x00001000; 128 const uint32_t PROFILE_ID_DI = 0x00002000; 129 const uint32_t PROFILE_ID_HID_HOST = 0x00004000; 130 const uint32_t PROFILE_ID_PAN = 0x00008000; 131 const uint32_t PROFILE_ID_OPP = 0x00010000; 132 133 /** 134 * @brief default value 135 * use to 136 * initialize mac address, name or other values. 137 */ 138 const std::string INVALID_MAC_ADDRESS = "00:00:00:00:00:00"; 139 const std::string INVALID_NAME = ""; 140 const int INVALID_VALUE = 0; 141 const int INVALID_TYPE = -1; 142 const int ADDRESS_LENGTH = 17; 143 const int ADDRESS_COLON_INDEX = 2; 144 const int ADDRESS_SEPARATOR_UNIT = 3; 145 146 /** 147 * @brief discovery state 148 * use to 149 * GetBtScanMode(), SetBtScanMode() 150 */ 151 const int DISCOVERY_STARTED = 0x01; 152 const int DISCOVERYING = 0x02; 153 const int DISCOVERY_STOPED = 0x03; 154 155 /** 156 * @brief pairing result 157 * use to 158 * OnPairStatusChanged() 159 */ 160 const int PAIR_NONE = 0x01; 161 const int PAIR_PAIRING = 0x02; 162 const int PAIR_PAIRED = 0x03; 163 164 /** 165 * @brief user confirm type during paring process. 166 * use to 167 * OnPairConfirmed() 168 */ 169 const int PAIR_CONFIRM_TYPE_PIN_CODE = 0x01; 170 const int PAIR_CONFIRM_TYPE_PASSKEY_DISPLAY = 0x02; 171 const int PAIR_CONFIRM_TYPE_PASSKEY_INPUT = 0x03; 172 const int PAIR_CONFIRM_TYPE_NUMERIC = 0x04; 173 const int PAIR_CONFIRM_TYPE_CONSENT = 0x05; 174 175 /** 176 * @brief discoverable mode and connect mode 177 * use to 178 * GetBtScanMode(), SetBtScanMode() 179 */ 180 const int SCAN_MODE_NONE = 0x00; 181 const int SCAN_MODE_CONNECTABLE = 0x01; 182 const int SCAN_MODE_GENERAL_DISCOVERABLE = 0x02; 183 const int SCAN_MODE_LIMITED_DISCOVERABLE = 0x03; 184 const int SCAN_MODE_CONNECTABLE_GENERAL_DISCOVERABLE = 0x04; 185 const int SCAN_MODE_CONNECTABLE_LIMITED_DISCOVERABLE = 0x05; 186 187 /** 188 * @brief bondable mode define 189 * use to 190 * GetBondableMode(), SetBondableMode() 191 */ 192 const int BONDABLE_MODE_OFF = 0x00; 193 const int BONDABLE_MODE_ON = 0x01; 194 195 /** 196 * @brief remote device's transport type 197 * use to 198 * GetTransportType() 199 */ 200 const int BT_TRANSPORT_BREDR = 0; 201 const int BT_TRANSPORT_BLE = 1; 202 203 /** 204 * @brief remote device type 205 * use to 206 * GetDeviceType 207 */ 208 const int DEVICE_TYPE_UNKNOWN = -1; 209 const int DEVICE_TYPE_BREDR = 0; 210 const int DEVICE_TYPE_LE = 1; 211 const int DEVICE_TYPE_DUAL_MONO = 2; 212 /********************************************* 213 * 214 * GATT Macro Define 215 * 216 *********************************************/ 217 218 constexpr uint8_t GATT_TRANSPORT_TYPE_AUTO = 0x0; 219 constexpr uint8_t GATT_TRANSPORT_TYPE_LE = 0x1; 220 constexpr uint8_t GATT_TRANSPORT_TYPE_CLASSIC = 0x2; 221 constexpr uint8_t GATT_ROLE_MASTER = 0x00; 222 constexpr uint8_t GATT_ROLE_SLAVE = 0x01; 223 constexpr uint8_t GATT_ROLE_INVALID = 0xFF; 224 225 /** A GATT Attribute Permission. 226 * Define GATT Attribute permissions. 227 */ 228 enum class GattPermission : uint8_t { 229 READABLE = 1 << 0, /**< readable */ 230 WRITABLE = 1 << 1, 231 ENCRYPTION = 1 << 2, 232 AUTHENTICATION = 1 << 3, 233 AUTHORIZATION = 1 << 4 234 }; 235 236 enum class GattConnectionPriority : int { BALANCED, HIGH, LOW_POWER }; 237 238 enum GattStatus { 239 INVALID_REMOTE_DEVICE = -29, 240 INCLUDE_SERVICE_NOT_FOUND, 241 REFERENCED_BY_OTHER_SERVICE, 242 INVALID_CHARACTERISTIC, 243 INVALID_CHARACTERISTIC_DATA, 244 INVALID_CHARACTERISTIC_DESCRIPTOR, 245 INVALID_CHARACTERISTIC_DESCRIPTOR_DATA, 246 NOT_ENOUGH_HANDLES, 247 HANDLE_NOT_FOUND, 248 INVALID_PARAMETER, 249 INTERNAL_ERROR, 250 REQUEST_NOT_SUPPORT, 251 REMOTE_DEVICE_BUSY, 252 MAX_CONNECTIONS, 253 MAX_APPLICATIONS, 254 DEVICE_ALREADY_BIND, 255 INVALID_HANDLE, 256 INVALID_OFFSET, 257 READ_NOT_PERMITTED, 258 WRITE_NOT_PERMITTED, 259 INSUFFICIENT_ENCRYPTION, 260 INSUFFICIENT_AUTHENTICATION, 261 INSUFFICIENT_AUTHORIZATION, 262 INSUFFICIENT_ENCRYPTION_KEY_SIZE, 263 PREPARE_QUEUE_FULL, 264 ATTRIBUTE_NOT_LONG, 265 INVALID_ATTRIBUTE_VALUE_LENGTH, 266 WRITE_REQUEST_REJECTED, 267 GATT_FAILURE, 268 GATT_SUCCESS 269 }; 270 271 /********************************************* 272 * 273 * BLE Macro Define 274 * 275 *********************************************/ 276 // Minimum value for advertising interval. 277 const int BLE_ADV_MIN_INTERVAL = 0x0020; 278 // Maximum value for advertising interval. 279 const int BLE_ADV_MAX_INTERVAL = 0x4000; 280 // Default value for advertising interval. 281 const int BLE_ADV_DEFAULT_INTERVAL = 0x03E8; 282 283 // Special advertising set handle used for the legacy advertising set. 284 const uint8_t BLE_LEGACY_ADVERTISING_HANDLE = 0x00; 285 // Special advertising set handle used as return or parameter to signify an invalid handle. 286 const uint8_t BLE_INVALID_ADVERTISING_HANDLE = 0xFF; 287 288 // Report delay millis default value 289 const int BLE_REPORT_DELAY_MILLIS = 5000; 290 291 // Definitions for UUID length constants. 292 const int BLE_UUID_LEN_16 = 2; 293 const int BLE_UUID_LEN_32 = 4; 294 const int BLE_UUID_LEN_128 = 16; 295 const int DEVICE_NAME_MAX_LEN = 26; 296 297 // BLE acl connect status 298 const int BLE_CONNECTION_STATE_DISCONNECTED = 0x00; 299 const int BLE_CONNECTION_STATE_CONNECTED = 0x01; 300 const int BLE_CONNECTION_STATE_ENCRYPTED_BREDR = 0x02; 301 const int BLE_CONNECTION_STATE_ENCRYPTED_LE = 0x04; 302 303 const int BLE_PAIR_NONE = 0x01; 304 const int BLE_PAIR_PAIRING = 0x02; 305 const int BLE_PAIR_PAIRED = 0x03; 306 const int BLE_PAIR_CANCELING = 0x04; 307 308 const int BLE_ADV_DEFAULT_OP_CODE = 0x00; 309 const int BLE_ADV_STOP_COMPLETE_OP_CODE = 0x01; 310 const int BLE_ADV_START_FAILED_OP_CODE = 0x02; 311 312 const uint8_t BLE_ADV_DATA_BYTE_FIELD_LEN = 3; 313 const uint8_t BLE_ADV_DATA_FIELD_TYPE_AND_LEN = 2; 314 const uint8_t BLE_ONE_BYTE_LEN = 8; 315 316 const int8_t BLE_ADV_TX_POWER_ULTRA_LOW_VALUE = -21; 317 const int8_t BLE_ADV_TX_POWER_LOW_VALUE = -15; 318 const int8_t BLE_ADV_TX_POWER_MEDIUM_VALUE = -7; 319 const int8_t BLE_ADV_TX_POWER_HIGH_VALUE = 1; 320 321 // Intended Advertising PHY 322 const uint8_t BLE_ADVERTISEMENT_PHY_NONE = 0x00; 323 const uint8_t BLE_ADVERTISEMENT_PHY_1M = 0x01; 324 const uint8_t BLE_ADVERTISEMENT_PHY_2M = 0x02; 325 const uint8_t BLE_ADVERTISEMENT_PHY_CODED = 0x03; 326 327 const uint8_t BLE_LEGACY_SCAN_RESPONSE = 3; 328 const uint8_t BLE_LEGACY_ADV_SCAN_IND = 1; 329 const uint8_t BLE_LEGACY_ADV_IND_WITH_EX_ADV = 0x13; 330 const uint8_t BLE_LEGACY_ADV_NONCONN_IND_WITH_EX_ADV = 0x10; 331 const uint8_t BLE_ADV_EVT_LEGACY_BIT = 4; 332 333 // Incomplete, more data to come 334 const uint8_t BLE_EX_SCAN_DATE_STATUS_INCOMPLETE_MORE = 0x20; 335 // Incomplete, data truncated, no more to come 336 const uint8_t BLE_EX_SCAN_DATE_STATUS_INCOMPLETE_NO_MORE = 0x40; 337 338 // Scan mode 339 typedef enum { 340 SCAN_MODE_LOW_POWER = 0x00, 341 SCAN_MODE_BALANCED = 0x01, 342 SCAN_MODE_LOW_LATENCY = 0x02, 343 SCAN_MODE_OP_P2_60_3000 = 0x03, 344 SCAN_MODE_OP_P10_60_600 = 0x04, 345 SCAN_MODE_OP_P25_60_240 = 0x05, 346 SCAN_MODE_OP_P100_1000_1000 = 0x06 347 } SCAN_MODE; 348 349 // Phy type 350 using PHY_TYPE = enum { PHY_LE_1M = 1, PHY_LE_2M = 2, PHY_LE_CODED = 3, PHY_LE_ALL_SUPPORTED = 255 }; 351 352 // BLE advertiser TX power level. 353 using BLE_ADV_TX_POWER_LEVEL = enum { 354 BLE_ADV_TX_POWER_ULTRA_LOW = 0x00, 355 BLE_ADV_TX_POWER_LOW = 0x01, 356 BLE_ADV_TX_POWER_MEDIUM = 0x02, 357 BLE_ADV_TX_POWER_HIGH = 0x03 358 }; 359 360 // BLE advertiser flag 361 const uint8_t BLE_ADV_FLAG_NON_LIMIT_DISC = 0x00; 362 const uint8_t BLE_ADV_FLAG_LIMIT_DISC = 0x01 << 0; 363 const uint8_t BLE_ADV_FLAG_GEN_DISC = 0x01 << 1; 364 const uint8_t BLE_ADV_FLAG_BREDR_NOT_SPT = 0x01 << 2; 365 const uint8_t BLE_ADV_FLAG_DMT_CONTROLLER_SPT = 0x01 << 3; 366 const uint8_t BLE_ADV_FLAG_DMT_HOST_SPT = 0x01 << 4; 367 368 // Bluetooth device type 369 using BLE_BT_DEV_TYPE = enum { 370 BLE_BT_DEVICE_TYPE_UNKNOWN = -1, 371 BLE_BT_DEVICE_TYPE_BREDR = 0, 372 BLE_BT_DEVICE_TYPE_BLE = 1, 373 BLE_BT_DEVICE_TYPE_DUMO = 2, 374 }; 375 376 // BLE device address type 377 using BLE_ADDR_TYPE = enum { 378 BLE_ADDR_TYPE_PUBLIC = 0x00, 379 BLE_ADDR_TYPE_RANDOM = 0x01, 380 BLE_ADDR_TYPE_NON_RPA = 0x02, 381 BLE_ADDR_TYPE_RPA = 0x03, 382 BLE_ADDR_TYPE_UNKNOWN = 0xFE, 383 BLE_ADDR_TYPE_ANONYMOUS = 0xFF, 384 }; 385 386 using BLE_IO_CAP = enum { 387 BLE_IO_CAP_OUT = 0x00, // DisplayOnly 388 BLE_IO_CAP_IO = 0x01, // DisplayYesNo 389 BLE_IO_CAP_IN = 0x02, // KeyboardOnly 390 BLE_IO_CAP_NONE = 0x03, // NoInputNoOutput 391 BLE_IO_CAP_KBDISP = 0x04 // Keyboard display 392 }; 393 394 // Adv status 395 using BleAdvState = enum { 396 BLE_ADV_STATE_IDLE, 397 BLE_ADV_STATE_ADVERTISING, 398 }; 399 400 // The type of advertising data(not adv_type) 401 using BLE_ADV_DATA_TYPE = enum { 402 BLE_AD_TYPE_FLAG = 0x01, 403 BLE_AD_TYPE_16SRV_PART = 0x02, 404 BLE_AD_TYPE_16SRV_CMPL = 0x03, 405 BLE_AD_TYPE_32SRV_PART = 0x04, 406 BLE_AD_TYPE_32SRV_CMPL = 0x05, 407 BLE_AD_TYPE_128SRV_PART = 0x06, 408 BLE_AD_TYPE_128SRV_CMPL = 0x07, 409 BLE_AD_TYPE_NAME_SHORT = 0x08, 410 BLE_AD_TYPE_NAME_CMPL = 0x09, 411 BLE_AD_TYPE_TX_PWR = 0x0A, 412 BLE_AD_TYPE_DEV_CLASS = 0x0D, 413 BLE_AD_TYPE_SM_TK = 0x10, 414 BLE_AD_TYPE_SM_OOB_FLAG = 0x11, 415 BLE_AD_TYPE_INT_RANGE = 0x12, 416 BLE_AD_TYPE_SOL_SRV_UUID = 0x14, 417 BLE_AD_TYPE_128SOL_SRV_UUID = 0x15, 418 BLE_AD_TYPE_SERVICE_DATA = 0x16, 419 BLE_AD_TYPE_PUBLIC_TARGET = 0x17, 420 BLE_AD_TYPE_RANDOM_TARGET = 0x18, 421 BLE_AD_TYPE_APPEARANCE = 0x19, 422 BLE_AD_TYPE_ADV_INT = 0x1A, 423 BLE_AD_TYPE_LE_DEV_ADDR = 0x1b, 424 BLE_AD_TYPE_LE_ROLE = 0x1c, 425 BLE_AD_TYPE_SPAIR_C256 = 0x1d, 426 BLE_AD_TYPE_SPAIR_R256 = 0x1e, 427 BLE_AD_TYPE_32SOL_SRV_UUID = 0x1f, 428 BLE_AD_TYPE_32SERVICE_DATA = 0x20, 429 BLE_AD_TYPE_128SERVICE_DATA = 0x21, 430 BLE_AD_TYPE_LE_SECURE_CONFIRM = 0x22, 431 BLE_AD_TYPE_LE_SECURE_RANDOM = 0x23, 432 BLE_AD_TYPE_URI = 0x24, 433 BLE_AD_TYPE_INDOOR_POSITION = 0x25, 434 BLE_AD_TYPE_TRANS_DISC_DATA = 0x26, 435 BLE_AD_TYPE_LE_SUPPORT_FEATURE = 0x27, 436 BLE_AD_TYPE_CHAN_MAP_UPDATE = 0x28, 437 BLE_AD_MANUFACTURER_SPECIFIC_TYPE = 0xFF, 438 }; 439 440 /********************************************* 441 * 442 * Map Define 443 * 444 *********************************************/ 445 // Map Message Type 446 enum class MapMessageType : int { 447 EMAIL = 0, 448 SMS_GSM = 1, 449 SMS_CDMA = 2, 450 MMS = 3, 451 IM = 4, 452 INVALID = 5 453 }; // IM only support in bmessage ver1.1 454 455 // Map Message Status 456 enum class MapMessageStatus : int { READ, UNREAD, INVALID }; // default UNREAD 457 458 // Map BoolType , YES or NO 459 enum class MapBoolType : int { YES, NO, INVALID }; // default NO 460 461 // Map Message ReceptionStatus 462 enum class MapMsgReceptionStatus : int { COMPLETE, FRACTIONED, NOTIFICATION, INVALID }; 463 464 // Map MsgDeliveryStatus 465 enum class MapMsgDeliveryStatus : int { DELIVERED, SENT, UNKNOWN, INVALID }; 466 467 // Map MsgDirection 468 enum class MapMsgDirection : int { INCOMING, OUTGOING, OUTGOINGDRAFT, OUTGOINGPENDING, INVALID }; 469 470 // Map FractionDeliverType 471 enum class MapFractionDeliverType : int { MORE, LAST, INVALID }; 472 473 // Map FractionRequest Type 474 enum class MapFractionRequestType : uint8_t { FIRST = 0x00, NEXT = 0x01, INVALID = 0x02 }; 475 476 // Map OnOff Type 477 enum class MapOnOffType : uint8_t { OFF = 0, ON = 1, INVALID = 3 }; 478 479 // Map Charset Type 480 enum class MapCharsetType : uint8_t { NATIVE = 0x00, UTF_8 = 0x01, INVALID = 0x02 }; 481 482 // Attachment Type 483 enum class MapAttachmentType : uint8_t { NO = 0x00, HAVE = 0x01, INVALID = 0x02 }; 484 485 // Map StatusIndicator Type 486 enum class MapStatusIndicatorType : uint8_t { 487 READ_STATUS = 0x00, 488 DELETED_STATUS = 0x01, 489 SET_EXTENDED_DATA = 0x02, 490 INVALID = 0x03 491 }; 492 493 // Map StatusValue Type 494 enum class MapStatusValueType : uint8_t { NO = 0x00, YES = 0x01 }; 495 496 // Map ModifyText Type 497 enum class MapModifyTextType : uint8_t { REPLACE = 0x00, PREPEND = 0x01, INVALID = 0x02 }; 498 499 // Map Action Type 500 enum class MapActionType : int { 501 GET_UNREAD_MESSAGES, 502 GET_SUPPORTED_FEATURES, 503 SEND_MESSAGE, 504 SET_NOTIFICATION_FILTER, 505 GET_MESSAGES_LISTING, 506 GET_MESSAGE, 507 UPDATE_INBOX, 508 GET_CONVERSATION_LISTING, 509 SET_MESSAGE_STATUS, 510 SET_OWNER_STATUS, 511 GET_OWNER_STATUS, 512 GET_MAS_INSTANCE_INFO 513 }; 514 515 // Map ExecuteStatus Type 516 enum class MapExecuteStatus : int { 517 SUCCEED = 0, 518 CONTINUE = 1, 519 BAD_PARAM = (-1), 520 BAD_STATUS = (-2), 521 NOT_SUPPORT = (-3) 522 }; 523 524 // Supported Message Types 525 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_EMAIL 0x01 526 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_SMS_GSM 0x02 527 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_SMS_CDMA 0x04 528 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_MMS 0x08 529 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_IM 0x10 530 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_ALL 0x01F 531 532 // Api: MapClient::GetMessagesListing Application Parameters Mask defines 533 // FilterMessageType Mask, 1 is "filter out this type", 0 is "no filtering, get this type" 534 #define MAP_FILTER_MESSAGE_MASK_SMS_GSM 0b00000001 535 #define MAP_FILTER_MESSAGE_MASK_SMS_CDMA 0b00000010 536 #define MAP_FILTER_MESSAGE_MASK_EMAIL 0b00000100 537 #define MAP_FILTER_MESSAGE_MASK_MMS 0b00001000 538 #define MAP_FILTER_MESSAGE_MASK_IM 0b00010000 539 #define MAP_FILTER_MESSAGE_MASK_NO_FILTERING 0b00000000 540 // FilterReadStatus, 0b00000001 is get unread messages only, 541 // 0b00000010 is get read messages only 542 #define MAP_FILTER_READ_STATUS_MASK_UNREAD 0b00000001 543 #define MAP_FILTER_READ_STATUS_MASK_READ 0b00000010 544 #define MAP_FILTER_READ_STATUS_MASK_NO_FILTERING 0b00000000 545 // FilterPriority, 0b00000001 is get high priority messages only, 546 // 0b00000010 is get non-high priority messages only 547 #define MAP_FILTER_PRIORITY_MASK_HIGH 0b00000001 548 #define MAP_FILTER_PRIORITY_MASK_NO_HIGH 0b00000010 549 #define MAP_FILTER_PRIORITY_MASK_NO_FILTERING 0b00000000 550 // ParameterMask , Bits 0-20 has been used , Bits 21–31 Reserved for Future Use 551 #define MAP_GETMESSAGELIST_PARAMETER_MASK_REQUIRED 0b000000000000000000000000 552 #define MAP_GETMESSAGELIST_PARAMETER_MASK_PRESENT_ALL 0b000111111111111111111111 553 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SUBJECT 0b000000000000000000000001 554 #define MAP_GETMESSAGELIST_PARAMETER_MASK_DATETIME 0b000000000000000000000010 555 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SENDER_NAME 0b000000000000000000000100 556 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SENDER_ADDRESSING 0b000000000000000000001000 557 #define MAP_GETMESSAGELIST_PARAMETER_MASK_RECIPIENT_NAME 0b000000000000000000010000 558 #define MAP_GETMESSAGELIST_PARAMETER_MASK_RECIPIENT_ADDRESSING 0b000000000000000000100000 559 #define MAP_GETMESSAGELIST_PARAMETER_MASK_TYPE 0b000000000000000001000000 560 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SIZE 0b000000000000000010000000 561 #define MAP_GETMESSAGELIST_PARAMETER_MASK_RECEPTION_STATUS 0b000000000000000100000000 562 #define MAP_GETMESSAGELIST_PARAMETER_MASK_TEXT 0b000000000000001000000000 563 #define MAP_GETMESSAGELIST_PARAMETER_MASK_ATTACHMENT_SIZE 0b000000000000010000000000 564 #define MAP_GETMESSAGELIST_PARAMETER_MASK_PRIORITY 0b000000000000100000000000 565 #define MAP_GETMESSAGELIST_PARAMETER_MASK_READ 0b000000000001000000000000 566 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SENT 0b000000000010000000000000 567 #define MAP_GETMESSAGELIST_PARAMETER_MASK_PROTECTED 0b000000000100000000000000 568 #define MAP_GETMESSAGELIST_PARAMETER_MASK_REPLYTO_ADDRESSING 0b000000001000000000000000 569 #define MAP_GETMESSAGELIST_PARAMETER_MASK_DELIVERY_STATUS 0b000000010000000000000000 570 #define MAP_GETMESSAGELIST_PARAMETER_MASK_CONVERSATION_ID 0b000000100000000000000000 571 #define MAP_GETMESSAGELIST_PARAMETER_MASK_CONVERSATION_NAME 0b000001000000000000000000 572 #define MAP_GETMESSAGELIST_PARAMETER_MASK_DIRECTION 0b000010000000000000000000 573 #define MAP_GETMESSAGELIST_PARAMETER_MASK_ATTACHMENT_MIME 0b000100000000000000000000 574 575 // Api: MapClient::GetConversationListing Application Parameters Mask defines 576 // ConvParameterMask , Bits 0-14 has been used, Bits 15–31 Reserved for Future Use 577 // Bit i is 1 indicates that the parameter related to Bit i shall be present in the requested Conversation-Listing. 578 // The reserved bits shall be set to 0 by the MCE and discarded by the MSE. 579 // If Bit 5 has the value 0, the Conversation-Listing in the response shall not contain any participant element 580 // and therefore the Bits 6–14 do not have any impact. 581 // If Bit 5 has the value 1, then at least one of the Bits 6–14 shall also have the value 1. 582 // If any of the Bits 6–14 has the value 1, Bit 5 shall have the value 1. 583 #define MAP_GETCONV_PARAMETER_MASK_ALL_ON 0b000000000111111111111111 584 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_NAME 0b000000000000000000000001 585 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_LAST_ACTIVITY 0b000000000000000000000010 586 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_READ_STATUS 0b000000000000000000000100 587 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_VERSION_COUNTER 0b000000000000000000001000 588 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_SUMMARY 0b000000000000000000010000 589 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANTS 0b000000000000000000100000 590 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_UCI 0b000000000000000001000000 591 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_DISPLAY_NAME 0b000000000000000010000000 592 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_CHAT_STATE 0b000000000000000100000000 593 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_LAST_ACTIVITY 0b000000000000001000000000 594 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_X_BT_UID 0b000000000000010000000000 595 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_NAME 0b000000000000100000000000 596 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_PRESENCE_AVAILABILITY 0b000000000001000000000000 597 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_PRESENCE_TEXT 0b000000000010000000000000 598 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_PRIORITY 0b000000000100000000000000 599 600 // Api: MapClient::SetNotificationFilter input param mask defines 601 // Bit i is 0 indicates that the MSE shall not send the notification related to bit i for the current MAS. 602 // NotificationFilterMask ,Bits 0-14 has been used, Bits 15–31 Reserved for Future Use 603 #define MAP_NOTIFICATION_FILTER_MASK_ALL_OFF 0b000000000000000000000000 604 #define MAP_NOTIFICATION_FILTER_MASK_ALL_ON 0b000000000111111111111111 605 #define MAP_NOTIFICATION_FILTER_MASK_NEW_MESSAGE 0b000000000000000000000001 606 #define MAP_NOTIFICATION_FILTER_MASK_MESSAGE_DELETED 0b000000000000000000000010 607 #define MAP_NOTIFICATION_FILTER_MASK_MESSAGE_SHIFT 0b000000000000000000000100 608 #define MAP_NOTIFICATION_FILTER_MASK_SENDING_SUCCESS 0b000000000000000000001000 609 #define MAP_NOTIFICATION_FILTER_MASK_SENDING_FAILURE 0b000000000000000000010000 610 #define MAP_NOTIFICATION_FILTER_MASK_DELIVERY_SUCCESS 0b000000000000000000100000 611 #define MAP_NOTIFICATION_FILTER_MASK_DELIVERY_FAILURE 0b000000000000000001000000 612 #define MAP_NOTIFICATION_FILTER_MASK_MEMORY_FULL 0b000000000000000010000000 613 #define MAP_NOTIFICATION_FILTER_MASK_MEMORY_AVAILABLE 0b000000000000000100000000 614 #define MAP_NOTIFICATION_FILTER_MASK_READ_STATUS_CHANGED 0b000000000000001000000000 615 #define MAP_NOTIFICATION_FILTER_MASK_CONVERSATION_CHANGED 0b000000000000010000000000 616 #define MAP_NOTIFICATION_FILTER_MASK_PARTICIPANT_PRESENCE_CHANGED 0b000000000000100000000000 617 #define MAP_NOTIFICATION_FILTER_MASK_PARTICIPANT_CHAT_STATE_CHANGED 0b000000000001000000000000 618 #define MAP_NOTIFICATION_FILTER_MASK_MESSAGE_EXTENDED_DATA_CHANGED 0b000000000010000000000000 619 #define MAP_NOTIFICATION_FILTER_MASK_MESSAGE_REMOVED 0b000000000100000000000000 620 621 // Api: MapClient::GetSupportedFeatures action complete param mask defines 622 // Map Supported features mask 623 #define MAP_SUPPORTED_FEATURES_NOTIFICATION_REGISTRATION 0x00000001 624 #define MAP_SUPPORTED_FEATURES_NOTIFICATION_FEATURE 0x00000002 625 #define MAP_SUPPORTED_FEATURES_BROWSING 0x00000004 626 #define MAP_SUPPORTED_FEATURES_UPLOADING 0x00000008 627 #define MAP_SUPPORTED_FEATURES_DELETE_FEATURE 0x00000010 628 #define MAP_SUPPORTED_FEATURES_INSTANCE_INFO_FEATURE 0x00000020 629 #define MAP_SUPPORTED_FEATURES_EVENT_REPORT_1_1 0x00000040 630 #define MAP_SUPPORTED_FEATURES_EVENT_REPORT_1_2 0x00000080 631 #define MAP_SUPPORTED_FEATURES_MESSAGE_FORMAT_1_1 0x00000100 632 #define MAP_SUPPORTED_FEATURES_MESSAGELIST_FORMAT_1_1 0x00000200 633 #define MAP_SUPPORTED_FEATURES_PERSISTENT_MESSAGE_HANDLE 0x00000400 634 #define MAP_SUPPORTED_FEATURES_DATABASE_IDENTIFIER 0x00000800 635 #define MAP_SUPPORTED_FEATURES_FOLDOR_VERSION_COUNTER 0x00001000 636 #define MAP_SUPPORTED_FEATURES_CONVERSATION_VERSION_COUNTER 0x00002000 637 #define MAP_SUPPORTED_FEATURES_PARTICIPANT_PRESENCE_CHANGE_NOTIFICATION 0x00004000 638 #define MAP_SUPPORTED_FEATURES_PARTICIPANT_CHAT_STATE_CHANGE_NOTIFICATION 0x00008000 639 #define MAP_SUPPORTED_FEATURES_PBAP_CONTACT_CROSS_REFERENCE 0x00010000 640 #define MAP_SUPPORTED_FEATURES_NOTIFICATION_FILTER 0x00020000 641 #define MAP_SUPPORTED_FEATURES_UTC_OFFSET_TIMESTAMP_FORMAT 0x00040000 642 #define MAP_SUPPORTED_FEATURES_MAPSUPPORTED_FEATURES 0x00080000 643 #define MAP_SUPPORTED_FEATURES_CONVERSATION_LISTING 0x00100000 644 #define MAP_SUPPORTED_FEATURES_OWNER_STATUS 0x00200000 645 #define MAP_SUPPORTED_FEATURES_MESSAGE_FORWARDING 0x00400000 646 647 /********************************************* 648 * 649 * AVRCP Macro Define 650 * 651 *********************************************/ 652 653 // The default label. The valid range is 0x00 ~ 0x0F. 654 #define AVRC_DEFAULT_LABEL (0x00) 655 // The invalid label. 656 #define AVRC_INVALID_LABEL (0x10) 657 658 /** 659 * @brief This enumeration declares the types of the methods. 660 * 661 * @since 6 662 */ 663 enum AvrcCtActionType : uint8_t { 664 AVRC_ACTION_TYPE_INVALID = 0x00, 665 AVRC_ACTION_TYPE_PRESS_BUTTON, 666 AVRC_ACTION_TYPE_RELEASE_BUTTON, 667 AVRC_ACTION_TYPE_SET_ADDRESSED_PLAYER, 668 AVRC_ACTION_TYPE_SET_BROWSED_PLAYER, 669 AVRC_ACTION_TYPE_GET_CAPABILITIES, 670 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_ATTRIBUTES, 671 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_VALUES, 672 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_CURRENT_VALUE, 673 AVRC_ACTION_TYPE_SET_PLAYER_APP_SETTING_CURRENT_VALUE, 674 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_ATTRIBUTE_TEXT, 675 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_VALUE_TEXT, 676 AVRC_ACTION_TYPE_GET_ELEMENT_ATTRIBUTES, 677 AVRC_ACTION_TYPE_GET_PLAY_STATUS, 678 AVRC_ACTION_TYPE_PLAY_ITEM, 679 AVRC_ACTION_TYPE_ADD_TO_NOW_PLAYING, 680 AVRC_ACTION_TYPE_CHANGE_PATH, 681 AVRC_ACTION_TYPE_GET_FOLDER_ITEMS, 682 AVRC_ACTION_TYPE_GET_ITEM_ATTRIBUTES, 683 AVRC_ACTION_TYPE_GET_TOTAL_NUMBER_OF_ITEMS, 684 AVRC_ACTION_TYPE_SET_ABSOLUTE_VOLUME, 685 AVRC_ACTION_TYPE_NOTIFY_PLAYBACK_STATUS_CHANGED, 686 AVRC_ACTION_TYPE_NOTIFY_TRACK_CHANGED, 687 AVRC_ACTION_TYPE_NOTIFY_TRACK_REACHED_END, 688 AVRC_ACTION_TYPE_NOTIFY_TRACK_REACHED_START, 689 AVRC_ACTION_TYPE_NOTIFY_PLAYBACK_POS_CHANGED, 690 AVRC_ACTION_TYPE_NOTIFY_PLAYER_APPLICATION_SETTING_CHANGED, 691 AVRC_ACTION_TYPE_NOTIFY_NOW_PLAYING_CONTENT_CHANGED, 692 AVRC_ACTION_TYPE_NOTIFY_AVAILABLE_PLAYERS_CHANGED, 693 AVRC_ACTION_TYPE_NOTIFY_ADDRESSED_PLAYER_CHANGED, 694 AVRC_ACTION_TYPE_NOTIFY_UIDS_CHANGED, 695 AVRC_ACTION_TYPE_NOTIFY_VOLUME_CHANGED, 696 AVRC_ACTION_TYPE_GET_MEDIA_PLAYER_LIST, 697 }; 698 699 /** 700 * @brief This enumeration declares the values of the supported button. 701 * @see AV/C Panel Subunit Specification 1.23 Section 9.4 PASS THROUGH control command Table 9.21 - Operation id List 702 * 703 * @since 6 704 */ 705 enum AvrcKeyOperation : uint8_t { 706 AVRC_KEY_OPERATION_VOLUME_UP = 0x41, // Volume up. 707 AVRC_KEY_OPERATION_VOLUME_DOWN = 0x42, // Volume down. 708 AVRC_KEY_OPERATION_MUTE = 0x43, // Mute. 709 AVRC_KEY_OPERATION_PLAY = 0x44, // Play. 710 AVRC_KEY_OPERATION_STOP = 0x45, // Stop. 711 AVRC_KEY_OPERATION_PAUSE = 0x46, // Pause. 712 AVRC_KEY_OPERATION_REWIND = 0x48, // Rewind. 713 AVRC_KEY_OPERATION_FAST_FORWARD = 0x49, // Fast forward. 714 AVRC_KEY_OPERATION_FORWARD = 0x4B, // Forward. 715 AVRC_KEY_OPERATION_BACKWARD = 0x4C, // Backward. 716 AVRC_KEY_OPERATION_INVALID = 0x7F, 717 }; 718 719 /** 720 * @brief This enumeration declares the values of the key state. 721 * 722 * @since 6 723 */ 724 enum AvrcTgKeyState : uint8_t { 725 AVRC_KEY_STATE_PRESS = 0x00, // The key is pushed. 726 AVRC_KEY_STATE_RELEASE = 0x01, // The key is released. 727 AVRC_KEY_STATE_INVALID, // Invalid key state. 728 }; 729 730 /** 731 * @brief This enumeration declares the values of the player application setting attributes. 732 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 733 * 734 * @since 6 735 */ 736 enum AvrcPlayerAttribute : uint8_t { 737 AVRC_PLAYER_ATTRIBUTE_ILLEGAL = 0x00, // Illegal , Should not be used. 738 AVRC_PLAYER_ATTRIBUTE_EQUALIZER = 0x01, // Equalizer ON / OFF status. 739 AVRC_PLAYER_ATTRIBUTE_REPEAT = 0x02, // Repeat Mode status. 740 AVRC_PLAYER_ATTRIBUTE_SHUFFLE = 0x03, // Shuffle ON/OFF status. 741 AVRC_PLAYER_ATTRIBUTE_SCAN = 0x04, // Scan ON/OFF status. 742 AVRC_PLAYER_ATTRIBUTE_RESERVED_MIN = 0x05, // Reserved for future use. 0x05 - 0x7F 743 AVRC_PLAYER_ATTRIBUTE_RESERVED_MAX = 0x7F, // Reserved for future use. 0x05 - 0x7F 744 AVRC_PLAYER_ATTRIBUTE_EXTENSION = 0x80, // Provided for TG driven static media player menu extension. 745 // Range: 0x80 - 0xFF 746 }; 747 748 /** 749 * @brief This enumeration declares the values of the Equalizer ON/OFF status. 750 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 751 * 752 * @since 6 753 */ 754 enum AvrcEqualizer : uint8_t { 755 AVRC_EQUALIZER_OFF = 0x01, 756 AVRC_EQUALIZER_ON, 757 AVRC_EQUALIZER_INVALID, 758 }; 759 760 /** 761 * @brief This enumeration declares the values of the Repeat Mode status. 762 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 763 * 764 * @since 6 765 */ 766 enum AvrcRepeat : uint8_t { 767 AVRC_REPEAT_OFF = 0x01, 768 AVRC_REPEAT_SINGLE_TRACK, 769 AVRC_REPEAT_ALL_TRACK, 770 AVRC_REPEAT_GROUP, 771 AVRC_REPEAT_INVALID, 772 }; 773 774 /** 775 * @brief This enumeration declares the values of the Shuffle ON/OFF status. 776 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 777 * 778 * @since 6 779 */ 780 enum AvrcShuffle : uint8_t { 781 AVRC_SHUFFLE_OFF = 0x01, 782 AVRC_SHUFFLE_ALL_TRACKS, 783 AVRC_SHUFFLE_GROUP, 784 AVRC_SHUFFLE_INVALID, 785 }; 786 787 /** 788 * @brief This enumeration declares the values of the Scan ON/OFF status. 789 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 790 * 791 * @since 6 792 */ 793 enum AvrcScan : uint8_t { 794 AVRC_SCAN_OFF = 0x01, 795 AVRC_SCAN_ALL_TRACKS, 796 AVRC_SCAN_GROUP, 797 AVRC_SCAN_INVALID, 798 }; 799 800 /** 801 * @brief This enumeration declares the values of the play status. 802 * 803 * @since 6 804 */ 805 enum AvrcPlayStatus : uint32_t { 806 AVRC_PLAY_STATUS_STOPPED = 0x00, // Stopped. 807 AVRC_PLAY_STATUS_PLAYING, // Playing. 808 AVRC_PLAY_STATUS_PAUSED, // Paused. 809 AVRC_PLAY_STATUS_FWD_SEEK, // Fwd seek. 810 AVRC_PLAY_STATUS_REV_SEEK, // Rev seek. 811 AVRC_PLAY_STATUS_RESERVED_MIN = 0x05, // Reserved for future use. 812 AVRC_PLAY_STATUS_RESERVED_MAX = 0xFE, // Reserved for future use. 813 AVRC_PLAY_STATUS_ERROR = 0xFF, // Error. 814 AVRC_PLAY_STATUS_INVALID_SONG_LENGTH = 0xFFFFFFFF, // If TG does not support, then TG shall return 0xFFFFFFFF. 815 AVRC_PLAY_STATUS_INVALID_SONG_POSITION = 0xFFFFFFFF, // If TG does not support, then TG shall return 0xFFFFFFFF. 816 }; 817 818 /** 819 * @brief This enumeration declares the values of folder direction. 820 * 821 * @since 6 822 */ 823 enum AvrcFolderDirection : uint8_t { 824 AVRC_FOLDER_DIRECTION_UP = 0x00, // Folder up. 825 AVRC_FOLDER_DIRECTION_DOWN = 0x01, // Folder down. 826 AVRC_FOLDER_DIRECTION_INVALID = 0x02, // Reserved. 827 }; 828 829 /** 830 * @brief This enumeration declares the values of the scope in which the UID of the media element item or folder item. 831 * @see Audio/Video Remote Control 1.6.2 Section 6.10.1 Scope. 832 * 833 * @since 6 834 */ 835 enum AvrcMediaScope : uint8_t { 836 AVRC_MEDIA_SCOPE_PLAYER_LIST = 0x00, // Contains all available media players. 837 AVRC_MEDIA_SCOPE_VIRTUAL_FILE_SYSTEM, // Contains the media content of the browsed player. 838 AVRC_MEDIA_SCOPE_SEARCH, // The results of a search operation on the browsed player. 839 AVRC_MEDIA_SCOPE_NOW_PLAYING, // The Now Playing list (or queue) of the addressed player. 840 AVRC_MEDIA_SCOPE_INVALID, 841 }; 842 843 /** 844 * @brief This enumeration declares the values of the browsable items. 845 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2 Browsable items. 846 * 847 * @since 6 848 */ 849 enum AvrcMediaType : uint8_t { 850 AVRC_MEDIA_TYPE_MEDIA_PLAYER_ITEM = 0x01, 851 AVRC_MEDIA_TYPE_FOLDER_ITEM, 852 AVRC_MEDIA_TYPE_MEDIA_ELEMENT_ITEM, 853 AVRC_MEDIA_TYPE_INVALID, 854 }; 855 856 /** 857 * @brief This enumeration declares the values of the attribute count. 858 * @see Audio/Video Remote Control 1.6.2 Section 6.10.4.2 GetFolderItems - Attribute Count. 859 * 860 * @since 6 861 */ 862 enum AvrcAttributeCount { 863 AVRC_ATTRIBUTE_COUNT_ALL = 0x00, 864 AVRC_ATTRIBUTE_COUNT_NO = 0xFF, 865 }; 866 867 /** 868 * @brief This enumeration declares the values of the media attribute. These values are used to uniquely identify media 869 * information. 870 * @see Audio/Video Remote Control 1.6.2 Section 26 Appendix E: list of media attributes. 871 * 872 * @since 6 873 */ 874 enum AvrcMediaAttribute : uint8_t { 875 // Not used. 876 AVRC_MEDIA_ATTRIBUTE_NOT_USED = 0x00, 877 // Text field representing the title, song name or content description coded per specified character set. 878 AVRC_MEDIA_ATTRIBUTE_TITLE, 879 // Text field representing artist(s), performer(s) or group coded per specified character set. 880 AVRC_MEDIA_ATTRIBUTE_ARTIST_NAME, 881 // Text field representing the title of the recording(source) from which the audio in the file is taken. 882 AVRC_MEDIA_ATTRIBUTE_ALBUM_NAME, 883 // Numeric ASCII string containing the order number of the audio - file on its original recording.O 0x5 Total 884 // Number of Tracks. 885 AVRC_MEDIA_ATTRIBUTE_TRACK_NUMBER, 886 // Numeric ASCII string containing the total number of tracks or elements on the original recording. 887 AVRC_MEDIA_ATTRIBUTE_TOTAL_NUMBER_OF_TRACKS, 888 // Text field representing the category of the composition characterized by a particular style. 889 AVRC_MEDIA_ATTRIBUTE_GENRE, 890 // Numeric ASCII string containing the length of the audio file in milliseconds.(E.g .02 : 30 = 150000) 891 AVRC_MEDIA_ATTRIBUTE_PLAYING_TIME, 892 // BIP Image Handle. 893 AVRC_MEDIA_ATTRIBUTE_DEFAULT_COVER_ART, 894 // Reserved for future use. 895 AVRC_MEDIA_ATTRIBUTE_RESERVED, 896 }; 897 898 /** 899 * @brief This enumeration declares the values of the major player type. 900 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.1 Media player item - Major Player Type 901 * 902 * @since 6 903 */ 904 enum AvrcMediaMajorPlayerType : uint8_t { 905 AVRC_MEDIA_MAJOR_PLAYER_TYPE_AUDIO = 0x01, // Audio. 906 AVRC_MEDIA_MAJOR_PLAYER_TYPE_VIDEO = 0x02, // Video. 907 AVRC_MEDIA_MAJOR_PLAYER_TYPE_BROADCASTING_AUDIO = 0x04, // Broadcasting Audio. 908 AVRC_MEDIA_MAJOR_PLAYER_TYPE_BROADCASTING_VIDEO = 0x08, // Broadcasting Video. 909 AVRC_MEDIA_MAJOR_PLAYER_TYPE_RESERVED = 0x10 // Reserved for future use. 910 }; 911 912 /** 913 * @brief This enumeration declares the values of the major player type. 914 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.1 Media player item - Player Sub Type 915 * 916 * @since 6 917 */ 918 enum AvrcMediaPlayerSubType : uint32_t { 919 AVRC_MEDIA_PLAYER_SUB_TYPE_AUDIO_BOOK = 0x00000001, // Audio Book. 920 AVRC_MEDIA_PLAYER_SUB_TYPE_PODCAST = 0x00000002, // Pod cast. 921 AVRC_MEDIA_PLAYER_SUB_TYPE_RESERVED = 0x00000004 // Reserved for future use. 922 }; 923 924 /** 925 * @brief This enumeration declares the values of character set. 926 * 927 * @since 6 928 */ 929 enum AvrcMediaCharacterSet : uint16_t { 930 AVRC_MEDIA_CHARACTER_SET_UTF8 = 0x006A, // The value of UTF-8 as defined in IANA character set document. 931 }; 932 933 /** 934 * @brief This enumeration declares the values of the folder type. 935 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.2 Folder item - Folder Type 936 * 937 * @since 6 938 */ 939 enum AvrcMediaFolderType : uint8_t { 940 AVRC_MEDIA_FOLDER_TYPE_MIXED = 0x00, // Mixed. 941 AVRC_MEDIA_FOLDER_TYPE_TITLES, // Titles. 942 AVRC_MEDIA_FOLDER_TYPE_ALBUMS, // Albums. 943 AVRC_MEDIA_FOLDER_TYPE_ARTISTS, // Artists. 944 AVRC_MEDIA_FOLDER_TYPE_GENRES, // Genres. 945 AVRC_MEDIA_FOLDER_TYPE_PLAY_LISTS, // Play lists. 946 AVRC_MEDIA_FOLDER_TYPE_YEARS, // Years. 947 AVRC_MEDIA_FOLDER_TYPE_RESERVED, // Reserved for future use. 948 }; 949 950 /** 951 * @brief This enumeration declares the values of the is playable. 952 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.2 Folder item - Is Playable 953 * 954 * @since 6 955 */ 956 enum AvrcMediaFolderPlayable : uint8_t { 957 // The folder cannot be played. This means that the folder UID shall not be passed to either the PlayItem or 958 // AddToNowPlaying commands. 959 AVRC_MEDIA_FOLDER_PLAYABLE_NO = 0x00, 960 // The folder can be played. The folder UID may be passed to the PlayItem and AddToNowPlaying(if supported) 961 // commands. The media player behavior on playing a folder should be same as on the local user interface. 962 AVRC_MEDIA_FOLDER_PLAYABLE_YES, 963 AVRC_MEDIA_FOLDER_PLAYABLE_RESERVED, // Reserved for future use. 964 }; 965 966 /** 967 * @brief This enumeration declares the values of the media type. 968 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.3 Media element item - Media Type 969 * 970 * @since 6 971 */ 972 enum AvrcMediaElementType : uint8_t { 973 AVRC_MEDIA_ELEMENT_TYPE_AUDIO = 0x00, // Audio. 974 AVRC_MEDIA_ELEMENT_TYPE_VIDEO, // Video. 975 AVRC_MEDIA_ELEMENT_TYPE_RESERVED, // Reserved for future use. 976 }; 977 978 /** 979 * @brief This enumeration declares the values of the media type. 980 * 981 * @details An Absolute Volume is represented in one octet. The top bit (bit 7) is reserved for future addition (RFA). 982 * The volume is specified as a percentage of the maximum. The value 0x0 corresponds to 0%. The value 0x7F corresponds 983 * to 100%. Scaling should be applied to achieve values between these two. The existence of this scale does not impose 984 * any restriction on the granularity of the volume control scale on the TG. 985 * @see Audio/Video Remote Control 1.6.2 Section 6.13.1 Absolute Volume 986 * 987 * @since 6 988 */ 989 enum AvrcAbsoluteVolume : uint8_t { 990 AVRC_ABSOLUTE_VOLUME_PERCENTAGE_0 = 0x00, // 0% 991 AVRC_ABSOLUTE_VOLUME_PERCENTAGE_100 = 0x7F, // 100% 992 AVRC_ABSOLUTE_VOLUME_INVALID = 0x80, 993 }; 994 995 /** 996 * @brief This enumeration declares the values of the "EVENT ID". 997 * @see Audio/Video Remote Control 1.6.2 Section 28 Appendix H: list of defined notification events. 998 * 999 * @since 6 1000 */ 1001 enum AvrcEventId : uint8_t { 1002 AVRC_EVENT_ID_PLAYBACK_STATUS_CHANGED = 0x01, // Change in playback status of the current track. 1003 AVRC_EVENT_ID_TRACK_CHANGED, // Change of current track. 1004 AVRC_EVENT_ID_TRACK_REACHED_END, // Reached end of a track. 1005 AVRC_EVENT_ID_TRACK_REACHED_START, // Reached start of a track. 1006 // Change in playback position. Returned after the specified playback notification change notification interval. 1007 AVRC_EVENT_ID_PLAYBACK_POS_CHANGED, 1008 AVRC_EVENT_ID_BATT_STATUS_CHANGED, // Change in battery status. 1009 AVRC_EVENT_ID_SYSTEM_STATUS_CHANGED, // Change in system status. 1010 AVRC_EVENT_ID_PLAYER_APPLICATION_SETTING_CHANGED, // Change in player application setting. 1011 AVRC_EVENT_ID_NOW_PLAYING_CONTENT_CHANGED, // The content of the Now Playing list has changed. 1012 AVRC_EVENT_ID_AVAILABLE_PLAYERS_CHANGED, // The available players have changed 1013 AVRC_EVENT_ID_ADDRESSED_PLAYER_CHANGED, // The Addressed Player has been changed. 1014 AVRC_EVENT_ID_UIDS_CHANGED, // The UIDs have changed. 1015 AVRC_EVENT_ID_VOLUME_CHANGED, // The volume has been changed locally on the TG. 1016 AVRC_EVENT_ID_RESERVED = 0x0E, 1017 }; 1018 1019 /** 1020 * @bUnique identifier to identify an element on TG 1021 * 1022 * @since 6 1023 */ 1024 enum AvrcElementIdentifier : uint64_t { 1025 AVRC_ELEMENT_ATTRIBUTES_IDENTIFIER_PLAYING = 1026 0x0000000000000000, // attribute information for the element which is current track in the TG device. 1027 AVRC_ELEMENT_ATTRIBUTES_IDENTIFIER_RESERVED = 1028 0x0000000000000001, // All other values other than 0x0 are currently reserved. 1029 }; 1030 1031 /** 1032 * @brief This enumeration declares the allowed values for GetCapabilities Command. 1033 * 1034 * @since 6 1035 */ 1036 enum AvrcCapabilityId : uint8_t { 1037 AVRC_CAPABILITY_COMPANYID = 0x02, // The list of CompanyID supported by TG. 1038 AVRC_CAPABILITY_EVENTID = 0x03, // EventIDs defined in this specification to be supported by TG. 1039 }; 1040 1041 /** 1042 * @brief This enumeration declares the values of playback interval in seconds. 1043 * 1044 * @since 6 1045 */ 1046 enum AvrcPlaybackInterval : uint8_t { 1047 AVRC_PLAYBACK_INTERVAL_1_SEC = 0x01, 1048 AVRC_PLAYBACK_INTERVAL_5_SEC = 0x05, 1049 AVRC_PLAYBACK_INTERVAL_10_SEC = 0x0A, 1050 AVRC_PLAYBACK_INTERVAL_15_SEC = 0x0F, 1051 AVRC_PLAYBACK_INTERVAL_20_SEC = 0x14, 1052 AVRC_PLAYBACK_INTERVAL_25_SEC = 0x19, 1053 AVRC_PLAYBACK_INTERVAL_30_SEC = 0x1E, 1054 }; 1055 1056 /** 1057 * @brief This enumeration declares the error / status code of the vendor dependent command frame and the browsing 1058 * command frame. 1059 * 1060 * @since 6 1061 */ 1062 enum AvrcEsCode : uint8_t { 1063 AVRC_ES_CODE_INVALID = 0xFF, // Reserved. 1064 // Invalid command, sent if TG received a PDU that it did not understand. 1065 AVRC_ES_CODE_INVALID_COMMAND = 0x00, 1066 // Invalid parameter, sent if the TG received a PDU with a parameter ID that it did not understand. This error code 1067 // applies to the following identifiers : 1068 // PDU ID. 1069 // Capability ID. 1070 // Event ID. 1071 // Player Application Setting Attribute ID. 1072 // Player Application Setting Value ID. 1073 // Element Attribute ID. 1074 AVRC_ES_CODE_INVALID_PARAMETER = 0x01, 1075 // Parameter content error.Sent if the parameter ID is understood, but content is wrong or corrupted. 1076 AVRC_ES_CODE_PARAMETER_CONTENT_ERROR = 0x02, 1077 // Internal Error - sent if there are error conditions not covered by a more specific error code. 1078 AVRC_ES_CODE_INTERNAL_ERROR = 0x03, 1079 // Operation completed without error.This is the status that should be returned if the operation was successful. 1080 AVRC_ES_CODE_NO_ERROR = 0x04, 1081 // UID Changed - The UIDs on the device have changed. 1082 AVRC_ES_CODE_UID_CHANGED = 0x05, 1083 // Reserved. 1084 AVRC_ES_CODE_RESERVED = 0x06, 1085 // Invalid Direction - The Direction parameter is invalid. 1086 AVRC_ES_CODE_INVALID_DIRECTION = 0x07, 1087 // Not a Directory - The UID provided does not refer to a folder item. 1088 AVRC_ES_CODE_NOT_A_DIRECTORY = 0x08, 1089 // Does Not Exist - The UID provided does not refer to any currently valid item. 1090 AVRC_ES_CODE_DOES_NOT_EXIST = 0x09, 1091 // Invalid Scope - The scope parameter is invalid. 1092 AVRC_ES_CODE_INVALID_SCOPE = 0x0A, 1093 // Range Out of Bounds - The start of range provided is not valid. 1094 AVRC_ES_CODE_RANGE_OUT_OF_BOUNDS = 0x0B, 1095 // Folder Item is not playable - The UID provided refers to a folder item which cannot be handled by this media 1096 // player. 1097 AVRC_ES_CODE_FOLDER_ITEM_IS_NOT_PLAYABLE = 0x0C, 1098 // Media in Use - The media is not able to be used for this operation at this time. 1099 AVRC_ES_CODE_MEDIA_IN_USE = 0x0D, 1100 // Now Playing List Full - No more items can be added to the Now Playing List. 1101 AVRC_ES_CODE_NOW_PLAYING_LIST_FULL = 0x0E, 1102 // Search Not Supported - The Browsed Media Player does not support search. 1103 AVRC_ES_CODE_SEARCH_NOT_SUPPORTED = 0x0F, 1104 // Search in Progress - A search operation is already in progress. 1105 AVRC_ES_CODE_SEARCH_IN_PROGRESS = 0x10, 1106 // Invalid Player Id - The specified Player Id does not refer to a valid player. 1107 AVRC_ES_CODE_INVALID_PLAYER_ID = 0x11, 1108 // Player Not Browsable - The Player Id supplied refers to a Media Player which does not support browsing. 1109 AVRC_ES_CODE_PLAYER_NOT_BROWSABLE = 0x12, 1110 // Player Not Addressed.The Player Id supplied refers to a player which is not currently addressed, and the command 1111 // is not able to be performed if the player is not set as addressed. 1112 AVRC_ES_CODE_PLAYER_NOT_ADDRESSED = 0x13, 1113 // No valid Search Results - The Search result list does not contain valid entries, e.g.after being invalidated due 1114 // to change of browsed player. 1115 AVRC_ES_CODE_NO_VALID_SEARCH_RESULTS = 0x14, 1116 // No available players. 1117 AVRC_ES_CODE_NO_AVAILABLE_PLAYERS = 0x15, 1118 // Addressed Player Changed. 1119 AVRC_ES_CODE_ADDRESSED_PLAYER_CHANGED = 0x16, 1120 1121 // User custom error code. 1122 AVRC_ES_CODE_NOTIFICATION_CHANGED = 0xFF, 1123 }; 1124 1125 /********************************************* 1126 * 1127 * HFP Definitions 1128 * 1129 *********************************************/ 1130 /** 1131 * @brief sco connect state define 1132 * use to notify sco connection observers. 1133 */ 1134 enum class HfpScoConnectState : int { SCO_DISCONNECTED = 3, SCO_CONNECTING, SCO_DISCONNECTING, SCO_CONNECTED }; 1135 1136 /********************************************* 1137 * 1138 * A2DP Definitions 1139 * 1140 *********************************************/ 1141 1142 /** 1143 * @brief a2dp optional codec support state define 1144 * 1145 * @since 6 1146 */ 1147 enum A2DP_OPTIONAL_SUPPORT_STATE { 1148 A2DP_OPTIONAL_NOT_SUPPORT, 1149 A2DP_OPTIONAL_SUPPORT, 1150 A2DP_OPTIONAL_SUPPORT_UNKNOWN, 1151 }; 1152 1153 /** 1154 * @brief a2dp optional codec enable state define 1155 * 1156 * @since 6 1157 */ 1158 enum A2DP_OPTIONAL_ENABLE_STATE { A2DP_OPTIONAL_DISABLE, A2DP_OPTIONAL_ENABLE, A2DP_OPTIONAL_ENABLE_UNKNOWN }; 1159 1160 /** 1161 * @brief a2dp playing state define 1162 * 1163 * @since 6 1164 */ 1165 enum A2DP_PLAYING_STATE { A2DP_NOT_PLAYING, A2DP_IS_PLAYING }; 1166 1167 /** 1168 * @brief A2dp codec type enum. 1169 * 1170 * @since 6 1171 1172 */ 1173 enum A2dpUserCodecType : uint8_t { 1174 A2DP_CODEC_TYPE_SBC_USER = 0, 1175 A2DP_CODEC_TYPE_MPEG1_USER = 0x01, 1176 A2DP_CODEC_TYPE_AAC_USER = 0x01 << 1, 1177 A2DP_CODEC_TYPE_ATRAC_USER = 0x01 << 2, 1178 A2DP_CODEC_TYPE_NONA2DP_USER = 0xFF 1179 }; 1180 1181 /** 1182 * @brief A2dp codec priority enum. 1183 * 1184 * @since 6 1185 */ 1186 enum A2dpUserCodecPriority : uint32_t { 1187 A2DP_CODEC_PRIORITY_DISABLED_USER = 0, 1188 A2DP_CODEC_PRIORITY_DEFAULT_USER, 1189 A2DP_CODEC_PRIORITY_HIGHEST_USER = 1000 * 1000, 1190 }; 1191 1192 /** 1193 * @brief A2dp codec sample rate enum. 1194 * 1195 * @since 6 1196 */ 1197 enum A2dpUserCodecSampleRate : uint32_t { 1198 A2DP_SAMPLE_RATE_NONE_USER = 0x0, 1199 A2DP_SBC_SAMPLE_RATE_48000_USER = 0x1 << 4, /* octet0 b4 */ 1200 A2DP_SBC_SAMPLE_RATE_44100_USER = 0x1 << 5, /* octet0 b5 */ 1201 A2DP_SBC_SAMPLE_RATE_32000_USER = 0x1 << 6, /* octet0 b6 */ 1202 A2DP_SBC_SAMPLE_RATE_16000_USER = 0x1 << 7, /* octet0 b7 */ 1203 A2DP_SBC_SAMPLE_RATE_MSK_USER = 0xF0, 1204 A2DP_AAC_SAMPLE_RATE_OCTET1_44100_USER = 0x01, 1205 A2DP_AAC_SAMPLE_RATE_OCTET1_32000_USER = 0x01 << 1, 1206 A2DP_AAC_SAMPLE_RATE_OCTET1_24000_USER = 0x01 << 2, 1207 A2DP_AAC_SAMPLE_RATE_OCTET1_22050_USER = 0x01 << 3, 1208 A2DP_AAC_SAMPLE_RATE_OCTET1_16000_USER = 0x01 << 4, 1209 A2DP_AAC_SAMPLE_RATE_OCTET1_12000_USER = 0x01 << 5, 1210 A2DP_AAC_SAMPLE_RATE_OCTET1_11025_USER = 0x01 << 6, 1211 A2DP_AAC_SAMPLE_RATE_OCTET1_8000_USER = 0x01 << 7, 1212 A2DP_AAC_SAMPLE_RATE_OCTET1_MSK_USER = 0xFF, 1213 A2DP_AAC_SAMPLE_RATE_OCTET2_96000_USER = 0x01 << 12, 1214 A2DP_AAC_SAMPLE_RATE_OCTET2_88200_USER = 0x01 << 13, 1215 A2DP_AAC_SAMPLE_RATE_OCTET2_64000_USER = 0x01 << 14, 1216 A2DP_AAC_SAMPLE_RATE_OCTET2_48000_USER = 0x01 << 15, 1217 A2DP_AAC_SAMPLE_RATE_OCTET2_MSK_USER = 0xF0, 1218 }; 1219 1220 /** 1221 * @brief A2dp codec channel mode enum. 1222 * 1223 * @since 6 1224 */ 1225 enum A2dpUserCodecChannelMode : uint8_t { 1226 A2DP_CHANNEL_MODE_NONE_USER = 0x0, 1227 A2DP_SBC_CHANNEL_MODE_JOINT_STEREO_USER = 0x1, /* octet0 b0 */ 1228 A2DP_SBC_CHANNEL_MODE_STEREO_USER = 0x1 << 1, /* octet0 b1 */ 1229 A2DP_SBC_CHANNEL_MODE_DUAL_USER = 0x1 << 2, /* octet0 b2 */ 1230 A2DP_SBC_CHANNEL_MODE_MONO_USER = 0x1 << 3, /* octet0 b3 */ 1231 A2DP_SBC_CHANNEL_MODE_MSK_USER = 0x0F, 1232 A2DP_AAC_CHANNEL_MODE_OCTET2_DOUBLE_USER = 0x01 << 2, /* octet2 b2 */ 1233 A2DP_AAC_CHANNEL_MODE_OCTET2_SINGLE_USER = 0x01 << 3, /* octet2 b3 */ 1234 A2DP_AAC_CHANNEL_MODE_OCTET2_MSK_USER = 0x0C, 1235 }; 1236 1237 /** 1238 * @brief A2dp codec bits per sample enum. 1239 * 1240 * @since 6 1241 */ 1242 enum A2dpUserCodecBitsPerSample : uint8_t { 1243 A2DP_SAMPLE_BITS_NONE_USER = 0x0, 1244 A2DP_SAMPLE_BITS_16_USER = 0x1 << 0, 1245 A2DP_SAMPLE_BITS_24_USER = 0x1 << 1, 1246 A2DP_SAMPLE_BITS_32_USER = 0x1 << 2, 1247 A2DP_SAMPLE_BITS_MSK_USER = 0x06, 1248 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT0_USER = 0x01, /* octet3 b0 */ 1249 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT1_USER = 0x01 << 1, /* octet3 b1 */ 1250 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT2_USER = 0x01 << 2, /* octet3 b2 */ 1251 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT3_USER = 0x01 << 3, /* octet3 b3 */ 1252 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT4_USER = 0x01 << 4, /* octet3 b4 */ 1253 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT5_USER = 0x01 << 5, /* octet3 b5 */ 1254 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT6_USER = 0x01 << 6, /* octet3 b6 */ 1255 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT0_USER = 0x01, /* octet4 b0 */ 1256 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT1_USER = 0x01 << 1, /* octet4 b1 */ 1257 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT2_USER = 0x01 << 2, /* octet4 b2 */ 1258 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT3_USER = 0x01 << 3, /* octet4 b3 */ 1259 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT4_USER = 0x01 << 4, /* octet4 b4 */ 1260 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT5_USER = 0x01 << 5, /* octet4 b5 */ 1261 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT6_USER = 0x01 << 6, /* octet4 b6 */ 1262 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT7_USER = 0x01 << 7, /* octet4 b6 */ 1263 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT0_USER = 0x01, /* octet5 b0 */ 1264 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT1_USER = 0x01 << 1, /* octet5 b1 */ 1265 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT2_USER = 0x01 << 2, /* octet5 b2 */ 1266 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT3_USER = 0x01 << 3, /* octet5 b3 */ 1267 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT4_USER = 0x01 << 4, /* octet5 b4 */ 1268 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT5_USER = 0x01 << 5, /* octet5 b5 */ 1269 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT6_USER = 0x01 << 6, /* octet5 b6 */ 1270 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT7_USER = 0x01 << 7, /* octet5 b6 */ 1271 }; 1272 1273 /** 1274 * @brief Pbap action Type. 1275 * 1276 * @since 6 1277 */ 1278 enum PbapActionType : uint16_t { 1279 PBAP_ACTION_PULLPHONEBOOKSIZE, // pull phonebooksize 1280 PBAP_ACTION_PULLPHONEBOOK, // pull phonebook 1281 PBAP_ACTION_SETPHONEBOOK, // set phonebook 1282 PBAP_ACTION_PULLVCARDLISTINGSIZE, // pull vcard listing size 1283 PBAP_ACTION_PULLVCARDLISTING, // pull vcard listing 1284 PBAP_ACTION_PULLVCARDENTRY, // pull vcard entry 1285 PBAP_ACTION_ABORT, // abort downloading 1286 }; 1287 1288 // PBAP_PHONEBOOK_NAME 1289 #define PBAP_PHONEBOOK_PB u"/telecom/pb.vcf" 1290 #define PBAP_PHONEBOOK_ICH u"/telecom/ich.vcf" 1291 #define PBAP_PHONEBOOK_OCH u"/telecom/och.vcf" 1292 #define PBAP_PHONEBOOK_MCH u"/telecom/mch.vcf" 1293 #define PBAP_PHONEBOOK_CCH u"/telecom/cch.vcf" 1294 #define PBAP_PHONEBOOK_SPD u"/telecom/spd.vcf" 1295 #define PBAP_PHONEBOOK_FAV u"/telecom/fav.vcf" 1296 #define PBAP_PHONEBOOK_PB1 u"/SIM1/telecom/pb.vcf" 1297 #define PBAP_PHONEBOOK_ICH1 u"/SIM1/telecom/ich.vcf" 1298 #define PBAP_PHONEBOOK_OCH1 u"/SIM1/telecom/och.vcf" 1299 #define PBAP_PHONEBOOK_MCH1 u"/SIM1/telecom/mch.vcf" 1300 #define PBAP_PHONEBOOK_CCH1 u"/SIM1/telecom/cch.vcf" 1301 1302 enum PbapOrderType : uint8_t { 1303 PBAP_ORDER_INDEXED = 0x00, // indexed order 1304 PBAP_ORDER_ALPHANUMERIC = 0x01, // alphabetical order 1305 PBAP_ORDER_PHONETIC = 0x02, // phonetic order 1306 }; 1307 1308 enum PbapFormatType : uint8_t { 1309 PBAP_FORMAT_VCARD2_1 = 0x00, // vCard Version 1310 PBAP_FORMAT_VCARD3_0 = 0x01, // vCard Version 1311 }; 1312 1313 // 5.1.4.1 PropertySelector {PropertyMask (64-bit value)} 1314 #define PBAP_PROPERTY_VERSION (1ULL << 0) // vCard Version 1315 #define PBAP_PROPERTY_FN (1ULL << 1) // Formatted Name 1316 #define PBAP_PROPERTY_N (1ULL << 2) // Structured Presentation of Name 1317 #define PBAP_PROPERTY_PHOTO (1ULL << 3) // Associated Image or Photo 1318 #define PBAP_PROPERTY_BDAY (1ULL << 4) // Birthday 1319 #define PBAP_PROPERTY_ADR (1ULL << 5) // Delivery Address 1320 #define PBAP_PROPERTY_LABEL (1ULL << 6) // Delivery 1321 #define PBAP_PROPERTY_TEL (1ULL << 7) // Telephone Number 1322 #define PBAP_PROPERTY_EMAIL (1ULL << 8) // Electronic Mail Address 1323 #define PBAP_PROPERTY_MAILER (1ULL << 9) // Electronic Mail 1324 #define PBAP_PROPERTY_TZ (1ULL << 10) // Time Zone 1325 #define PBAP_PROPERTY_GEO (1ULL << 11) // Geographic Position 1326 #define PBAP_PROPERTY_TITLE (1ULL << 12) // Job 1327 #define PBAP_PROPERTY_ROLE (1ULL << 13) // Role within the Organization 1328 #define PBAP_PROPERTY_LOGO (1ULL << 14) // Organization Logo 1329 #define PBAP_PROPERTY_AGENT (1ULL << 15) // vCard of Person Representing 1330 #define PBAP_PROPERTY_ORG (1ULL << 16) // Name of Organization 1331 #define PBAP_PROPERTY_NOTE (1ULL << 17) // Comments 1332 #define PBAP_PROPERTY_REV (1ULL << 18) // Revision 1333 #define PBAP_PROPERTY_SOUND (1ULL << 19) // Pronunciation of Name 1334 #define PBAP_PROPERTY_URL (1ULL << 20) // Uniform Resource Locator 1335 #define PBAP_PROPERTY_UID (1ULL << 21) // Unique ID 1336 #define PBAP_PROPERTY_KEY (1ULL << 22) // Public Encryption Key 1337 #define PBAP_PROPERTY_NICKNAME (1ULL << 23) // Nickname 1338 #define PBAP_PROPERTY_CATEGORIES (1ULL << 24) // Categories 1339 #define PBAP_PROPERTY_PROID (1ULL << 25) // Product ID 1340 #define PBAP_PROPERTY_CLASS (1ULL << 26) // Class information 1341 #define PBAP_PROPERTY_SORT_STRING (1ULL << 27) // String used for sorting operations 1342 #define PBAP_PROPERTY_X_IRMC_CALL_DATETIME (1ULL << 28) // Time stamp 1343 #define PBAP_PROPERTY_X_BT_SPEEDDIALKEY (1ULL << 29) // Speed-dial shortcut 1344 #define PBAP_PROPERTY_X_BT_UCI (1ULL << 30) // Uniform Caller Identifier 1345 #define PBAP_PROPERTY_X_BT_UID (1ULL << 31) // Bluetooth Contact Unique Identifier 1346 #define PBAP_PROPERTY_PROPRIENTARY_FILTER (1ULL << 39) // Bluetooth Proprientary 1347 1348 enum PbapSelectorOperatorType : uint8_t { 1349 PBAP_SELECTOR_OPERATOR_OR = 0x00, // SelectorOperator Or 1350 PBAP_SELECTOR_OPERATOR_AND = 0x01, // SelectorOperator And 1351 }; 1352 1353 enum PbapSearchPropertyType : uint8_t { 1354 PBAP_SEARCH_PROPERTY_NAME = 0x00, // name 1355 PBAP_SEARCH_PROPERTY_NUMBER = 0x01, // number 1356 PBAP_SEARCH_PROPERTY_SOUND = 0x02, // sound 1357 }; 1358 1359 const uint8_t PBAP_FLAG_GO_TO_ROOT = 0x02; // go back to root 1360 const uint8_t PBAP_FLAG_GO_DOWN = 0x02; // go down 1361 const uint8_t PBAP_FLAG_GO_UP = 0x03; // go up 1362 1363 enum PbapResponseCode : uint8_t { 1364 PBAP_CONTINUE = 0x90, // 100 Continue 1365 PBAP_SUCCESS = 0xA0, // 200 OK, Success 1366 PBAP_CREATED = 0xA1, // 201 Created 1367 PBAP_PBAP_ACCEPTED = 0xA2, // 202 Accepted 1368 PBAP_NON_AUTH = 0xA3, // 203 Non-Authoritative Information 1369 PBAP_NO_CONTENT = 0xA4, // 204 No Content 1370 PBAP_RESET_CONTENT = 0xA5, // 205 Reset Content 1371 PBAP_PARTIAL_CONTENT = 0xA6, // 206 Partial Content 1372 PBAP_MULTIPLE_CHOICES = 0xB0, // 300 Multiple Choices 1373 PBAP_MOVED_PERMANENTLY = 0xB1, // 301 Moved Permanently 1374 PBAP_MOVED_TEMPORARILY = 0xB2, // 302 Moved temporarily 1375 PBAP_SEE_OTHER = 0xB3, // 303 See Other 1376 PBAP_NOT_MODIFIED = 0xB4, // 304 Not modified 1377 PBAP_USE_PROXY = 0xB5, // 305 Use Proxy 1378 PBAP_BAD_REQUEST = 0xC0, // 400 Bad Request - server couldn’t understand request 1379 PBAP_UNAUTHORIZED = 0xC1, // 401 Unauthorized 1380 PBAP_PAYMENT_REQUIRED = 0xC2, // 402 Payment required 1381 PBAP_FORBIDDEN = 0xC3, // 403 Forbidden - operation is understood but refused 1382 PBAP_NOT_FOUND = 0xC4, // 404 Not Found 1383 PBAP_METHOD_NOT_ALLOWED = 0xC5, // 405 Method not allowed 1384 PBAP_NOT_ACCEPTABLE = 0xC6, // 406 Not Acceptable 1385 PBAP_PROXY_AUTH_REQUIRED = 0xC7, // 407 Proxy Authentication required 1386 PBAP_REQUEST_TIME_OUT = 0xC8, // 408 Request Time Out 1387 PBAP_CONFLICT = 0xC9, // 409 Conflict 1388 PBAP_GONE = 0xCA, // 410 Gone 1389 PBAP_LENGTH_REQUIRED = 0xCB, // 411 Length Required 1390 PBAP_PRECONDITION_FAILED = 0xCC, // 412 Precondition failed 1391 PBAP_REQUESTED_ENTITY_TOO_LARGE = 0xCD, // 413 Requested entity too large 1392 PBAP_REQUEST_URL_TOO_LARGE = 0xCE, // 414 Request URL too large 1393 PBAP_UNSUPPORTED_MEDIA_TYPE = 0xCF, // 415 Unsupported media type 1394 PBAP_INTERNAL_SERVER_ERROR = 0xD0, // 500 Internal Server Error 1395 PBAP_NOT_IMPLEMENTED = 0xD1, // 501 Not Implemented 1396 PBAP_BAD_GATEWAY = 0xD2, // 502 Bad Gateway 1397 PBAP_SERVICE_UNAVAILABLE = 0xD3, // 503 Service Unavailable 1398 PBAP_GATEWAY_TIMEOUT = 0xD4, // 504 Gateway Timeout 1399 PBAP_HTTP_VERSION_NOT_SUPPORTED = 0xD5, // 505 HTTP version not supported 1400 PBAP_DATABASE_FULL = 0xE0, // Database Full 1401 PBAP_DATABASE_LOCKED = 0xE1 // Database Locked 1402 }; 1403 1404 #ifdef BLUETOOTH_EXPORT 1405 #define BLUETOOTH_API __attribute__((visibility("default"))) 1406 #else 1407 #define BLUETOOTH_API 1408 #endif 1409 } // namespace bluetooth 1410 } // namespace OHOS 1411 #endif // BT_DEF_H 1412