BluetoothHearingAid

Kotlin |Java

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

From interface android.bluetooth.BluetoothProfile

`int`	`A2DP` A2DP profile.
`int`	`CSIP_SET_COORDINATOR` Coordinated Set Identification Profile set coordinator
`String`	`EXTRA_PREVIOUS_STATE` Extra for the connection state intents of the individual profiles.
`String`	`EXTRA_STATE` Extra for the connection state intents of the individual profiles.
`int`	`GATT` GATT
`int`	`GATT_SERVER` GATT_SERVER
`int`	`HAP_CLIENT`
`int`	`HEADSET` Headset and Handsfree profile
`int`	`HEALTH` This constant was deprecated in API level 29. Health Device Profile (HDP) and MCAP protocol are no longer used. New apps should use Bluetooth Low Energy based solutions such as `BluetoothGatt`, `BluetoothAdapter.listenUsingL2capChannel()`, or `BluetoothDevice.createL2capChannel(int)`
`int`	`HEARING_AID` Hearing Aid Device
`int`	`HID_DEVICE` HID Device
`int`	`LE_AUDIO` LE Audio Device
`int`	`SAP`
`int`	`STATE_CONNECTED` The profile is in connected state
`int`	`STATE_CONNECTING` The profile is in connecting state
`int`	`STATE_DISCONNECTED` The profile is in disconnected state
`int`	`STATE_DISCONNECTING` The profile is in disconnecting state

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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.bluetooth.BluetoothProfile

`abstract List<BluetoothDevice>`	`getConnectedDevices()` Get connected devices for this specific profile.
`abstract int`	`getConnectionState(BluetoothDevice device)` Get the current connection state of the profile
`abstract List<BluetoothDevice>`	`getDevicesMatchingConnectionStates(int[] states)` Get a list of devices that match any of the given connection states.

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 - The current state of the profile.
BluetoothProfile.EXTRA_PREVIOUS_STATE- The previous state of the profile.
BluetoothDevice#EXTRA_DEVICE - The remote device.

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`.