BluetoothHost

java.lang.Object
- ohos.bluetooth.BluetoothHost

```
public final class BluetoothHost
extends Object
```
Manages Bluetooth on a device, such as enabling and disabling Bluetooth.
The BluetoothHost#getDefaultHost method can be used to obtain a BluetoothHost instance, which can be used to perform Bluetooth operations on a device.
You can use enableBt() to enable Bluetooth, disableBt() to disable Bluetooth, startBtDiscovery() to start a device scan, and cancelBtDiscovery() to cancel a device scan.

从以下版本开始:

1

字段概要

字段
限定符和类型	字段	说明
`static int`	`BLE_CAP_2M_PHY`	Indicates that the Bluetooth chip of the current device supports the BLE 2M PHY feature.
`static int`	`BLE_CAP_CODED_PHY`	Indicates that the Bluetooth chip of the current device supports the BLE coded PHY feature.
`static int`	`BLE_CAP_EXTENDED_ADV`	Indicates that the Bluetooth chip of the current device supports the BLE extended advertising feature.
`static int`	`BLE_CAP_MULTIPLE_ADV`	Indicates that the Bluetooth chip of the current device supports the BLE multiple advertising feature.
`static int`	`BLE_CAP_OFFLOADED_FILTER`	Indicates that the Bluetooth chip of the current device supports the BLE offloaded filter feature.
`static int`	`BLE_CAP_OFFLOADED_SCAN_BATCH`	Indicates that the Bluetooth chip of the current device supports the BLE offloaded scan batch feature.
`static int`	`BLE_CAP_PERIODIC_ADV`	Indicates that the Bluetooth chip of the current device supports the BLE periodic advertising feature.
`static String`	`EVENT_HOST_DISCOVERY_FINISHED`	Indicates the event reported when a Bluetooth scan is complete.
`static String`	`EVENT_HOST_DISCOVERY_STARTED`	Indicates the event reported when a Bluetooth scan starts.
`static String`	`EVENT_HOST_NAME_UPDATE`	Indicates the event reported when the Bluetooth name changes.
`static String`	`EVENT_HOST_SCAN_MODE_UPDATE`	Indicates the event reported when the Bluetooth scan mode changes.
`static String`	`EVENT_HOST_STATE_UPDATE`	Indicates the event reported when the Bluetooth state changes.
`static String`	`HOST_PARAM_CUR_STATE`	Indicates the Bluetooth state after a state update.
`static String`	`HOST_PARAM_DISCOVERABLE_TERM`	Indicates the remaining duration in seconds, in which the host is discoverable.
`static String`	`HOST_PARAM_HOST_NAME`	Indicates the bluetooth name after a host name changes.
`static String`	`HOST_PARAM_PRE_STATE`	Indicates the Bluetooth state after a state update.
`static String`	`HOST_PARAM_SCAN_METHOD`	Indicates the scan mode after a scan mode update.
`static int`	`SCAN_MODE_CONNECTABLE`	Indicates that the Bluetooth inquiry scan is disabled and page scan is enabled on the current device.
`static int`	`SCAN_MODE_CONNECTABLE_DISCOVERABLE`	Indicates that Bluetooth inquiry scan and page scan are enabled on the current device.
`static int`	`SCAN_MODE_NONE`	Indicates that Bluetooth inquiry scan and page scan are disabled on the current device.
`static int`	`STATE_BLE_ON`	Indicates that Bluetooth BLE is enabled on the current device.
`static int`	`STATE_BLE_TURNING_OFF`	Indicates that Bluetooth BLE is being disabled on the current device.
`static int`	`STATE_BLE_TURNING_ON`	Indicates that Bluetooth BLE is being disabled on the current device.
`static int`	`STATE_OFF`	Indicates that Bluetooth is disabled on the current device.
`static int`	`STATE_ON`	Indicates that Bluetooth BR is enabled on the current device.
`static int`	`STATE_TURNING_OFF`	Indicates that Bluetooth BR is being disabled on the current device.
`static int`	`STATE_TURNING_ON`	Indicates that Bluetooth BR is being enabled on the current device.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`cancelBtDiscovery()`	Stops Bluetooth device scanning.
`boolean`	`disableBt()`	Disables Bluetooth on a device.
`boolean`	`enableBt()`	Enables Bluetooth on a device.
`int`	`getBleCapabilities()`	Obtains the Bluetooth BLE capability of a device.
`int`	`getBleMaxAdvertisingDataLength()`	Obtains the maximum length of advertising data supported by the Bluetooth BLE of a device.
`int`	`getBtScanMode()`	Obtains the Bluetooth scanning mode of a device.
`int`	`getBtState()`	Obtains the Bluetooth status of a device.
`static BluetoothHost`	`getDefaultHost(Context context)`	Obtains a default `BluetoothHost` instance to perform Bluetooth operations on a device.
`Optional<String>`	`getLocalName()`	Obtains the Bluetooth friendly name of a device.
`List<BluetoothRemoteDevice>`	`getPairedDevices()`	Obtains the list of Bluetooth devices that have been paired with the current device.
`int`	`getProfileConnState(int profile)`	Obtains the status of the connection between current device's Bluetooth profile and other Bluetooth devices.
`BluetoothRemoteDevice`	`getRemoteDev(String addr)`	Obtains the `BluetoothRemoteDevice` object with a specified Bluetooth address.
`boolean`	`isBtDiscovering()`	Checks whether Bluetooth scanning is ongoing on a device.
`static boolean`	`isValidBluetoothAddr(String addr)`	Checks whether the Bluetooth address is valid.
`boolean`	`setBtScanMode(int mode, int duration)`	Sets the Bluetooth scan mode for a device.
`boolean`	`setDevicePairingConfirmation(BluetoothRemoteDevice device, boolean accept)`	Sets the confirmation of pairing with a certain device.
`boolean`	`setLocalName(String name)`	Sets the Bluetooth friendly name of a device.
`boolean`	`startBtDiscovery()`	Starts scanning Bluetooth devices.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - BLE_CAP_2M_PHY
```
public static final int BLE_CAP_2M_PHY
```
    Indicates that the Bluetooth chip of the current device supports the BLE 2M PHY feature.
    
    另请参阅:
    
    常量字段值
  - BLE_CAP_CODED_PHY
