QBluetoothLocalDevice Class

The QBluetoothLocalDevice class enables access to the local Bluetooth device. More...

Header: #include <QBluetoothLocalDevice>
qmake: QT += bluetooth
Inherits: QObject.

Public Types

enum Error { NoError, PairingError, UnknownError }
enum HostMode { HostPoweredOff, HostConnectable, HostDiscoverable, HostDiscoverableLimitedInquiry }
enum Pairing { Unpaired, Paired, AuthorizedPaired }

Public Functions

QBluetoothLocalDevice(QObject * parent = 0)
QBluetoothLocalDevice(const QBluetoothAddress & address, QObject * parent = 0)
virtual ~QBluetoothLocalDevice()
QBluetoothAddress address() const
HostMode hostMode() const
bool isValid() const
QString name() const
Pairing pairingStatus(const QBluetoothAddress & address) const
void powerOn()
void requestPairing(const QBluetoothAddress & address, Pairing pairing)
void setHostMode(QBluetoothLocalDevice::HostMode mode)
  • 31 public functions inherited from QObject

Public Slots

void pairingConfirmation(bool accept)
  • 1 public slot inherited from QObject

Signals

void error(QBluetoothLocalDevice::Error error)
void hostModeStateChanged(QBluetoothLocalDevice::HostMode state)
void pairingDisplayConfirmation(const QBluetoothAddress & address, QString pin)
void pairingDisplayPinCode(const QBluetoothAddress & address, QString pin)
void pairingFinished(const QBluetoothAddress & address, QBluetoothLocalDevice::Pairing pairing)

Static Public Members

QList<QBluetoothHostInfo> allDevices()
  • 10 static public members inherited from QObject

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public variable inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QBluetoothLocalDevice class enables access to the local Bluetooth device.

QBluetoothLocalDevice provides functions for getting and setting the state of local Bluetooth devices.

Member Type Documentation

enum QBluetoothLocalDevice::Error

This enum describes errors that maybe returned

ConstantValueDescription
QBluetoothLocalDevice::NoError0No known error
QBluetoothLocalDevice::PairingError1Error in pairing
QBluetoothLocalDevice::UnknownError100Unknown error

enum QBluetoothLocalDevice::HostMode

This enum describes the most of the local Bluetooth device.

ConstantValueDescription
QBluetoothLocalDevice::HostPoweredOff0Power off the device
QBluetoothLocalDevice::HostConnectable1Remote Bluetooth devices can connect to the local Bluetooth device if they have previously been paired with it or otherwise know its address. This powers up the device if it was powered off.
QBluetoothLocalDevice::HostDiscoverable2Remote Bluetooth devices can discover the presence of the local Bluetooth device. The device will also be connectable, and powered on.
QBluetoothLocalDevice::HostDiscoverableLimitedInquiry3Remote Bluetooth devices can discover the presence of the local Bluetooth device when performing a limited inquiry. This should be used for locating services that are only made discoverable for a limited period of time. This can speed up discovery between gaming devices, as service discovery can be skipped on devices not in LimitedInquiry mode. In this mode, the device will be connectable and powered on, if required.

enum QBluetoothLocalDevice::Pairing

This enum describes the pairing state between the two Bluetooth devices.

ConstantValueDescription
QBluetoothLocalDevice::Unpaired0The Bluetooth devices are not paired.
QBluetoothLocalDevice::Paired1The Bluetooth devices are paired. The system will prompt the user for authorization when the remote device initiates a connection to the local device.
QBluetoothLocalDevice::AuthorizedPaired2The Bluetooth devices are paired. The system will not prompt the user for authorization when the remote device initiates a connection to the local device.

Member Function Documentation

QBluetoothLocalDevice::QBluetoothLocalDevice(QObject * parent = 0)

Constructs a QBluetoothLocalDevice with parent.

QBluetoothLocalDevice::QBluetoothLocalDevice(const QBluetoothAddress & address, QObject * parent = 0)

Construct new QBluetoothLocalDevice for address. If address is default constructed the resulting local device selects the local default device.

QBluetoothLocalDevice::~QBluetoothLocalDevice() [virtual]

Destroys the QBluetoothLocalDevice.

QBluetoothAddress QBluetoothLocalDevice::address() const

Returns the MAC address of this Bluetooth device.

QList<QBluetoothHostInfo> QBluetoothLocalDevice::allDevices() [static]

Returns a list of all available local Bluetooth devices.

void QBluetoothLocalDevice::error(QBluetoothLocalDevice::Error error) [signal]

Signal emitted if there's an exceptional error while pairing.

HostMode QBluetoothLocalDevice::hostMode() const

Returns the current host mode of this local Bluetooth device.

See also setHostMode().

void QBluetoothLocalDevice::hostModeStateChanged(QBluetoothLocalDevice::HostMode state) [signal]

The state of the host has transitioned to a different HostMode.

bool QBluetoothLocalDevice::isValid() const

Returns true if the QBluetoothLocalDevice represents an available local Bluetooth device; otherwise return false.

QString QBluetoothLocalDevice::name() const

Returns the name assgined by the user to this Bluetooth device.

void QBluetoothLocalDevice::pairingConfirmation(bool accept) [slot]

To be called after getting a pairingDisplayConfirmation(). The accept parameter either accepts the pairing or rejects it.

void QBluetoothLocalDevice::pairingDisplayConfirmation(const QBluetoothAddress & address, QString pin) [signal]

Signal by some platforms to display a pairing confirmation dialog for address. The user is asked to confirm the pin is the same on both devices. QBluetoothLocalDevice::pairingConfirmation(bool) must be called to indicate if the user accepts or rejects the displayed pin.

void QBluetoothLocalDevice::pairingDisplayPinCode(const QBluetoothAddress & address, QString pin) [signal]

Signal by some platforms to display the pin to the user for address. The pin is automatically generated, and does not need to be confirmed.

void QBluetoothLocalDevice::pairingFinished(const QBluetoothAddress & address, QBluetoothLocalDevice::Pairing pairing) [signal]

Pairing or unpairing has completed with address. Current pairing status is in pairing. If the pairing request was not successful, this signal will not be emitted. The error() signal is emitted if the pairing request failed.

Pairing QBluetoothLocalDevice::pairingStatus(const QBluetoothAddress & address) const

Returns the current bluetooth pairing status of address, if it's unpaired, paired, or paired and authorized.

void QBluetoothLocalDevice::powerOn()

Powers on the device after returning it to the hostMode() state, if it was powered off. NOTE: Due to security policies of platforms, this method may behave different on different platforms. For example the system can ask the user for confirmation before turning Bluetooth on or off. Please refer to the platform specific Bluetooth documentation for details.

void QBluetoothLocalDevice::requestPairing(const QBluetoothAddress & address, Pairing pairing)

Set the pairing status with address. The results are returned by the signal, pairingFinished(). On BlackBerry AuthorizedPaired is not possible and will have the same behavior as Paired. Caution: creating a pairing may take minutes, and may require the user to acknowledge.

void QBluetoothLocalDevice::setHostMode(QBluetoothLocalDevice::HostMode mode)

Sets the host mode of this local Bluetooth device to mode. NOTE: Due to security policies of platforms, this method may behave different on different platforms. For example the system can ask the user for confirmation before turning Bluetooth on or off. Not all host modes may be supported on all platforms. Please refer to the platform specific Bluetooth documentation for details.

See also hostMode().