TwclBluetoothRadio Class
The class represents a local Bluetooth radio module.
wclBluetooth.TwclBluetoothRadio
The TwclBluetoothRadio type exposes the following members.
| Name | Description | |
|---|---|---|
 | Create(TwclBluetoothManager) | Creates a new radio object. |
| Destroy | Frees the Radio object. |
| Name | Description | |
|---|---|---|
 | Api | Gets a Bluetooth driver (API) supported by this Bluetooth object. |
| ApiName | Gets a supported Bluetooth API name. |
| Available | Gets a Radio hardware state. |
| ClassicSupported | Gets the Classic Bluetooth support status. |
| ComPorts | Gets the array of the created virtual COM ports. |
| Discovering | Gets discovering state. |
 | IncludePaired | Gets the devices discovering modification flag. |
| LeDiscovering | Gets the discovering type flag. |
| LeSupported | Gets the Bluetooth Low Energy support status. |
| Manager | Gets the TwclBluetoothManager object that owns the Radio. |
| PairAddress | Gets the pairing device address for manual pairing. |
| Pairing | Gets a manual pairing state. |
| Plugged | Gets a Radio hardware physical state. |
| Receiver | Gets the message receiver object. |
| Name | Description | |
|---|---|---|
 | CheckAvailable | The method checks that a Bluetooth driver and a hardware is available. |