```
public static final int BLE_CAP_CODED_PHY
```
    Indicates that the Bluetooth chip of the current device supports the BLE coded PHY feature.
    
    另请参阅:
    
    常量字段值
  - BLE_CAP_EXTENDED_ADV
```
public static final int BLE_CAP_EXTENDED_ADV
```
    Indicates that the Bluetooth chip of the current device supports the BLE extended advertising feature.
    
    另请参阅:
    
    常量字段值
  - BLE_CAP_MULTIPLE_ADV
```
public static final int BLE_CAP_MULTIPLE_ADV
```
    Indicates that the Bluetooth chip of the current device supports the BLE multiple advertising feature.
    
    另请参阅:
    
    常量字段值
  - BLE_CAP_OFFLOADED_FILTER
```
public static final int BLE_CAP_OFFLOADED_FILTER
```
    Indicates that the Bluetooth chip of the current device supports the BLE offloaded filter feature.
    
    另请参阅:
    
    常量字段值
  - BLE_CAP_OFFLOADED_SCAN_BATCH
```
public static final int BLE_CAP_OFFLOADED_SCAN_BATCH
```
    Indicates that the Bluetooth chip of the current device supports the BLE offloaded scan batch feature.
    
    另请参阅:
    
    常量字段值
  - BLE_CAP_PERIODIC_ADV
```
public static final int BLE_CAP_PERIODIC_ADV
```
    Indicates that the Bluetooth chip of the current device supports the BLE periodic advertising feature.
    
    另请参阅:
    
    常量字段值
  - EVENT_HOST_DISCOVERY_FINISHED
```
public static final String EVENT_HOST_DISCOVERY_FINISHED
```
    Indicates the event reported when a Bluetooth scan is complete.
    EVENT_HOST_DISCOVERY_FINISHED does not contain any other information.
    
    Output: none
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    EVENT_HOST_DISCOVERY_FINISHED, 常量字段值
  - EVENT_HOST_DISCOVERY_STARTED
```
public static final String EVENT_HOST_DISCOVERY_STARTED
```
    Indicates the event reported when a Bluetooth scan starts.
    EVENT_HOST_DISCOVERY_STARTED does not contain any other information.
    
    Output: none
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    EVENT_HOST_DISCOVERY_STARTED, 常量字段值
  - EVENT_HOST_NAME_UPDATE
```
public static final String EVENT_HOST_NAME_UPDATE
```
    Indicates the event reported when the Bluetooth name changes.
    EVENT_HOST_NAME_UPDATE contains detailed information about the Bluetooth name change.
    
    Output: HOST_PARAM_HOST_NAME indicates the Bluetooth name.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    HOST_PARAM_HOST_NAME, 常量字段值
  - EVENT_HOST_SCAN_MODE_UPDATE
