Класс 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 pairing) |
| void | установитьРежимХоста(QBluetoothLocalDevice::РежимХоста mode) |
- 31 функция унаследованная от 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 при выполнении ограниченного запроса. Это следует использовать для поиска служб, доступных для обнаружения в течение ограниченного периода времени. Это может ускорить обнаружение между игровыми устройствами, так как обнаружение служб может быть пропущено на устройствах, не находящихся в режиме OграниченноеОбнаружение. В этом режиме устройство будет доступно для подключения и включено, если требуется. Этот режим не поддерживается в Android. В macOS невозможно установить режимХоста() на ХостПодключен или ХостВыключен. |
перечисление 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.
END_OF_DOCUMENT_MARKERvoid 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/archives/qt-5.6/qbluetoothlocaldevice.html
