Added in API level 11

Summary: Constants | Inherited Constants | Methods | Inherited Methods

BluetoothA2dp

Kotlin |Java

public final class BluetoothA2dp
extends Object implements BluetoothProfile

java.lang.Object
↳	android.bluetooth.BluetoothA2dp

This class provides the public APIs to control the Bluetooth A2DP profile.

BluetoothA2dp is a proxy object for controlling the Bluetooth A2DP Service via IPC. Use BluetoothAdapter.getProfileProxy(Context, ServiceListener, int) to get the BluetoothA2dp proxy object.

Android only supports one connected Bluetooth A2dp 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 A2DP profile.
`String`	`ACTION_PLAYING_STATE_CHANGED` Intent used to broadcast the change in the Playing state of the A2DP profile.
`int`	`STATE_NOT_PLAYING` A2DP sink device is NOT streaming music.
`int`	`STATE_PLAYING` A2DP sink device is streaming music.

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` SAP Profile
`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
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`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)`.
`Collection<BluetoothCodecType>`	`getSupportedCodecTypes()` Returns the list of source codecs that are supported by the current platform.
`boolean`	`isA2dpPlaying(BluetoothDevice device)` Check if A2DP profile is streaming music.

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 11

public static final String ACTION_CONNECTION_STATE_CHANGED

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

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.a2dp.profile.action.CONNECTION_STATE_CHANGED"

ACTION_PLAYING_STATE_CHANGED

Added in API level 11

public static final String ACTION_PLAYING_STATE_CHANGED

Intent used to broadcast the change in the Playing state of the A2DP profile.

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 STATE_PLAYING, STATE_NOT_PLAYING,
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.a2dp.profile.action.PLAYING_STATE_CHANGED"

STATE_NOT_PLAYING

Added in API level 11

public static final int STATE_NOT_PLAYING

A2DP sink device is NOT streaming music. This state can be one of BluetoothProfile.EXTRA_STATE or BluetoothProfile.EXTRA_PREVIOUS_STATE of ACTION_PLAYING_STATE_CHANGED intent.

Constant Value: 11 (0x0000000b)

STATE_PLAYING

Added in API level 11

public static final int STATE_PLAYING

A2DP sink device is streaming music. This state can be one of BluetoothProfile.EXTRA_STATE or BluetoothProfile.EXTRA_PREVIOUS_STATE of ACTION_PLAYING_STATE_CHANGED intent.

Constant Value: 10 (0x0000000a)

Public methods

finalize

Added in API level 11

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

getConnectedDevices

Added in API level 11

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>`	List of devices. The list will be empty on error.

getConnectionState

Added in API level 11

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`: Remote bluetooth device.

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

getDevicesMatchingConnectionStates

Added in API level 11

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`: Array of states. States can be one of `BluetoothProfile.STATE_CONNECTED`, `BluetoothProfile.STATE_CONNECTING`, `BluetoothProfile.STATE_DISCONNECTED`, `BluetoothProfile.STATE_DISCONNECTING`,

Returns
`List<BluetoothDevice>`	List of devices. The list will be empty on error.

getSupportedCodecTypes

Added in API level 35

public Collection<BluetoothCodecType> getSupportedCodecTypes ()

Returns the list of source codecs that are supported by the current platform.

The list always includes the mandatory SBC codec, and may include optional proprietary codecs.
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.
Requires Manifest.permission.BLUETOOTH_PRIVILEGED

Returns
`Collection<BluetoothCodecType>`	list of supported source codec types This value cannot be `null`.

isA2dpPlaying

Added in API level 11

public boolean isA2dpPlaying (BluetoothDevice device)

Check if A2DP profile is streaming music.
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

Parameters
`device`	`BluetoothDevice`: BluetoothDevice device

Returns
`boolean`