BluetoothCsipSetCoordinator
class BluetoothCsipSetCoordinator : AutoCloseable, BluetoothProfile
| kotlin.Any | |
| ↳ | android.bluetooth.BluetoothCsipSetCoordinator |
This class provides the public APIs to control the Bluetooth CSIP set coordinator.
BluetoothCsipSetCoordinator is a proxy object for controlling the Bluetooth CSIP set Service via IPC. Use BluetoothAdapter.getProfileProxy to get the BluetoothCsipSetCoordinator proxy object.
Summary
| Constants | |
|---|---|
| static String |
Intent used to broadcast the change in connection state of the CSIS Client. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Unit |
close()Closes this resource, relinquishing any underlying resources. |
| 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. |
| Protected methods | |
|---|---|
| Unit |
finalize()Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |
Constants
ACTION_CSIS_CONNECTION_STATE_CHANGED
static val ACTION_CSIS_CONNECTION_STATE_CHANGED: String
Intent used to broadcast the change in connection state of the CSIS Client.
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.
Requires android.Manifest.permission#BLUETOOTH_CONNECT
Value: "android.bluetooth.action.CSIS_CONNECTION_STATE_CHANGED"Public methods
close
fun close(): Unit
Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.
| Exceptions | |
|---|---|
java.lang.Exception |
if this resource cannot be closed |
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 and android.Manifest.permission#BLUETOOTH_PRIVILEGED
| 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 and android.Manifest.permission#BLUETOOTH_PRIVILEGED
| Parameters | |
|---|---|
device |
BluetoothDevice?: This value may be null. |
| 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 and android.Manifest.permission#BLUETOOTH_PRIVILEGED
| Parameters | |
|---|---|
states |
IntArray: This value cannot be null. |
| Return | |
|---|---|
MutableList<BluetoothDevice!> |
This value cannot be null. |
Protected methods
finalize
protected 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 |