```
public static final String EVENT_HOST_SCAN_MODE_UPDATE
```
    Indicates the event reported when the Bluetooth scan mode changes.
    EVENT_HOST_SCAN_MODE_UPDATE contains detailed information about the change in the Bluetooth scan mode.
    
    Output: HOST_PARAM_SCAN_METHOD indicates the Bluetooth scan mode.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    EVENT_HOST_SCAN_MODE_UPDATE, HOST_PARAM_SCAN_METHOD, 常量字段值
  - EVENT_HOST_STATE_UPDATE
```
public static final String EVENT_HOST_STATE_UPDATE
```
    Indicates the event reported when the Bluetooth state changes.
    EVENT_HOST_STATE_UPDATE contains detailed information about the Bluetooth state change.
    
    Output: HOST_PARAM_PRE_STATE indicates the Bluetooth state before the change; HOST_PARAM_CUR_STATE indicates the Bluetooth state after the change.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    EVENT_HOST_STATE_UPDATE, HOST_PARAM_PRE_STATE, HOST_PARAM_CUR_STATE, 常量字段值
  - HOST_PARAM_CUR_STATE
```
public static final String HOST_PARAM_CUR_STATE
```
    Indicates the Bluetooth state after a state update. It can be STATE_OFF, STATE_TURNING_ON, STATE_ON, or STATE_TURNING_OFF.
    
    另请参阅:
    
    常量字段值
  - HOST_PARAM_DISCOVERABLE_TERM
```
public static final String HOST_PARAM_DISCOVERABLE_TERM
```
    Indicates the remaining duration in seconds, in which the host is discoverable.
    
    另请参阅:
    
    常量字段值
  - HOST_PARAM_HOST_NAME
```
public static final String HOST_PARAM_HOST_NAME
```
    Indicates the bluetooth name after a host name changes.
    
    另请参阅:
    
    常量字段值
  - HOST_PARAM_PRE_STATE
```
public static final String HOST_PARAM_PRE_STATE
```
    Indicates the Bluetooth state after a state update. It can be STATE_OFF, STATE_TURNING_ON, STATE_ON, or STATE_TURNING_OFF.
    
    另请参阅:
    
    常量字段值
  - HOST_PARAM_SCAN_METHOD
```
public static final String HOST_PARAM_SCAN_METHOD
```
    Indicates the scan mode after a scan mode update. It can be SCAN_MODE_NONE, SCAN_MODE_CONNECTABLE, or SCAN_MODE_CONNECTABLE_DISCOVERABLE.
    
    另请参阅:
    
    常量字段值
  - SCAN_MODE_CONNECTABLE
```
public static final int SCAN_MODE_CONNECTABLE
```
    Indicates that the Bluetooth inquiry scan is disabled and page scan is enabled on the current device.
    
    另请参阅:
    
    常量字段值
  - SCAN_MODE_CONNECTABLE_DISCOVERABLE
```
public static final int SCAN_MODE_CONNECTABLE_DISCOVERABLE
```
    Indicates that Bluetooth inquiry scan and page scan are enabled on the current device.
    
    另请参阅:
    
    常量字段值
  - SCAN_MODE_NONE
```
public static final int SCAN_MODE_NONE
```
    Indicates that Bluetooth inquiry scan and page scan are disabled on the current device.
    
    另请参阅:
    
    常量字段值
  - STATE_BLE_ON
```
public static final int STATE_BLE_ON
```
    Indicates that Bluetooth BLE is enabled on the current device.
    
    另请参阅:
    
    常量字段值
  - STATE_BLE_TURNING_OFF
```
public static final int STATE_BLE_TURNING_OFF
```
    Indicates that Bluetooth BLE is being disabled on the current device.
    
    另请参阅:
    
    常量字段值
  - STATE_BLE_TURNING_ON
```
public static final int STATE_BLE_TURNING_ON
```
    Indicates that Bluetooth BLE is being disabled on the current device.
    
    另请参阅:
    
    常量字段值
  - STATE_OFF
```
public static final int STATE_OFF
```
    Indicates that Bluetooth is disabled on the current device.
    
    另请参阅:
    
    常量字段值
  - STATE_ON
```
public static final int STATE_ON
```
    Indicates that Bluetooth BR is enabled on the current device.
    
    另请参阅:
    
    常量字段值
  - STATE_TURNING_OFF
```
public static final int STATE_TURNING_OFF
```
    Indicates that Bluetooth BR is being disabled on the current device.
    
    另请参阅:
    
    常量字段值
  - STATE_TURNING_ON
