BluetoothA2dp
class BluetoothA2dp : BluetoothProfile
| kotlin.Any | |
| ↳ | 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 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 | |
|---|---|
| static String |
Intent used to broadcast the change in connection state of the A2DP profile. |
| static String |
Intent used to broadcast the change in the Playing state of the A2DP profile. |
| static String |
Used as an int extra field in |
| static Int |
A2DP sink device is NOT streaming music. |
| static Int |
A2DP sink device is streaming music. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Unit |
finalize()Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |
| MutableList<BluetoothDevice!>! |
Get connected devices for this specific profile. |
| Int |
getConnectionState(device: BluetoothDevice!)Get the current connection state of the profile |
| MutableList<BluetoothDevice!>! |
getDevicesMatchingConnectionStates(states: IntArray!)Get a list of devices that match any of the given connection states. |
| MutableCollection<BluetoothCodecType!> |
Returns the list of source codecs that are supported by the current platform. |
| Boolean |
isA2dpPlaying(device: BluetoothDevice!)Check if A2DP profile is streaming music. |
Constants
ACTION_CONNECTION_STATE_CHANGED
static val ACTION_CONNECTION_STATE_CHANGED: String
Intent used to broadcast the change in connection state of the A2DP profile.
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_DISCONNECTED_REASON- The reason for the profile disconnection in case the new state isSTATE_DISCONNECTED.
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.a2dp.profile.action.CONNECTION_STATE_CHANGED"ACTION_PLAYING_STATE_CHANGED
static val ACTION_PLAYING_STATE_CHANGED: String
Intent used to broadcast the change in the Playing state of the A2DP profile.
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_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 android.app.Activity#requestPermissions(String[], int).
Requires android.Manifest.permission#BLUETOOTH_CONNECT
Value: "android.bluetooth.a2dp.profile.action.PLAYING_STATE_CHANGED"EXTRA_DISCONNECTED_REASON
static val EXTRA_DISCONNECTED_REASON: String
Used as an int extra field in BluetoothA2dp.ACTION_CONNECTION_STATE_CHANGED intents for connection failure reason. The value is one of
BluetoothStatusCodes.SUCCESS,BluetoothStatusCodes.ERROR_UNKNOWN,BluetoothStatusCodes.ERROR_INSUFFICIENT_RESOURCES,BluetoothStatusCodes.ERROR_SDP_DISCOVERY_FAILED,BluetoothStatusCodes.ERROR_STREAM_CONNECTION_FAILED,BluetoothStatusCodes.ERROR_ROLE_SWITCH_FAILED,BluetoothStatusCodes.ERROR_AVDTP_DISCOVERY_FAILED.
Value: "android.bluetooth.a2dp.extra.DISCONNECTED_REASON"STATE_NOT_PLAYING
static val STATE_NOT_PLAYING: Int
A2DP sink device is NOT streaming music. This state can be one of EXTRA_STATE or EXTRA_PREVIOUS_STATE of ACTION_PLAYING_STATE_CHANGED intent.
Value: 11STATE_PLAYING
static val STATE_PLAYING: Int
A2DP sink device is streaming music. This state can be one of EXTRA_STATE or EXTRA_PREVIOUS_STATE of ACTION_PLAYING_STATE_CHANGED intent.
Value: 10Public methods
finalize
fun finalize(): Unit
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.
| Exceptions | |
|---|---|
java.lang.Throwable |
the Exception raised by this method |
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!>! |
List of devices. The list will be empty on error. |
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!: Remote bluetooth device. |
| Return | |
|---|---|
Int |
Value is one of the following: |
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!: Array of states. States can be one of STATE_CONNECTED, STATE_CONNECTING, STATE_DISCONNECTED, STATE_DISCONNECTING, |
| Return | |
|---|---|
MutableList<BluetoothDevice!>! |
List of devices. The list will be empty on error. |
getSupportedCodecTypes
fun getSupportedCodecTypes(): MutableCollection<BluetoothCodecType!>
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 android.Manifest.permission#BLUETOOTH_PRIVILEGED
| Return | |
|---|---|
MutableCollection<BluetoothCodecType!> |
list of supported source codec types. This value cannot be null. |
isA2dpPlaying
fun isA2dpPlaying(device: BluetoothDevice!): Boolean
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 android.app.Activity#requestPermissions(String[], int).
Requires android.Manifest.permission#BLUETOOTH_CONNECT
| Parameters | |
|---|---|
device |
BluetoothDevice!: BluetoothDevice device |