Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#constants) \| [Inherited Constants](https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#inhconstants) \| [Methods](https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#inhmethods)

# BluetoothLeAudio

*** ** * ** ***


`
public

final

class
BluetoothLeAudio
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/java/lang/AutoCloseable,

https://developer.android.com/reference/android/bluetooth/BluetoothProfile


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.bluetooth.BluetoothLeAudio |

<br />

*** ** * ** ***

This class provides the public APIs to control the LeAudio profile.

BluetoothLeAudio is a proxy object for controlling the Bluetooth LE Audio Service via IPC. Use
`https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#getProfileProxy(android.content.Context,%20android.bluetooth.BluetoothProfile.ServiceListener,%20int)` to get the BluetoothLeAudio proxy object.

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

## Summary

| ### Constants ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#ACTION_LE_AUDIO_CONNECTION_STATE_CHANGED` Intent used to broadcast the change in connection state of the LeAudio profile. |
| `int` | `https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#GROUP_ID_INVALID` This represents an invalid group ID. |

### Inherited constants

From interface `https://developer.android.com/reference/android/bluetooth/BluetoothProfile` `int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#A2DP`

Advanced Audio Distribution Profile (A2DP)


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#CSIP_SET_COORDINATOR`

Coordinated Set Identification Profile (CSIP) set coordinator


`https://developer.android.com/reference/java/lang/String` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#EXTRA_PREVIOUS_STATE`

Extra for the connection state intents of the individual profiles.


`https://developer.android.com/reference/java/lang/String` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#EXTRA_PROFILE`

Extra for the `https://developer.android.com/reference/android/bluetooth/BluetoothProfile` that the intent applies to.


`https://developer.android.com/reference/java/lang/String` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#EXTRA_STATE`

Extra for the connection state intents of the individual profiles.


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#GATT`

Generic Attribute Profile (GATT)


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#GATT_SERVER`

Generic Attribute Profile (GATT) Server


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#HAP_CLIENT`


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#HEADSET`

Headset and Handsfree profile


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#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 `https://developer.android.com/reference/android/bluetooth/BluetoothGatt`, `https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#listenUsingL2capChannel()`, or `https://developer.android.com/reference/android/bluetooth/BluetoothDevice#createL2capChannel(int)`*


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#HEARING_AID`

Hearing Aid Device


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#HID_DEVICE`

Human Interface Device (HID) Device


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#LE_AUDIO`

LE Audio Device


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#SAP`

SIM Access Profile (SAP)


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_CONNECTED`

The profile is in connected state


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_CONNECTING`

The profile is in connecting state


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_DISCONNECTED`

The profile is in disconnected state


`int` `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_DISCONNECTING`

The profile is in disconnecting state


| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#close()() ` Closes this resource, relinquishing any underlying resources. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/bluetooth/BluetoothDevice>` | ` https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#getConnectedDevices()() ` Get connected devices for this specific profile. For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#S` or or higher, this requires the `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT` permission which can be gained with `https://developer.android.com/reference/android/app/Activity#requestPermissions(java.lang.String[],%20int)`. |
| ` https://developer.android.com/reference/android/bluetooth/BluetoothDevice` | ` https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#getConnectedGroupLeadDevice(int)(int groupId) ` Get Lead device for the group. |
| ` int` | ` https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#getConnectionState(android.bluetooth.BluetoothDevice)(https://developer.android.com/reference/android/bluetooth/BluetoothDevice device) ` Get the current connection state of the profile For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#R` or lower, this requires the `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH` permission which can be gained with a simple `<uses-permission>` manifest tag. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/bluetooth/BluetoothDevice>` | ` https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#getDevicesMatchingConnectionStates(int[])(int[] states) ` Get a list of devices that match any of the given connection states. For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#S` or or higher, this requires the `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT` permission which can be gained with `https://developer.android.com/reference/android/app/Activity#requestPermissions(java.lang.String[],%20int)`. |
| ` int` | ` https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#getGroupId(android.bluetooth.BluetoothDevice)(https://developer.android.com/reference/android/bluetooth/BluetoothDevice device) ` Get device group id. |

| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |

### Inherited methods

From class `

https://developer.android.com/reference/java/lang/Object

` `


https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`

Creates and returns a copy of this object.


`


boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`