| CreateComPort(Int64,TGUID,Word) | Creates new virtual COM port. |
| DestroyComPort(Word) | Destroys the virtual COM port. |
| Discover(Byte,TwclBluetoothDiscoverKind,Boolean) | Starts discovering for a remote Bluetooth enabled devices. |
| DoAuthenticationCompleted(Int64,Integer) | Fires the |
| DoConfirm(Int64,Boolean) | Fires the |
| DoDeviceFound(Int64) | Fires the |
| DoDiscoveringCompleted(Integer) | Fires the |
| DoDiscoveringStarted | Fires the |
| DoIoCapabilityRequest(Int64,TwclBluetoothMitmProtection,TwclBluetoothIoCapability,Boolean) | Fires the |
| DoNumericComparison(Int64,Cardinal,Boolean) | Fires the |
| DoOobDataRequest(Int64,TwclBluetoothOobData) | Fires the |
| DoPasskeyNotification(Int64,Cardinal) | Fores the |
| DoPasskeyRequest(Int64,Cardinal) | Fires the |
| DoPinRequest(Int64,string) | Fires the |
| DoProtectionLevelRequest(Int64,TwclBluetoothLeProtectionLevel) | Fires the |
| DoStatusChanged | Fires the |
| EnumComPorts(TwclVirtualComPorts) | Enumerates already installed Bluetooth virtual COM ports. |
| EnumConnectedDevices(TwclBluetoothAddresses) | The method enumerates connected devices. |
| EnumInstalledServices(Int64,TwclBluetoothInstalledServices) | Enumerates services installed for specified Bluetooth device. |
| EnumPairedDevices(TwclBluetoothAddresses) | Overloaded. The method enumerates already paired devices. |
| EnumPairedDevices(TwclBluetoothDiscoverKind,TwclBluetoothAddresses) | Overloaded. The method enumerates already paired devices. |
| EnumRemoteServices(Int64,PGuid,TwclBluetoothServices) | Reads the available services from a remote Bluetooth device. |
| GetAddress(Int64) | Reads the local Bluetooth Radio MAC address. |
| GetCod(Cardinal) | Reads the local Bluetooth Radio Class Of Device (COD). |
| GetConnectable(Boolean) | Read the local Bluetooth Radio connectable state. |
| GetDiscoverable(Boolean) | Read the local Bluetooth Radio discoverable state. |
| GetHciVersion(Byte,Word) | Reads the HCI version of the local Radio module. |
| GetLmpVersion(Byte,Word) | Reads the LMP version of the local Radio module. |
| GetManufacturer(Word) | Reads the Bluetooth Radio manufacturer ID. |
| GetName(string) | Reads the local Radio name. |
| GetRemoteAddressType(Int64,TwclBluetoothAddressType) | Reads a remote device address type. |
| GetRemoteCod(Int64,Cardinal) | Reads a remote device COD (Class Of Device). |
| GetRemoteConnectedStatus(Int64,Boolean) | The function checks if the specified remote device is currently connected. |
| GetRemoteDeviceType(Int64,TwclBluetoothDeviceType) | Read a remote Bluetooth device type. |
| GetRemoteName(Int64,string) | Queries a remote device's name. |
| GetRemotePaired(Int64,Boolean) | Reads a remote Bluetooth device paired status. |
| GetRemoteRssi(Int64,SByte) | Reads RSSI value from a remote device. |
| GetSimplePairingMode(Boolean) | Gets the radio Secure Simple Pairing mode. |
| HalClearFunctions | Implements a driver-dependent code for API functions clearing. |
| HalClearGlobalInstance | Implements a driver-dependent code for clearing the global instance of the Radio object. |
| HalConfirmReply(Int64,Boolean) | Implements a hardware-dependent code to reply on a confirm only pairing request. |
| HalCreateComPort(Int64,TGUID,Word) | Creates new virtual COM port. |
| HalCreateConnection(TwclBluetoothConnectionType,TwclCustomConnection) | Creates a hardware-dependent connection object based on connection type. |
| HalDestroyComPort(Word) | Destroys the virtual COM port. |
| HalDiscoverBle(Byte) | Implements a hardware-dependent code to start discovering for a remote Low Energy Bluetooth devices. |
| HalDiscoverClassic(Byte) | Implements a hardware-dependent code to start discovering for a remote Classic Bluetooth devices. |
| HalEnumComPorts(TwclVirtualComPorts) | Enumerates already installed Bluetooth virtual COM ports. |
| HalEnumConnectedDevices(TwclBluetoothAddresses) | Implements a hardware-dependent code for connected devices enumerating. |
| HalEnumInstalledServices(Int64,TwclBluetoothInstalledServices) | Enumerates services installed for specified Bluetooth device. |
| HalEnumPairedDevices(TwclBluetoothAddresses) | Implements a hardware-dependent code for paired devices enumerating. |
| HalEnumRemoteServices(Int64,PGuid,TwclBluetoothServices) | Implements a hardware-dependent code for reading the available services from a remote Bluetooth device. |
| HalGetAddress(Int64) | Implements a hardware-dependent code for Local Bluetooth Radio module MAC address reading. |
| HalGetApi | Returns a Bluetooth API supported by the Radio object. |
| HalGetApiName | Returns a supported Bluetooth API name. |
| HalGetAvailable | Implements a hardware-dependent code to check a Bluetooth hardware state. |
| HalGetCod(Cardinal) | Implements a hardware-dependent code for Local Bluetooth Radio module Class Of Device (COD) reading. |
| HalGetConnectable(Boolean) | Implements a hardware-dependent code for reading the local Bluetooth Radio connectable state. |
| HalGetDiscoverable(Boolean) | Implements a hardware-dependent code to read the local Bluetooth Radio discoverable state. |
| HalGetFunctions | Implements a driver-dependent code for getting API functions pointers. |
| HalGetHciVersion(Byte,Word) | Implements a hardware-dependent code to reads the HCI version of the local Radio module. |
| HalGetLmpVersion(Byte,Word) | Implements a hardware-dependent code to reading the LMP version of the local Radio module. |
| HalGetManufacturer(Word) | Implements a hardware-dependent code to read the Bluetooth Radio manufacturer ID. |
| HalGetName(string) | Implements a hardware-dependent code for reading the local Radio name. |
| HalGetPlugged | Implements a hardware-dependent code to check a Bluetooth hardware physical state. |
| HalGetRemoteAddressType(Int64,TwclBluetoothAddressType) | Implements a hardware-dependent code for reading a remote device address type. |
| HalGetRemoteCod(Int64,Cardinal) | Implements a hardware-dependent code for reading a remote device COD (Class Of Device). |
| HalGetRemoteConnectedStatus(Int64,Boolean) | The function checks if the specified remote device is currently connected. |
| HalGetRemoteDeviceType(Int64,TwclBluetoothDeviceType) | Implements a hardware-dependent code to reading a remote Bluetooth device type. |
| HalGetRemoteName(Int64,string) | Implements a hardware-dependent code for querying a remote device's name. |
| HalGetRemotePaired(Int64,Boolean) | Implements a hardware-dependent code for reading a remote Bluetooth device paired status. |
| HalGetRemoteRssi(Int64,SByte) | Reads RSSI value from a remote device. |
| HalGetSimplePairingMode(Boolean) | Implements a hardware-dependent code that reads a radio Secure Simple Pairing mode. |
| HalInitialize | Implements a driver-dependent code for API initialization. |
| HalInstallDevice(Int64,TGUID) | Install drivers for specified Bluetooth device. |
| HalIoCapabilityReply(Int64,TwclBluetoothMitmProtection,TwclBluetoothIoCapability,Boolean) | Implements a hardware-dependent code to reply on an IO capability request. |
| HalIsRemoteDeviceInRange(Int64,Boolean) | Implements a hardware-dependent code to check if a remote device is in range. |
| HalLoadApi | Implements a driver-dependent code for loading API DLLs. |
| HalNumericComparisonReply(Int64,Cardinal,Boolean) | Implements a hardware-dependent code to reply on a numeric comparison request. |
| HalOobDataReply(Int64,TwclBluetoothOobData) | Implements a hardware-dependent code to reply on a Out Of Band pairing request. |
| HalPasskeyReply(Int64,Cardinal) | Implements a hardware-dependent code to reply for a passkey request event. |
| HalPinReply(Int64,string) | Implements a hardware-dependent code to reply for a PIN request event. |
| HalProtectionLevelReply(Int64,TwclBluetoothLeProtectionLevel) | Implements a hardware-dependent code to reply for a pairing protection level request event. |
| HalRegisterCallbacks | Implements a driver-dependent code for callback registration. |
| HalRemoteDisconnect(Int64) | Implements a hardware-dependent code to disconnect a remote device. |
| HalRemotePair(Int64,TwclBluetoothPairingMethod) | Implements a hardware-dependent code for pairing with a remote Bluetooth device. |
| HalRemoteUnpair(Int64,TwclBluetoothPairingMethod) | Implements a hardware-dependent code to unpair a remote Bluetooth device. |
| HalSetCod(Cardinal) | Implements a hardware-dependent code to changing the local Bluetooth Radio Class Of Device (COD). |
| HalSetConnectable(Boolean) | Implements a hardware-dependent code to changing the connectable state of the local Bluetooth Radio. |
| HalSetDiscoverable(Boolean) | Implements a hardware-dependent code for changing the discoverable state of the local Bluetooth Radio. |
| HalSetGlobalInstance | Implements a driver-dependent code for setting the Radio object global instance variable. |
| HalSetName(string) | Implements a hardware-dependent code for changing the local Bluetooth Radio module name. |
| HalSetSimplePairingMode(Boolean) | Implements a hardware-dependent code that writes a radio Secure Simple Pairing mode. |
| HalTerminate | Implements a hardware-dependent code for discovering termination. |
| HalTerminateOperations | Implements a driver-dependent code for pending operation termination. |
| HalTurnOff | The method turns the local Bluetooth radio OFF. |
| HalTurnOn | The method turns the local Bluetooth radio ON. |
| HalUninitialize | Implements a driver-dependent code for driver uninitialization. |
| HalUninstallDevice(Int64,TGUID) | Uninstall drivers for specified Bluetooth device. |
| HalUnloadApi | Implements a driver-dependent code for API unloading. |
| HalUnregisterCallbacks | Implements a driver-dependent code for callbacks unregistering. |
| InstallDevice(Int64,TGUID) | Install drivers for specified Bluetooth device. |
| IsRemoteDeviceInRange(Int64,Boolean) | Checks if a remote device is in range. |
| MessageReceived(TwclMessage) | The method called when a new notification message received. |
| RemoteDisconnect(Int64) | Forces a remote device disconnection. |
| RemotePair(Int64,TwclBluetoothPairingMethod) | Starts pairing with a remote Bluetooth device. |
| RemoteUnpair(Int64,TwclBluetoothPairingMethod,Boolean) | Unpair a remote Bluetooth device. |
| SetCod(Cardinal) | Changes the local Bluetooth Radio Class Of Device (COD). |
| SetConnectable(Boolean) | Changes the connectable state of the local Bluetooth Radio. |
| SetDiscoverable(Boolean) | Changes the discoverable state of the local Bluetooth Radio. |
| SetName(string) | Sets a new name for the local Bluetooth Radio module. |
| SetSimplePairingMode(Boolean) | Sets the radio Secure Simple Pairing mode. |
| Terminate | Terminates the discovering of remote Bluetooth enabled devices. |
| TurnOff | The method turns the local Bluetooth radio OFF. |
| TurnOn | The method turns the local Bluetooth radio ON. |
| UninstallDevice(Int64,TGUID) | Uninstall drivers for specified Bluetooth device. |
An application must never create or destroy this class directly. Instead of that an application must use methods of the TwclBluetoothManager component.
The class is thread safe.
The only single instance of the class for each supported Bluetooth driver can be created.