```
public static final int STATE_TURNING_ON
```
    Indicates that Bluetooth BR is being enabled on the current device.
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getDefaultHost
```
public static BluetoothHost getDefaultHost(Context context)
```
    Obtains a default BluetoothHost instance to perform Bluetooth operations on a device.
    
    参数:
    
    context - Ability context that contains package name.
    
    返回:
    
    Returns the default BluetoothHost instance.
  - enableBt
```
public boolean enableBt()
```
    Enables Bluetooth on a device.
    This method is used to start Bluetooth hardware and all Bluetooth services, such as A2DP and HFP.
    This is an asynchronous method. The result is returned immediately after your application calls the method. Your application must listen to EVENT_HOST_STATE_UPDATE broadcast for the change of the Bluetooth status.
    
    返回:
    
    Returns true if Bluetooth is being enabled; returns false if an error occurs.
  - disableBt
```
public boolean disableBt()
```
    Disables Bluetooth on a device.
    This method is used to disable Bluetooth hardware and all Bluetooth services, such as A2DP and HFP.
    This is an asynchronous method. The result is returned immediately after your application calls the method. Your application must listen to EVENT_HOST_STATE_UPDATE broadcast for the change of the Bluetooth status.
    
    返回:
    
    Returns true if Bluetooth is being disabled; returns false if an error occurs.
  - getBtState
```
public int getBtState()
```
    Obtains the Bluetooth status of a device.
    
    返回:
    
    Returns the Bluetooth status, which can be STATE_OFF, STATE_TURNING_ON, STATE_ON, STATE_TURNING_OFF, STATE_BLE_TURNING_ON, STATE_BLE_ON, or STATE_BLE_TURNING_OFF.
  - getRemoteDev
```
public BluetoothRemoteDevice getRemoteDev(String addr)
```
    Obtains the BluetoothRemoteDevice object with a specified Bluetooth address.
    The letters in the Bluetooth address must be in uppercase.
    
    参数:
    
    addr - Indicates a valid Bluetooth address.
    
    返回:
    
    Returns the BluetoothRemoteDevice instance with the specified address.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the Bluetooth address is invalid.
  - getLocalName
```
public Optional<String> getLocalName()
```
    Obtains the Bluetooth friendly name of a device.
    The name is visible to other Bluetooth devices.
    
    返回:
    
    Returns the Bluetooth friendly name; returns Optional#empty() if an exception occurs.
  - setLocalName
```
public boolean setLocalName(String name)
```
    Sets the Bluetooth friendly name of a device.
    This is an asynchronous method. Your application must listen to the EVENT_HOST_NAME_UPDATE broadcast for the setting result.
    
    参数:
    
    name - Indicates a valid Bluetooth name.
    
    返回:
    
    Returns true if the Bluetooth name is set successfully; returns false otherwise.
  - startBtDiscovery
```
public boolean startBtDiscovery()
```
    Starts scanning Bluetooth devices.
    This is an asynchronous method.
    An inquiry scan takes about 12.8s. Your application must listen to EVENT_HOST_DISCOVERY_STARTED and EVENT_HOST_DISCOVERY_STARTED broadcasts for the start and stop of the scan, and listen to the BluetoothRemoteDevice#EVENT_DEVICE_DISCOVERED broadcast for whether Bluetooth devices are detected in the scan.
    
    返回:
    
    Returns true if the scan is started successfully; returns false otherwise.
  - cancelBtDiscovery
```
public boolean cancelBtDiscovery()
```
    Stops Bluetooth device scanning.
    
    返回:
    
    Returns true if scanning is stopped successfully; returns false otherwise.
  - isBtDiscovering
```
public boolean isBtDiscovering()
```
    Checks whether Bluetooth scanning is ongoing on a device.
    
    返回:
    
    Returns true if Bluetooth scanning is ongoing; returns false otherwise.
  - getBtScanMode
```
public int getBtScanMode()
```
    Obtains the Bluetooth scanning mode of a device.
    
    返回:
    
    Returns the Bluetooth scanning mode, SCAN_MODE_NONE, SCAN_MODE_CONNECTABLE, or SCAN_MODE_CONNECTABLE_DISCOVERABLE.
  - getProfileConnState
