| const TInt | KMinESCOLatency | [static] |
Minimum eSCO connection latency in milliseconds. Attempts to specify less than this will be silently increased to this level.
Bluetooth SIG specified values for specification of (piconet) role.
| Enumerator | Value | Description |
|---|---|---|
| EMaster | 0x00 |
Master role |
| ESlave | 0x01 |
Slave role |
| ERoleUnknown |
Unknown role |
Bluetooth SIG specified values for indicating link modes.
| Enumerator | Value | Description |
|---|---|---|
| EActiveMode | 0x00 |
Active mode |
| EHoldMode | 0x01 |
Hold mode |
| ESniffMode | 0x02 |
Sniff mode |
| EParkMode | 0x04 |
Park mode |
| EScatterMode | 0x08 |
Scatter mode |
| typedef TUint32 | TBTLinkModeSet |
Typedef to represent a union of TBTLinkMode values.
Bitmask values to help request combinations of link modes.
See also: TBTLinkMode
| Enumerator | Value | Description |
|---|---|---|
| EAnyLowPowerMode | (EHoldMode | ESniffMode | EParkMode | EScatterMode) |
Any low power mode |
Bluetooth SIG specified values for indicating packet types.
DM1, DH1, DM3, DH3, DM5, DH5 are ACL packet types HV1, HV2, HV3 are SCO (synchronous link) packet types
| Enumerator | Value | Description |
|---|---|---|
| EPacketsDM1 | 0x0008 |
DM1 ACL packet type |
| EPacketsDH1 | 0x0010 |
DH1 ACL packet type |
| EPacketsDM3 | 0x0400 |
DM3 ACL packet type |
| EPacketsDH3 | 0x0800 |
DH3 ACL packet type |
| EPacketsDM5 | 0x4000 |
DM5 ACL packet type |
| EPacketsDH5 | 0x8000 |
DH5 ACL packet type |
| EPackets2_DH1 | 0x0002 |
2-DH1 ACL packet type |
| EPackets3_DH1 | 0x0004 |
3-DH1 ACL packet type |
| EPackets2_DH3 | 0x0100 |
2-DH3 ACL packet type |
| EPackets3_DH3 | 0x0200 |
3-DH3 ACL packet type |
| EPackets2_DH5 | 0x1000 |
2-DH5 ACL packet type |
| EPackets3_DH5 | 0x2000 |
3-DH5 ACL packet type |
| EPacketsHV1 | 0x0020 |
HV1 SCO packet type |
| EPacketsHV2 | 0x0040 |
HV2 SCO packet type |
| EPacketsHV3 | 0x0080 |
HV3 SCO packet type |
Bitmask values to help request combinations of packets.
See also: TBTPacketType
| Enumerator | Value | Description |
|---|---|---|
| EAnyACLPacket | EPacketsDM1 | EPacketsDM3 | EPacketsDM5 | EPacketsDH1 | EPacketsDH3 | EPacketsDH5 |
Any ACL packet |
| EAnyNonEdrACLPacket | EAnyACLPacket | EPackets2_DH1 | EPackets3_DH1 | EPackets2_DH3 | EPackets3_DH3 | EPackets2_DH5 | EPackets3_DH5 |
Any Non-EDR ACL packet |
| EAnySCOPacket | EPacketsHV1 | EPacketsHV2 | EPacketsHV3 |
Any SCO packet |
| EAnyPacket | EAnyACLPacket | EAnySCOPacket |
Any packet |
| typedef TUint32 | TBTSyncPacketTypes |
Typedef to represent a set of synchronous packet types (SCO and eSCO on v1.2).
See also: TBTSyncPackets::TSyncPackets
| const TInt | KSCOvsSyncHVOffset | [static] |
Deprecated
This constant is no longer needed to translate the SCO mapping of HV packet types to Synchronous because CBluetoothSynchronousLink::SetupConnection(const TBTDevAddr& aBDAddr, const TUint16 aPacketTypes) adjusts aPacketTypes internally on behalf of clients.
| NONSHARABLE_CLASS | ( | TBTSyncPackets | ) |
Class to represent a set of synchronous packet types (SCO and eSCO on v1.2). This differs from TBTSyncPacketTypes as it is the interface used by CBluetoothSynchronousLink in order to detect the difference between a pre and post eSCO caller. This is necessary as HV1 packets in the SCO numbering clash with EV5 packets in the sync numbering.
eSCO links can have different retransmission options, optimised for link usage, power or reliability.
See also: CBluetoothSynchronousLink::SetRetransmissionEffort
| Enumerator | Value | Description |
|---|---|---|
| EeSCORetransmitNone | 0 | |
| EeSCORetransmitPower | 1 | |
| EeSCORetransmitReliability | 2 | |
| EeSCORetransmitDontCare | 0xff |
| const TUint32 | KESCOBandwidthDontCare | [static] |
eSCO unspecified bandwidth. This value can only be used by the accepting side of an eSCO link, to allow any bandwidth to be specified by the initiator. Otherwise both sides of the link must agree on the same bandwidth.
See also: CBluetoothSynchronousLink::SetBandwidth CBluetoothSynchronousLink::AcceptConnection
Bluetooth SIG specified values indicating whether a device is physically able to support a baseband (or link manager protocol) feature
| Enumerator | Value | Description |
|---|---|---|
| ESupportedThreeSlotPackets | 1<<0 |
Three slot packets are supported |
| ESupportedFiveSlotPackets | 1<<1 |
Five slot packets are supported |
| ESupportedEncryption | 1<<2 |
Encryption is supported |
| ESupportedSlotOffset | 1<<3 |
Slot offset is supported |
| ESupportedTimingAccuracy | 1<<4 |
Timing accuracy is supported |
| ESupportedSwitch | 1<<5 |
Role switch is supported |
| ESupportedHoldMode | 1<<6 |
Hold mode is supported |
| ESupportedSniffMode | 1<<7 |
Sniff mode is supported |
| ESupportedParkMode | 1<<8 |
Park mode is supported |
| ESupportedRSSI | 1<<9 |
Receive signal strength indication is supported |
| ESupportedChannelQualityDrivenDataRate | 1<<10 |
Channel quality driven data rate is supported |
| ESupportedSCOLink | 1<<11 |
SCO links are supported |
| ESupportedHV2Packets | 1<<12 |
HV2 packets are supported |
| ESupportedHV3Packets | 1<<13 |
HV3 packets are supported |
| ESupportedu_lawLog | 1<<14 |
SCO u-law encoding is supported |
| ESupportedA_lawLog | 1<<15 |
SCO A-law encoding is supported |
| ESupportedCVSD | 1<<16 |
SCO Continuously variable slope delta modulation is supported |
| ESupportedPagingScheme | 1<<17 |
Paging scheme is supported |
| ESupportedPowerControl | 1<<18 |
Power control is supported |
| ESupportedTransparentSCOData | 1<<19 |
Transparent SCO data is supported |
| ESupportedFlowControlLagBit0 | 1<<20 |
Flow control lag bit 0 is supported |
| ESupportedFlowControlLagBit1 | 1<<21 |
Flow control lag bit 1 is supported |
| ESupportedFlowControlLagBit2 | 1<<22 |
Flow control lag bit 2 is supported |
Bitmask values for notifying/requesting notification of the state of a physical link.
These values have a two fold purpose: 1) They can be used along with TBTPhysicalLinkStateNotifierCombinations to specify a set of baseband change events for which notification is desired. 2) They can be used to notify the state of a physical link or a subset of that state. For example if only mode change events are being monitored, then at each mode change event only the bit reperesenting the new mode will be returned, however if the whole link state is required, then a combination of bit values indicating that state will be returned.
THESE BIT VALUES MUST ONLY BE USED WHEN REQUESTING NOTIFICATION, OR WHEN PARSING THE RESULTS OF A NOTIFICATION. All other baseband state activities should use one of the appropriate Bluetooth SIG specified enums
See also: TBTBasebandRole TBTLinkMode TBTLinkModeCombinations TBTPacketType TBTPacketTypeCombinations
| Enumerator | Value | Description |
|---|---|---|
| ENotifyMaster | 0x00000001 |
Master |
| ENotifySlave | 0x00000002 |
Slave |
| ENotifyActiveMode | 0x00000004 |
Active mode |
| ENotifySniffMode | 0x00000008 |
Sniff mode |
| ENotifyParkMode | 0x00000010 |
Park mode |
| ENotifyHoldMode | 0x00000020 |
Hold mode |
| ENotifyMaxSlots1 | 0x00000040 |
Max slots 1 |
| ENotifyMaxSlots3 | 0x00000080 |
Max slots 3 |
| ENotifyMaxSlots5 | 0x00000100 |
Max slots 5 |
| ENotifyPacketsDM1 | 0x00000200 |
Packets DM1 |
| ENotifyPacketsDH1 | 0x00000400 |
Packets DH1 |
| ENotifyPacketsDM3 | 0x00000800 |
Packets DM3 |
| ENotifyPacketsDH3 | 0x00001000 |
Packets DH3 |
| ENotifyPacketsDM5 | 0x00002000 |
Packets DM5 |
| ENotifyPacketsDH5 | 0x00004000 |
Packets DH5 |
| ENotifyPacketsHV1 | 0x00008000 |
HV1 |
| ENotifyPacketsHV2 | 0x00010000 |
HV2 |
| ENotifyPacketsHV3 | 0x00020000 |
HV3 |
| ENotifyAuthenticationComplete | 0x00040000 |
Authentication Complete |
| ENotifyEncryptionChangeOn | 0x00080000 |
Encryption Change On |
| ENotifyEncryptionChangeOff | 0x00100000 |
Encryption Change Off |
| ENotifyPhysicalLinkUp | 0x00200000 |
Physical Link Up |
| ENotifyPhysicalLinkDown | 0x00400000 |
Physical Link Down |
| ENotifyPhysicalLinkError | 0x00800000 |
Physical Link Error |
| ENotifySynchronousLinkUp | 0x01000000 |
Synchronous Link Up |
| ENotifySynchronousLinkDown | 0x02000000 |
Synchronous Link Down |
| ENotifySynchronousLinkError | 0x04000000 |
Synchronous Link Error |
| ENotifySCOLinkUp | ENotifySynchronousLinkUp |
DeprecatedThis has been superseded by ENotifySynchronousLinkUp See also: ENotifySynchronousLinkUp |
| ENotifySCOLinkDown | ENotifySynchronousLinkDown |
DeprecatedThis has been superseded by ENotifySynchronousLinkDown See also: ENotifySynchronousLinkDown |
| ENotifySCOLinkError | ENotifySynchronousLinkError |
DeprecatedThis has been superseded by ENotifySynchronousLinkError See also: ENotifySynchronousLinkError |
Bitmask values to help request notification of the state of a physical link.
See also: TBTPhysicalLinkStateNotifier
| Enumerator | Value | Description |
|---|---|---|
| ENotifyAnyRole | ENotifyMaster | ENotifySlave | |
| ENotifyAnyLowPowerMode | ENotifySniffMode | ENotifyParkMode | ENotifyHoldMode | |
| ENotifyAnyPowerMode | ENotifyActiveMode | ENotifyAnyLowPowerMode | |
| ENotifyAnyMaxSlots | ENotifyMaxSlots1 | ENotifyMaxSlots3 | ENotifyMaxSlots5 | |
| ENotifyAnyACLPacketType | ENotifyPacketsDM1 | ENotifyPacketsDH1 | ENotifyPacketsDM3 | EPacketsDH3 | EPacketsDM5 | EPacketsDH5 | |
| ENotifyAnySCOPacketType | ENotifyPacketsHV1 | ENotifyPacketsHV2 | ENotifyPacketsHV3 | |
| ENotifyAnyPacketType | ENotifyAnyACLPacketType | ENotifyAnySCOPacketType | |
| ENotifyAnyPhysicalLinkState | 0xffffffff |
| NONSHARABLE_CLASS | ( | TBTDevAddr | ) |
48-bit bluetooth device address. Each bluetooth device has a unique address built into the hardware, which is represented by this class. Used for identifying remote addresses. The interface operates in a big-endian manner -- e.g. addr[0] refers to the most significant byte of the address. This is the same ordering as the addresses would naturally be written down on paper.
| typedef RArray< TBTDevAddr > | RBTDevAddrArray |
Array of device addresses
See also: Enumerate method
| NONSHARABLE_CLASS | ( | TUUID | ) |
A Bluetooth Universally Unique Identifier.
This is a 128-bit quantity that can be created without a central registry while still being globally unique. UUIDs are always held in full 128 bit format, however they can be set from BT SIG short form (16 or 32 bit) addresses, and returned as down to their shortest form using ShortestForm().
| NONSHARABLE_CLASS | ( | RUUIDContainer | ) |
A UUID container class
| NONSHARABLE_CLASS | ( | RExtendedInquiryResponseUUIDContainer | ) |
An EIR UUID container class. Contains UUIDs and indications of data completeness
| NONSHARABLE_CLASS | ( | TLinkKeyV10 | ) |
Link key structure.
| typedef TPckgBuf< TLinkKeyV10 > | TBTLinkKey |
Typedef'ed TPckgBuf of the class TLinkKeyV10.
The type of a link key with a remote device
| Enumerator | Value | Description |
|---|---|---|
| ELinkKeyCombination |
this key has been generated with pairing with pre-v2.1 Bluetooth devices. | |
| ELinkKeyUnauthenticatedUpgradable |
this key hasn't yet been tried with MITM protection | |
| ELinkKeyUnauthenticatedNonUpgradable |
this key tried MITM protection; remote device incapable | |
| ELinkKeyAuthenticated |
this key authenticated with MITM protection | |
| ELinkKeyDebug |
this key has been generated when in simple pairing debug mode |
| NONSHARABLE_CLASS | ( | TPINCodeV10 | ) |
Bluetooth PIN Code structure.
| typedef TPckgBuf< TPINCodeV10 > | TBTPinCode |
Typedef'ed TPckgBuf of the class TPINCodeV10.
| NONSHARABLE_CLASS | ( | TBluetoothNameRecordWrapper | ) |
Extended Inquiry Response Class This class takes a reference from inquiry result, which could hold both local name and Extended Inquiry Response. It provides API to parse and return the local name and data for any Extended Inquiry Response tag. To get Device Name, Manufacturer Specific Data or Flags, firstly getting length of the data, and then allocating a suitable buffer, which is where the data will be placed.
| NONSHARABLE_CLASS | ( | TBTBasebandEventNotification | ) |
Contains information resulting from a baseband notification.
| typedef TPckgBuf< TBTBasebandEventNotification > | TBTBasebandEvent |
Typedef'ed pckgbuf of the class TBTBasebandEventNotification.
HCI Scan enable mask
| Enumerator | Value | Description |
|---|---|---|
| ENoScansEnabled | 0x00 |
No scans enabled |
| EInquiryScanOnly | 0x01 |
Inquiry scan enabled |
| EPageScanOnly | 0x02 |
Page scan enabled |
| EInquiryAndPageScan | 0x03 |
Inquiry and page scan enabled |
L2CAP channel modes
| Enumerator | Value | Description |
|---|---|---|
| EL2CAPBasicMode | 0x00 | |
| EL2CAPRetransmissionMode | 0x01 | |
| EL2CAPFlowControlMode | 0x02 | |
| EL2CAPEnhancedRetransmissionMode | 0x03 | |
| EL2CAPStreamingMode | 0x04 |
| NONSHARABLE_CLASS | ( | TL2CapConfig | ) |
API class for setting up an L2Cap channel configuration.
This class may be used to set all or a subset of the following configuration items: Channel Reliability (and associated timer) Maximum Transmission Unit (MTU) value preferred during MTU negotiation Maximum Receive Unit (MRU) value preferred during MRU negotiation Minimum MTU value acceptable during MTU negotiation Minimum MRU value acceptable during MRU negotiation Channel Priority
If a configuration item is to be set, then its 'Set' or 'Configure' method should be called.
Once a TL2CapConfig object has been set up it can be used to configure a socket using RSocket::SetOption or RSocket::Ioctl (or the CBluetoothSocket equivalents).
If the preferred Maximum Transmission Unit (MTU) value is specified but its minimum acceptable value is not specified in the same object, then the minimum acceptable value will be implicitly taken to be equal to the preferred MTU by the L2CAP APIs processing the object. This means that only an MTU greater than or equal to the preferred MTU will be accepted from the peer during negotiation.
If the Maximum Receive Unit (MRU) value is specified but its minimum acceptable value is not, then the minimum acceptable value is implicitly taken to be equal to the protocol minimum (48 bytes) by the L2CAP APIs processing the object.
Note that even though this API allows setting of Obsolescence timer, outgoing packet flushing may not be supported on all hardware.
See also: RSocket CBluetoothSocket
| typedef TPckgBuf< TL2CapConfig > | TL2CapConfigPkg |
Typedef to represent a L2CAP Config object.