BluetoothHearingAid


public final class BluetoothHearingAid
extends Object implements BluetoothProfile

java.lang.Object
   ↳ android.bluetooth.BluetoothHearingAid


This class provides the public APIs to control the Hearing Aid profile.

BluetoothHearingAid is a proxy object for controlling the Bluetooth Hearing Aid Service via IPC. Use BluetoothAdapter#getProfileProxy to get the BluetoothHearingAid proxy object.

Android only supports one set of connected Bluetooth Hearing Aid device at a time. Each method is protected with its appropriate permission.

Summary

Constants

String ACTION_CONNECTION_STATE_CHANGED

Intent used to broadcast the change in connection state of the Hearing Aid profile.

Inherited constants

Public methods

List<BluetoothDevice> getConnectedDevices()

Get connected devices for this specific profile.
For apps targeting Build.VERSION_CODES#S or or higher, this requires the Manifest.permission#BLUETOOTH_CONNECT permission which can be gained with Activity.requestPermissions(String[], int).

int getConnectionState(BluetoothDevice device)

Get the current connection state of the profile
For apps targeting Build.VERSION_CODES#S or or higher, this requires the Manifest.permission#BLUETOOTH_CONNECT permission which can be gained with Activity.requestPermissions(String[], int).

List<BluetoothDevice> getDevicesMatchingConnectionStates(int[] states)

Get a list of devices that match any of the given connection states.
For apps targeting Build.VERSION_CODES#S or or higher, this requires the Manifest.permission#BLUETOOTH_CONNECT permission which can be gained with Activity.requestPermissions(String[], int).

Inherited methods

Constants

ACTION_CONNECTION_STATE_CHANGED

Added in API level 29
public static final String ACTION_CONNECTION_STATE_CHANGED

Intent used to broadcast the change in connection state of the Hearing Aid profile. Please note that in the binaural case, there will be two different LE devices for the left and right side and each device will have their own connection state changes.S

This intent will have 3 extras:

BluetoothProfile.EXTRA_STATE or BluetoothProfile.EXTRA_PREVIOUS_STATE can be any of BluetoothProfile.STATE_DISCONNECTED, BluetoothProfile.STATE_CONNECTING, BluetoothProfile.STATE_CONNECTED, BluetoothProfile.STATE_DISCONNECTING.
For apps targeting Build.VERSION_CODES#R or lower, this requires the Manifest.permission#BLUETOOTH permission which can be gained with a simple <uses-permission> manifest tag.
For apps targeting Build.VERSION_CODES#S or or higher, this requires the Manifest.permission#BLUETOOTH_CONNECT permission which can be gained with Activity.requestPermissions(String[], int).
Requires Manifest.permission.BLUETOOTH_CONNECT

Constant Value: "android.bluetooth.hearingaid.profile.action.CONNECTION_STATE_CHANGED"

Public methods

getConnectedDevices

Added in API level 29
public List<BluetoothDevice> getConnectedDevices ()

Get connected devices for this specific profile.

Return the set of devices which are in state STATE_CONNECTED
For apps targeting Build.VERSION_CODES#S or or higher, this requires the Manifest.permission#BLUETOOTH_CONNECT permission which can be gained with Activity.requestPermissions(String[], int).
Requires Manifest.permission.BLUETOOTH_CONNECT

Returns
List<BluetoothDevice> This value cannot be null.

getConnectionState

Added in API level 29
public int getConnectionState (BluetoothDevice device)

Get the current connection state of the profile
For apps targeting Build.VERSION_CODES#S or or higher, this requires the Manifest.permission#BLUETOOTH_CONNECT permission which can be gained with Activity.requestPermissions(String[], int).
Requires Manifest.permission.BLUETOOTH_CONNECT

Parameters
device BluetoothDevice: This value cannot be null.

Returns
int Value is BluetoothProfile.STATE_DISCONNECTED, BluetoothProfile.STATE_CONNECTING, BluetoothProfile.STATE_CONNECTED, or BluetoothProfile.STATE_DISCONNECTING

getDevicesMatchingConnectionStates

Added in API level 29
public List<BluetoothDevice> getDevicesMatchingConnectionStates (int[] states)

Get a list of devices that match any of the given connection states.

If none of the devices match any of the given states, an empty list will be returned.
For apps targeting Build.VERSION_CODES#S or or higher, this requires the Manifest.permission#BLUETOOTH_CONNECT permission which can be gained with Activity.requestPermissions(String[], int).
Requires Manifest.permission.BLUETOOTH_CONNECT

Parameters
states int: This value cannot be null.

Returns
List<BluetoothDevice> This value cannot be null.