BluetoothHearingAid
class BluetoothHearingAid : BluetoothProfile
kotlin.Any | |
↳ | 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 | |
---|---|
static String |
Intent used to broadcast the change in connection state of the Hearing Aid profile. |
Inherited constants | |
---|---|
Public methods | |
---|---|
MutableList<BluetoothDevice!> |
Get connected devices for this specific profile. |
Int |
getConnectionState(device: BluetoothDevice) Get the current connection state of the profile |
MutableList<BluetoothDevice!> |
Get a list of devices that match any of the given connection states. |
Constants
ACTION_CONNECTION_STATE_CHANGED
static val ACTION_CONNECTION_STATE_CHANGED: String
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:
EXTRA_STATE
- The current state of the profile.EXTRA_PREVIOUS_STATE
- The previous state of the profile.BluetoothDevice#EXTRA_DEVICE
- The remote device.
EXTRA_STATE
or EXTRA_PREVIOUS_STATE
can be any of STATE_DISCONNECTED
, STATE_CONNECTING
, STATE_CONNECTED
, 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 android.app.Activity#requestPermissions(String[], int)
.
Requires android.Manifest.permission#BLUETOOTH_CONNECT
Value: "android.bluetooth.hearingaid.profile.action.CONNECTION_STATE_CHANGED"
Public methods
getConnectedDevices
fun getConnectedDevices(): MutableList<BluetoothDevice!>
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 android.app.Activity#requestPermissions(String[], int)
.
Requires android.Manifest.permission#BLUETOOTH_CONNECT
Return | |
---|---|
MutableList<BluetoothDevice!> |
This value cannot be null . |
getConnectionState
fun getConnectionState(device: BluetoothDevice): Int
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 android.app.Activity#requestPermissions(String[], int)
.
Requires android.Manifest.permission#BLUETOOTH_CONNECT
Parameters | |
---|---|
device |
BluetoothDevice: This value cannot be null . |
getDevicesMatchingConnectionStates
fun getDevicesMatchingConnectionStates(states: IntArray): MutableList<BluetoothDevice!>
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 android.app.Activity#requestPermissions(String[], int)
.
Requires android.Manifest.permission#BLUETOOTH_CONNECT
Parameters | |
---|---|
states |
IntArray: This value cannot be null . |
Return | |
---|---|
MutableList<BluetoothDevice!> |
This value cannot be null . |