Класс QBluetoothLocalDevice
Класс QBluetoothLocalDevice обеспечивает доступ к локальному устройству Bluetooth. Подробнее...
| Заголовок: | #include <QBluetoothLocalDevice> |
| qmake: | QT += bluetooth |
| С момента: | Qt 5.2 |
| Наследует: | QObject |
Типы публичного доступа
| перечисление | Ошибка { НетОшибки, ОшибкаПарнойСвязи, НеизвестнаяОшибка } |
| перечисление | РежимХоста { ХостВыключен, ХостПодключен, ХостОбнаруживаем, ХостОбнаруживаемОграниченныйЗапрос } |
| перечисление | Сопряжение { НеСопряжено, Сопряжено, АвторизованноеСопряжение } |
Функции публичного доступа
| QBluetoothLocalDevice(QObject *parent = Q_NULLPTR) | |
| QBluetoothLocalDevice(const QBluetoothAddress &address, QObject *parent = Q_NULLPTR) | |
| виртуальный | ~QBluetoothLocalDevice() |
| QBluetoothAddress | адрес() const |
| QList<QBluetoothAddress> | подключенныеУстройства() const |
| РежимХоста | режимХоста() const |
| bool | действителен() const |
| QString | имя() const |
| Сопряжение | статусСопряжения(const QBluetoothAddress &address) const |
| void | включить() |
| void | запроситьСопряжение(const QBluetoothAddress &address, Сопряжение pairing) |
| void | установитьРежимХоста(QBluetoothLocalDevice::РежимХоста mode) |
- 32 функций публичного доступа унаследовано от QObject
Слот публичного доступа
| void | подтверждениеСопряжения(bool accept) |
- 1 слот публичного доступа унаследовано от QObject
Сигналы
| void | устройствоПодключено(const QBluetoothAddress &address) |
| void | устройствоОтключено(const QBluetoothAddress &address) |
| void | ошибка(QBluetoothLocalDevice::Ошибка error) |
| void | измененоСостояниеРежимаХоста(QBluetoothLocalDevice::РежимХоста state) |
| void | подтверждениеОтображенияСопряжения(const QBluetoothAddress &address, QString pin) |
| void | отображениеКодаPINСопряжения(const QBluetoothAddress &address, QString pin) |
| void | завершениеСопряжения(const QBluetoothAddress &address, QBluetoothLocalDevice::Сопряжение pairing) |
- 2 сигнала унаследовано от QObject
Статические члены публичного доступа
| QList<QBluetoothHostInfo> | всеУстройства() |
- 11 статических членов публичного доступа унаследовано от QObject
Дополнительные унаследованные члены
Подробное описание
Класс QBluetoothLocalDevice обеспечивает доступ к локальному устройству Bluetooth.
QBluetoothLocalDevice предоставляет функции для получения и изменения состояния локальных устройств Bluetooth.
Документация по типам членов
перечисление QBluetoothLocalDevice::Ошибка
Это перечисление описывает ошибки, которые могут быть возвращены
| Константа | Значение | Описание |
|---|---|---|
QBluetoothLocalDevice::NoError |
0 |
Нет известной ошибки |
QBluetoothLocalDevice::PairingError |
1 |
Ошибка при сопряжении |
QBluetoothLocalDevice::UnknownError |
100 |
Неизвестная ошибка |
перечисление QBluetoothLocalDevice::РежимХоста
Это перечисление описывает состояние локального устройства Bluetooth.
| Константа | Значение | Описание |
|---|---|---|
QBluetoothLocalDevice::HostPoweredOff |
0 |
Выключение устройства |
QBluetoothLocalDevice::HostConnectable |
1 |
Удаленные устройства Bluetooth могут подключиться к локальному устройству Bluetooth, если они были ранее сопряжены с ним или знают его адрес. Это включает устройство, если оно было выключено. |
QBluetoothLocalDevice::HostDiscoverable |
2 |
Удаленные устройства Bluetooth могут обнаружить локальное устройство Bluetooth. Устройство также будет подключенным и включенным. В Android этот режим может быть активным не более 5 минут. |
QBluetoothLocalDevice::HostDiscoverableLimitedInquiry |
3 |
Удаленные устройства Bluetooth могут обнаружить локальное устройство Bluetooth при выполнении ограниченного запроса. Это следует использовать для поиска служб, которые доступны для обнаружения только в течение ограниченного периода времени. Это может ускорить поиск между игровыми устройствами, так как обнаружение служб может быть пропущено на устройствах, не находящихся в режиме ограниченного запроса. В этом режиме устройство будет подключенным и включенным, если необходимо. Этот режим не поддерживается в Android. В macOS невозможно установить режимХоста() на HostConnectable или HostPoweredOff. |
перечисление QBluetoothLocalDevice::Сопряжение
Это перечисление описывает состояние сопряжения между двумя устройствами Bluetooth.
| Константа | Значение | Описание |
|---|---|---|
QBluetoothLocalDevice::Unpaired |
0 |
Устройства Bluetooth не сопряжены. |
QBluetoothLocalDevice::Paired |
1 |
Устройства Bluetooth сопряжены. Система запросит разрешение у пользователя, когда удаленное устройство инициирует подключение к локальному устройству. |
QBluetoothLocalDevice::AuthorizedPaired |
2 |
Устройства Bluetooth сопряжены. Система не будет запрашивать разрешение у пользователя, когда удаленное устройство инициирует подключение к локальному устройству. |
Документация по функциям-членам
QBluetoothLocalDevice::QBluetoothLocalDevice(QObject *parent = Q_NULLPTR)
Создает объект QBluetoothLocalDevice с параметром parent.
QBluetoothLocalDevice::QBluetoothLocalDevice(const QBluetoothAddress &address, QObject *parent = Q_NULLPTR)
Создаёт новый объект QBluetoothLocalDevice для адреса address. Если address имеет значение по умолчанию, то создаваемый локальный объект выбирает локальное устройство по умолчанию.
[virtual] QBluetoothLocalDevice::~QBluetoothLocalDevice()
Удаляет объект QBluetoothLocalDevice.
QBluetoothAddress QBluetoothLocalDevice::address() const
Возвращает MAC-адрес этого Bluetooth-устройства.
Примечание: В Android, эта функция всегда возвращает постоянное значение 02:00:00:00:00:00 в качестве локального адреса, начиная с Android 6.0. Программный доступ к локальному MAC-адресу устройства был удалён.
[static] QList<QBluetoothHostInfo> QBluetoothLocalDevice::allDevices()
Возвращает список всех доступных локальных Bluetooth-устройств. В macOS, существует только локальное устройство по умолчанию.
QList<QBluetoothAddress> QBluetoothLocalDevice::connectedDevices() const
Возвращает список подключенных устройств. Этот список отличается от списка текущих сопряженных устройств.
В Android и macOS невозможно получить список подключенных устройств. Возможен только мониторинг изменений подключения. Для удобства, этот класс отслеживает все события подключения и отключения с момента его создания и возвращает текущий список при вызове этой функции. Поэтому возможно, что эта функция вернёт пустой список вскоре после создания экземпляра.
Эта функция была добавлена в Qt 5.3.
См. также deviceConnected() и deviceDisconnected().
[signal] void QBluetoothLocalDevice::deviceConnected(const QBluetoothAddress &address)
Этот сигнал излучается, когда локальное устройство устанавливает соединение с удалённым устройством с адресом address.
Эта функция была добавлена в Qt 5.3.
См. также deviceDisconnected() и connectedDevices().
[signal] void QBluetoothLocalDevice::deviceDisconnected(const QBluetoothAddress &address)
Этот сигнал излучается, когда локальное устройство отключается от удалённого Bluetooth-устройства с адресом address.
Эта функция была добавлена в Qt 5.3.
См. также deviceConnected() и connectedDevices().
[signal] void QBluetoothLocalDevice::error(QBluetoothLocalDevice::Error error)
Сигнал излучается, если при сопряжении произошла исключительная ошибка error.
HostMode QBluetoothLocalDevice::hostMode() const
Возвращает текущий режим хоста этого локального Bluetooth-устройства. В macOS, это либо HostPoweredOff, либо HostConnectable.
См. также setHostMode().
[signal] void QBluetoothLocalDevice::hostModeStateChanged(QBluetoothLocalDevice::HostMode state)
Состояние хоста перешло в другой режим HostMode.
bool QBluetoothLocalDevice::isValid() const
Возвращает true, если QBluetoothLocalDevice представляет доступное локальное Bluetooth-устройство; в противном случае возвращает false.
Если локальный Bluetooth-адаптер, представленный экземпляром этого класса, удалён из системы (например, удаление подлежащего Bluetooth-донгла), то этот экземпляр станет недоступным. Уже недействительный экземпляр QBluetoothLocalDevice остаётся недействительным, даже если тот же Bluetooth-адаптер возвращён в систему.
См. также allDevices().
QString QBluetoothLocalDevice::name() const
Возвращает имя, присвоенное пользователем этому Bluetooth-устройству.
[slot] void QBluetoothLocalDevice::pairingConfirmation(bool accept)
Вызывается после получения pairingDisplayConfirmation(). Параметр accept определяет, принять ли сопряжение или отклонить его.
Принятие сопряжения всегда относится к последнему запросу сопряжения, выпущенному с помощью requestPairing().
[signal] void QBluetoothLocalDevice::pairingDisplayConfirmation(const QBluetoothAddress &address, QString pin)
Сигнал, излучаемый некоторыми платформами для отображения диалога подтверждения сопряжения для address. Пользователю предлагается подтвердить, что pin совпадает на обоих устройствах. Функция pairingConfirmation() должна быть вызвана для указания, принимает ли пользователь отображаемый PIN или отклоняет его.
Этот сигнал излучается только для запросов сопряжения, выпущенных с помощью вызова requestPairing(). В macOS этот метод никогда не вызывается — есть обратный вызов с PIN-кодом (IOBluetooth), но он ожидает немедленного ответа да/нет, и нет времени отобразить какой-либо диалог или сравнить PIN-коды.
См. также pairingConfirmation().
[signal] void QBluetoothLocalDevice::pairingDisplayPinCode(const QBluetoothAddress &address, QString pin)
Сигнал, излучаемый некоторыми платформами для отображения pin пользователю для address. PIN генерируется автоматически и не требует подтверждения.
Этот сигнал излучается только для запросов сопряжения, выпущенных с помощью вызова requestPairing().
[signal] void QBluetoothLocalDevice::pairingFinished(const QBluetoothAddress &address, QBluetoothLocalDevice::Pairing pairing)
Завершено сопряжение или отключение устройства с address. Текущий статус сопряжения находится в pairing. Если запрос сопряжения не был успешным, этот сигнал не будет излучен. Сигнал error() излучается, если запрос сопряжения завершился неудачей. Сигнал излучается только для запросов сопряжения, которые были запрошены ранее с помощью вызова requestPairing() текущего экземпляра объекта.
Pairing QBluetoothLocalDevice::pairingStatus(const QBluetoothAddress &address) const
Возвращает текущий статус сопряжения Bluetooth для address: несопряжён, сопряжён или сопряжён и авторизован.
void QBluetoothLocalDevice::powerOn()
Включает устройство после возврата его в состояние hostMode(), если оно было выключено.
Примечание: Из-за различных политике безопасности на поддерживаемых платформах, этот метод может иметь различное поведение на разных платформах. Например, система может попросить пользователя подтвердить перед включением или выключением Bluetooth. В macOS невозможно включать/выключать Bluetooth. Обратитесь к документации по Bluetooth для конкретной платформы для получения подробностей.
void QBluetoothLocalDevice::requestPairing(const QBluetoothAddress &address, Pairing pairing)
Устанавливает статус pairing для address. Результаты возвращаются сигналом pairingFinished(). В Android и macOS, AuthorizedPaired невозможен и будет иметь такое же поведение, как Paired.
В macOS невозможно отключить устройство. Если запрошено Unpaired, pairingFinished() излучается немедленно, хотя устройство остаётся сопряжённым. Возможен запрос сопряжения для ранее несопряжённого устройства. Кроме того, AuthorizedPaired имеет такое же поведение, как Paired.
Предупреждение: создание сопряжения может занять несколько минут и может потребовать подтверждения от пользователя.
void QBluetoothLocalDevice::setHostMode(QBluetoothLocalDevice::HostMode mode)
Устанавливает режим хоста этого локального Bluetooth-устройства в mode.
Примечание: Ввиду различных политиках безопасности на поддерживаемых платформах, поведение данного метода может отличаться на разных платформах. Например, система может запросить подтверждение пользователя перед включением или выключением Bluetooth, и не все режимы хоста могут быть поддерживаемы. На macOS невозможно программно изменить hostMode(). Пользователь может переключать Bluetooth только через Системные настройки. Обратитесь к документации Bluetooth для конкретной платформы для получения подробностей.
См. также hostMode().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qbluetoothlocaldevice.html