```
public int getProfileConnState(int profile)
```
    Obtains the status of the connection between current device's Bluetooth profile and other Bluetooth devices.
    Currently, this method applies only to the ProfileBase#HFP and ProfileBase#A2DP profiles.
    
    参数:
    
    profile - Indicates the profile, either ProfileBase#HFP or ProfileBase#A2DP.
    
    返回:
    
    Returns the connection status, which can be ProfileBase#STATE_DISCONNECTED, ProfileBase#STATE_CONNECTING, ProfileBase#STATE_CONNECTED, or ProfileBase#STATE_DISCONNECTING.
  - getPairedDevices
```
public List<BluetoothRemoteDevice> getPairedDevices()
```
    Obtains the list of Bluetooth devices that have been paired with the current device.
    The return value of this method is valid only if the Bluetooth status of the current device is STATE_ON.
    
    返回:
    
    Returns a list of paired Bluetooth devices through BluetoothRemoteDevice.
  - getBleCapabilities
```
public int getBleCapabilities()
```
    Obtains the Bluetooth BLE capability of a device.
    
    返回:
    
    Returns the BLE capability in bit mask format, which can be BLE_CAP_2M_PHY, BLE_CAP_CODED_PHY, BLE_CAP_EXTENDED_ADV, BLE_CAP_PERIODIC_ADV, BLE_CAP_MULTIPLE_ADV, BLE_CAP_OFFLOADED_FILTER, or BLE_CAP_OFFLOADED_SCAN_BATCH.
  - getBleMaxAdvertisingDataLength
```
public int getBleMaxAdvertisingDataLength()
```
    Obtains the maximum length of advertising data supported by the Bluetooth BLE of a device.
    
    返回:
    
    Returns the maximum length of advertising data.
  - setBtScanMode
```
public boolean setBtScanMode(int mode,
                             int duration)
```
    Sets the Bluetooth scan mode for a device.
    
    参数:
    
    mode - Indicates the Bluetooth scan mode to set. It can be: SCAN_MODE_NONE, SCAN_MODE_CONNECTABLE, or SCAN_MODE_CONNECTABLE_DISCOVERABLE.
    
    duration - Indicates the duration in seconds, in which the host is discoverable.
    
    返回:
    
    Returns true if the Bluetooth scan mode is set; returns false otherwise.
  - setDevicePairingConfirmation
```
public boolean setDevicePairingConfirmation(BluetoothRemoteDevice device,
                                            boolean accept)
```
    Sets the confirmation of pairing with a certain device.
    
    参数:
    
    device - a device need to be accepted.
    
    accept - Indicates the accept value.
    
    返回:
    
    Returns true if the pairing confirmation is set; returns false otherwise..
  - isValidBluetoothAddr
```
public static boolean isValidBluetoothAddr(String addr)
```
    Checks whether the Bluetooth address is valid.
    Letters in the Bluetooth address string must be uppercase, for example, AA:BB:03:04:05.
    
    参数:
    
    addr - Indicates the Bluetooth address in string.
    
    返回:
    
    Returns true if the Bluetooth address is valid; returns false otherwise.
    
    从以下版本开始:
    
    3

类 BluetoothHost

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

BLE_CAP_2M_PHY

BLE_CAP_CODED_PHY

BLE_CAP_EXTENDED_ADV

BLE_CAP_MULTIPLE_ADV

BLE_CAP_OFFLOADED_FILTER

BLE_CAP_OFFLOADED_SCAN_BATCH

BLE_CAP_PERIODIC_ADV

EVENT_HOST_DISCOVERY_FINISHED

EVENT_HOST_DISCOVERY_STARTED

EVENT_HOST_NAME_UPDATE

EVENT_HOST_SCAN_MODE_UPDATE

EVENT_HOST_STATE_UPDATE

HOST_PARAM_CUR_STATE

HOST_PARAM_DISCOVERABLE_TERM

HOST_PARAM_HOST_NAME

HOST_PARAM_PRE_STATE

HOST_PARAM_SCAN_METHOD

SCAN_MODE_CONNECTABLE

SCAN_MODE_CONNECTABLE_DISCOVERABLE

SCAN_MODE_NONE

STATE_BLE_ON

STATE_BLE_TURNING_OFF

STATE_BLE_TURNING_ON

STATE_OFF

STATE_ON

STATE_TURNING_OFF

STATE_TURNING_ON

方法详细资料

getDefaultHost

enableBt

disableBt

getBtState

getRemoteDev

getLocalName

setLocalName

startBtDiscovery

cancelBtDiscovery

isBtDiscovering

getBtScanMode

getProfileConnState

getPairedDevices

getBleCapabilities

getBleMaxAdvertisingDataLength

setBtScanMode

setDevicePairingConfirmation

isValidBluetoothAddr