BluetoothHeadset
public
final
class
BluetoothHeadset
extends Object
implements
BluetoothProfile
| java.lang.Object | |
| ↳ | android.bluetooth.BluetoothHeadset |
Public API for controlling the Bluetooth Headset Service. This includes both Bluetooth Headset and Handsfree (v1.5) profiles.
BluetoothHeadset is a proxy object for controlling the Bluetooth Headset Service via IPC.
Use BluetoothAdapter.getProfileProxy to get the BluetoothHeadset proxy object. Use
BluetoothAdapter.closeProfileProxy to close the service connection.
Android only supports one connected Bluetooth Headset at a time. Each method is protected with its appropriate permission.
Summary
Constants | |
|---|---|
String |
ACTION_AUDIO_STATE_CHANGED
Intent used to broadcast the change in the Audio Connection state of the HFP profile. |
String |
ACTION_CONNECTION_STATE_CHANGED
Intent used to broadcast the change in connection state of the Headset profile. |
String |
ACTION_VENDOR_SPECIFIC_HEADSET_EVENT
Intent used to broadcast that the headset has posted a vendor-specific event. |
int |
AT_CMD_TYPE_ACTION
AT command type ACTION used with |
int |
AT_CMD_TYPE_BASIC
AT command type BASIC used with |
int |
AT_CMD_TYPE_READ
AT command type READ used with |
int |
AT_CMD_TYPE_SET
AT command type SET used with |
int |
AT_CMD_TYPE_TEST
AT command type TEST used with |
String |
EXTRA_DISCONNECTED_REASON
Used as an int extra field in |
String |
EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_ARGS
A Parcelable String array extra field in |
String |
EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD
A String extra field in |
String |
EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE
An int extra field in |
int |
STATE_AUDIO_CONNECTED
Headset state when SCO audio is connected. |
int |
STATE_AUDIO_CONNECTING
Headset state when SCO audio is connecting. |
int |
STATE_AUDIO_DISCONNECTED
Headset state when SCO audio is not connected. |
String |
VENDOR_RESULT_CODE_COMMAND_ANDROID
A vendor-specific command for unsolicited result code. |
String |
VENDOR_SPECIFIC_HEADSET_EVENT_COMPANY_ID_CATEGORY
The intent category to be used with |
Inherited constants |
|---|
Public methods | |
|---|---|
List<BluetoothDevice>
|
getConnectedDevices()
Get connected devices for this specific profile.
|
int
|
getConnectionState(BluetoothDevice device)
Get the current connection state of the profile
|
List<BluetoothDevice>
|
getDevicesMatchingConnectionStates(int[] states)
Get a list of devices that match any of the given connection states.
|
boolean
|
isAudioConnected(BluetoothDevice device)
Check if Bluetooth SCO audio is connected. |
boolean
|
isNoiseReductionSupported(BluetoothDevice device)
Checks whether the headset supports some form of noise reduction. |
boolean
|
isVoiceRecognitionSupported(BluetoothDevice device)
Checks whether the headset supports voice recognition. |
boolean
|
sendVendorSpecificResultCode(BluetoothDevice device, String command, String arg)
Sends a vendor-specific unsolicited result code to the headset. |
boolean
|
startVoiceRecognition(BluetoothDevice device)
Start Bluetooth voice recognition. |
boolean
|
stopVoiceRecognition(BluetoothDevice device)
Stop Bluetooth Voice Recognition mode, and shut down the Bluetooth audio path. |
Protected methods | |
|---|---|
void
|
finalize()
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |
Inherited methods | |
|---|---|
Constants
ACTION_AUDIO_STATE_CHANGED
public static final String ACTION_AUDIO_STATE_CHANGED
Intent used to broadcast the change in the Audio Connection state of the HFP 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_AUDIO_CONNECTED, STATE_AUDIO_DISCONNECTED,.
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.headset.profile.action.AUDIO_STATE_CHANGED"
ACTION_CONNECTION_STATE_CHANGED
public static final String ACTION_CONNECTION_STATE_CHANGED
Intent used to broadcast the change in connection state of the Headset 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.EXTRA_DISCONNECTED_REASON- A disconnection reason if moved fromBluetoothProfile.STATE_CONNECTINGtoBluetoothProfile.STATE_DISCONNECTED.
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.headset.profile.action.CONNECTION_STATE_CHANGED"
ACTION_VENDOR_SPECIFIC_HEADSET_EVENT
public static final String ACTION_VENDOR_SPECIFIC_HEADSET_EVENT
Intent used to broadcast that the headset has posted a vendor-specific event.
This intent will have 4 extras and 1 category.
BluetoothDevice.EXTRA_DEVICE- The remote Bluetooth DeviceEXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD- The vendor specific commandEXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE- The AT command type which can be one ofAT_CMD_TYPE_READ,AT_CMD_TYPE_TEST, orAT_CMD_TYPE_SET,AT_CMD_TYPE_BASIC,AT_CMD_TYPE_ACTION.EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_ARGS- Command arguments.
The category is the Company ID of the vendor defining the vendor-specific command. BluetoothAssignedNumbers
For example, for Plantronics specific events Category will be VENDOR_SPECIFIC_HEADSET_EVENT_COMPANY_ID_CATEGORY.55
For example, an AT+XEVENT=foo,3 will get translated into
- EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD = +XEVENT
- EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE = AT_CMD_TYPE_SET
- EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_ARGS = foo, 3
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.headset.action.VENDOR_SPECIFIC_HEADSET_EVENT"
AT_CMD_TYPE_ACTION
public static final int AT_CMD_TYPE_ACTION
AT command type ACTION used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For
example, AT+CHUP. There are no arguments for action commands.
Constant Value: 4 (0x00000004)
AT_CMD_TYPE_BASIC
public static final int AT_CMD_TYPE_BASIC
AT command type BASIC used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For
example, ATD. Single character commands and everything following the character are arguments.
Constant Value: 3 (0x00000003)
AT_CMD_TYPE_READ
public static final int AT_CMD_TYPE_READ
AT command type READ used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For
example, AT+VGM?. There are no arguments for this command type.
Constant Value: 0 (0x00000000)
AT_CMD_TYPE_SET
public static final int AT_CMD_TYPE_SET
AT command type SET used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For
example, AT+VGM=
Constant Value: 2 (0x00000002)
AT_CMD_TYPE_TEST
public static final int AT_CMD_TYPE_TEST
AT command type TEST used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For
example, AT+VGM=?. There are no arguments for this command type.
Constant Value: 1 (0x00000001)
EXTRA_DISCONNECTED_REASON
public static final String EXTRA_DISCONNECTED_REASON
Used as an int extra field in ACTION_CONNECTION_STATE_CHANGED intents for connection
failure reasons.
The value is one of the following:
BluetoothStatusCodes.SUCCESSBluetoothStatusCodes.ERROR_UNKNOWNBluetoothStatusCodes.ERROR_INSUFFICIENT_RESOURCESBluetoothStatusCodes.ERROR_SDP_DISCOVERY_FAILEDBluetoothStatusCodes.ERROR_RFCOMM_CONNECTION_FAILED
Constant Value: "android.bluetooth.headset.extra.DISCONNECTED_REASON"
EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_ARGS
public static final String EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_ARGS
A Parcelable String array extra field in ACTION_VENDOR_SPECIFIC_HEADSET_EVENT
intents that contains the arguments to the vendor-specific command.
Constant Value: "android.bluetooth.headset.extra.VENDOR_SPECIFIC_HEADSET_EVENT_ARGS"
EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD
public static final String EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD
A String extra field in ACTION_VENDOR_SPECIFIC_HEADSET_EVENT intents that contains
the name of the vendor-specific command.
Constant Value: "android.bluetooth.headset.extra.VENDOR_SPECIFIC_HEADSET_EVENT_CMD"
EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE
public static final String EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE
An int extra field in ACTION_VENDOR_SPECIFIC_HEADSET_EVENT intents that contains the
AT command type of the vendor-specific command.
Constant Value: "android.bluetooth.headset.extra.VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE"
STATE_AUDIO_CONNECTED
public static final int STATE_AUDIO_CONNECTED
Headset state when SCO audio is connected. This state can be one of BluetoothProfile.EXTRA_STATE or
BluetoothProfile.EXTRA_PREVIOUS_STATE of ACTION_AUDIO_STATE_CHANGED intent.
Constant Value: 12 (0x0000000c)
STATE_AUDIO_CONNECTING
public static final int STATE_AUDIO_CONNECTING
Headset state when SCO audio is connecting. This state can be one of BluetoothProfile.EXTRA_STATE or
BluetoothProfile.EXTRA_PREVIOUS_STATE of ACTION_AUDIO_STATE_CHANGED intent.
Constant Value: 11 (0x0000000b)
STATE_AUDIO_DISCONNECTED
public static final int STATE_AUDIO_DISCONNECTED
Headset state when SCO audio is not connected. This state can be one of BluetoothProfile.EXTRA_STATE
or BluetoothProfile.EXTRA_PREVIOUS_STATE of ACTION_AUDIO_STATE_CHANGED intent.
Constant Value: 10 (0x0000000a)
VENDOR_RESULT_CODE_COMMAND_ANDROID
public static final String VENDOR_RESULT_CODE_COMMAND_ANDROID
A vendor-specific command for unsolicited result code.
Constant Value: "+ANDROID"
VENDOR_SPECIFIC_HEADSET_EVENT_COMPANY_ID_CATEGORY
public static final String VENDOR_SPECIFIC_HEADSET_EVENT_COMPANY_ID_CATEGORY
The intent category to be used with ACTION_VENDOR_SPECIFIC_HEADSET_EVENT for the
companyId
Constant Value: "android.bluetooth.headset.intent.category.companyid"
Public methods
getConnectedDevices
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
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 |
State of the profile connection. One of STATE_CONNECTED, STATE_CONNECTING, STATE_DISCONNECTED, STATE_DISCONNECTING
Value is one of the following: |
getDevicesMatchingConnectionStates
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. |
isAudioConnected
public boolean isAudioConnected (BluetoothDevice device)
Check if Bluetooth SCO audio is connected.
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: Bluetooth headset |
| Returns | |
|---|---|
boolean |
true if SCO is connected, false otherwise or on error |
isNoiseReductionSupported
public boolean isNoiseReductionSupported (BluetoothDevice device)
Checks whether the headset supports some form of noise reduction.
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: Bluetooth device.
This value cannot be null. |
| Returns | |
|---|---|
boolean |
true if echo cancellation and/or noise reduction is supported, false otherwise |
isVoiceRecognitionSupported
public boolean isVoiceRecognitionSupported (BluetoothDevice device)
Checks whether the headset supports voice recognition.
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: Bluetooth device.
This value cannot be null. |
| Returns | |
|---|---|
boolean |
true if voice recognition is supported, false otherwise |
sendVendorSpecificResultCode
public boolean sendVendorSpecificResultCode (BluetoothDevice device, String command, String arg)
Sends a vendor-specific unsolicited result code to the headset.
The actual string to be sent is command + ": " + arg. For example, if command is VENDOR_RESULT_CODE_COMMAND_ANDROID and arg is "0", the
string "+ANDROID: 0" will be sent.
Currently only VENDOR_RESULT_CODE_COMMAND_ANDROID is allowed as command.
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: Bluetooth headset. |
command |
String: A vendor-specific command. |
arg |
String: The argument that will be attached to the command. |
| Returns | |
|---|---|
boolean |
false if there is no headset connected, or if the command is not an allowed
vendor-specific unsolicited result code, or on error. true otherwise. |
| Throws | |
|---|---|
IllegalArgumentException |
if command is null. |
startVoiceRecognition
public boolean startVoiceRecognition (BluetoothDevice device)
Start Bluetooth voice recognition. This methods sends the voice recognition AT command to the headset and establishes the audio connection.
Users can listen to ACTION_AUDIO_STATE_CHANGED. If this function returns true,
this intent will be broadcasted with BluetoothProfile.EXTRA_STATE set to STATE_AUDIO_CONNECTING.
BluetoothProfile.EXTRA_STATE will transition from STATE_AUDIO_CONNECTING to STATE_AUDIO_CONNECTED when audio connection is established and to STATE_AUDIO_DISCONNECTED in case of failure to establish the audio connection.
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: Bluetooth headset |
| Returns | |
|---|---|
boolean |
false if there is no headset connected, or the connected headset doesn't support voice recognition, or voice recognition is already started, or audio channel is occupied, or on error, true otherwise |
stopVoiceRecognition
public boolean stopVoiceRecognition (BluetoothDevice device)
Stop Bluetooth Voice Recognition mode, and shut down the Bluetooth audio path.
Users can listen to ACTION_AUDIO_STATE_CHANGED. If this function returns true,
this intent will be broadcasted with BluetoothProfile.EXTRA_STATE set to STATE_AUDIO_DISCONNECTED.
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: Bluetooth headset |
| Returns | |
|---|---|
boolean |
false if there is no headset connected, or voice recognition has not started, or voice recognition has ended on this headset, or on error, true otherwise |
Protected methods
finalize
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.
| Throws | |
|---|---|
Throwable |
|