Indicates whether some other object is "equal to" this one.


`


void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.


`


final

https://developer.android.com/reference/java/lang/Class<?>` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`

Returns the runtime class of this `Object`.


`


int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`

Returns a hash code value for the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`

Wakes up a single thread that is waiting on this object's
monitor.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`

Wakes up all threads that are waiting on this object's monitor.


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`

Returns a string representation of the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` `
https://developer.android.com/reference/java/lang/Object#wait(long)(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` `
https://developer.android.com/reference/java/lang/Object#wait()()
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.


From interface `

https://developer.android.com/reference/java/lang/AutoCloseable

` `
abstract


void` `
https://developer.android.com/reference/java/lang/AutoCloseable#close()()
`

Closes this resource, relinquishing any underlying resources.


From interface `

https://developer.android.com/reference/android/bluetooth/BluetoothProfile

` `
abstract


https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/bluetooth/BluetoothDevice>` `
https://developer.android.com/reference/android/bluetooth/BluetoothProfile#getConnectedDevices()()
`

Get connected devices for this specific profile.


`
abstract


int` `
https://developer.android.com/reference/android/bluetooth/BluetoothProfile#getConnectionState(android.bluetooth.BluetoothDevice)(https://developer.android.com/reference/android/bluetooth/BluetoothDevice device)
`

Get the current connection state of the profile


`
abstract


https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/bluetooth/BluetoothDevice>` `
https://developer.android.com/reference/android/bluetooth/BluetoothProfile#getDevicesMatchingConnectionStates(int[])(int[] states)
`

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


## Constants

### ACTION_LE_AUDIO_CONNECTION_STATE_CHANGED

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ACTION_LE_AUDIO_CONNECTION_STATE_CHANGED
```

Intent used to broadcast the change in connection state of the LeAudio 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.

This intent will have the following extras:

- `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#EXTRA_STATE` - The current state of the profile.
- `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#EXTRA_PREVIOUS_STATE`- The previous state of the profile.
- `https://developer.android.com/reference/android/bluetooth/BluetoothDevice#EXTRA_DEVICE` - The remote device.
- `https://developer.android.com/reference/android/bluetooth/BluetoothDevice#EXTRA_CLASS` - The class of the remote device, if available, when the new state is `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_CONNECTED`.
- `https://developer.android.com/reference/android/bluetooth/BluetoothDevice#EXTRA_LE_APPEARANCE` - The LE appearance of the remote device, if available, when the new state is `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_CONNECTED`.

`https://developer.android.com/reference/android/bluetooth/BluetoothProfile#EXTRA_STATE` or `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#EXTRA_PREVIOUS_STATE` can be any of `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_DISCONNECTED`, `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_CONNECTING`, `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_CONNECTED`, `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_DISCONNECTING`.


For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#R` or lower, this requires the `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH` permission which can be gained with a simple `<uses-permission>` manifest tag.


For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#S` or or higher, this requires the
`https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT` permission which can be gained with `https://developer.android.com/reference/android/app/Activity#requestPermissions(java.lang.String[],%20int)`.


Requires `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT`

<br />

Constant Value:

"android.bluetooth.action.LE_AUDIO_CONNECTION_STATE_CHANGED"


### GROUP_ID_INVALID

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int GROUP_ID_INVALID
```

This represents an invalid group ID.

<br />

Constant Value:

-1
(0xffffffff)


## Public methods

### close

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void close ()
```

Closes this resource, relinquishing any underlying resources.
This method is invoked automatically on objects managed by the
`try`-with-resources statement.

<br />

### getConnectedDevices

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<BluetoothDevice> getConnectedDevices ()
```

Get connected devices for this specific profile.

Return the set of devices which are in state `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_CONNECTED`


For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#S` or or higher, this requires the
`https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT` permission which can be gained with `https://developer.android.com/reference/android/app/Activity#requestPermissions(java.lang.String[],%20int)`.


Requires `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT`

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/bluetooth/BluetoothDevice>` | This value cannot be `null`. <br /> |

### getConnectedGroupLeadDevice

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public BluetoothDevice getConnectedGroupLeadDevice (int groupId)
```

Get Lead device for the group.

Lead device is the device that can be used as an active device in the system. Active
devices points to the Audio Device for the Le Audio group. This method returns the Lead
devices for the connected LE Audio group and this device should be used in the
setActiveDevice() method by other parts of the system, which wants to set to active a
particular Le Audio group.

Note: getActiveDevice() returns the Lead device for the currently active LE Audio group.
Note: When Lead device gets disconnected while Le Audio group is active and has more devices
in the group, then Lead device will not change. If Lead device gets disconnected, for the Le
Audio group which is not active, a new Lead device will be chosen.


For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#S` or or higher, this requires the
`https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT` permission which can be gained with `https://developer.android.com/reference/android/app/Activity#requestPermissions(java.lang.String[],%20int)`.


Requires `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT`

<br />

| Parameters ||
|---|---|
| `groupId` | `int`: The group id. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/bluetooth/BluetoothDevice` | group lead device. This value may be `null`. <br /> |

### getConnectionState

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getConnectionState (BluetoothDevice device)
```

Get the current connection state of the profile


For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#R` or lower, this requires the `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH` permission which can be gained with a simple `<uses-permission>` manifest tag.


For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#S` or or higher, this requires the
`https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT` permission which can be gained with `https://developer.android.com/reference/android/app/Activity#requestPermissions(java.lang.String[],%20int)`.


Requires `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT`

<br />

| Parameters ||
|---|---|
| `device` | `BluetoothDevice`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_DISCONNECTED` - `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_CONNECTING` - `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_CONNECTED` - `https://developer.android.com/reference/android/bluetooth/BluetoothProfile#STATE_DISCONNECTING` |

### getDevicesMatchingConnectionStates

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Build.VERSION_CODES#S` or or higher, this requires the
`https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT` permission which can be gained with `https://developer.android.com/reference/android/app/Activity#requestPermissions(java.lang.String[],%20int)`.


Requires `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT`

<br />

| Parameters ||
|---|---|
| `states` | `int`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/bluetooth/BluetoothDevice>` | This value cannot be `null`. <br /> |

### getGroupId

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getGroupId (BluetoothDevice device)
```

Get device group id. Devices with same group id belong to same group (i.e left and right
earbud).


For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#R` or lower, this requires the `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH` permission which can be gained with a simple `<uses-permission>` manifest tag.


For apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES#S` or or higher, this requires the
`https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT` permission which can be gained with `https://developer.android.com/reference/android/app/Activity#requestPermissions(java.lang.String[],%20int)`.


Requires `https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT`

<br />

| Parameters ||
|---|---|
| `device` | `BluetoothDevice`: LE Audio capable device. This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `int` | group id that this device currently belongs to, `https://developer.android.com/reference/android/bluetooth/BluetoothLeAudio#GROUP_ID_INVALID` when this device does not belong to any group <br /> |

## Protected methods

### finalize

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected void finalize ()
```

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
A subclass overrides the `finalize` method to dispose of
system resources or to perform other cleanup.


The general contract of `finalize` is that it is invoked
if and when the Java virtual
machine has determined that there is no longer any
means by which this object can be accessed by any thread that has
not yet died, except as a result of an action taken by the
finalization of some other object or class which is ready to be
finalized. The `finalize` method may take any action, including
making this object available again to other threads; the usual purpose
of `finalize`, however, is to perform cleanup actions before
the object is irrevocably discarded. For example, the finalize method
for an object that represents an input/output connection might perform
explicit I/O transactions to break the connection before the object is
permanently discarded.


The `finalize` method of class `Object` performs no
special action; it simply returns normally. Subclasses of
`Object` may override this definition.


The Java programming language does not guarantee which thread will
invoke the `finalize` method for any given object. It is
guaranteed, however, that the thread that invokes finalize will not
be holding any user-visible synchronization locks when finalize is
invoked. If an uncaught exception is thrown by the finalize method,
the exception is ignored and finalization of that object terminates.


After the `finalize` method has been invoked for an object, no
further action is taken until the Java virtual machine has again
determined that there is no longer any means by which this object can
be accessed by any thread that has not yet died, including possible
actions by other objects or classes which are ready to be finalized,
at which point the object may be discarded.


The `finalize` method is never invoked more than once by a Java
virtual machine for any given object.


Any exception thrown by the `finalize` method causes
the finalization of this object to be halted, but is otherwise
ignored.

<br />