Android APIs
public final class

BluetoothHeadset

extends Object
implements BluetoothProfile
java.lang.Object
   ↳ android.bluetooth.BluetoothHeadset

Class Overview

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 getProfileProxy(Context, BluetoothProfile.ServiceListener, int) to get the BluetoothHeadset proxy object. Use closeProfileProxy(int, BluetoothProfile) 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 A2DP 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 EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, AT+CHUP.
int AT_CMD_TYPE_BASIC AT command type BASIC used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, ATD.
int AT_CMD_TYPE_READ AT command type READ used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, AT+VGM?.
int AT_CMD_TYPE_SET AT command type SET used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, AT+VGM=.
int AT_CMD_TYPE_TEST AT command type TEST used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, AT+VGM=?.
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.
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.
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.
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 ACTION_VENDOR_SPECIFIC_HEADSET_EVENT for the companyId
[Expand]
Inherited Constants
From interface android.bluetooth.BluetoothProfile
Public Methods
List<BluetoothDevice> getConnectedDevices()
Get connected devices for this specific profile.
int getConnectionState(BluetoothDevice device)
Get the current connection state of the profile

Requires BLUETOOTH permission.

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 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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.bluetooth.BluetoothProfile

Constants

public static final String ACTION_AUDIO_STATE_CHANGED

Added in API level 11

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

This intent will have 3 extras:

EXTRA_STATE or EXTRA_PREVIOUS_STATE can be any of STATE_AUDIO_CONNECTED, STATE_AUDIO_DISCONNECTED,

Requires BLUETOOTH permission to receive.

Constant Value: "android.bluetooth.headset.profile.action.AUDIO_STATE_CHANGED"

public static final String ACTION_CONNECTION_STATE_CHANGED

Added in API level 11

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

This intent will have 3 extras:

EXTRA_STATE or EXTRA_PREVIOUS_STATE can be any of STATE_DISCONNECTED, STATE_CONNECTING, STATE_CONNECTED, STATE_DISCONNECTING.

Requires BLUETOOTH permission to receive.

Constant Value: "android.bluetooth.headset.profile.action.CONNECTION_STATE_CHANGED"

public static final String ACTION_VENDOR_SPECIFIC_HEADSET_EVENT

Added in API level 11

Intent used to broadcast that the headset has posted a vendor-specific event.

This intent will have 4 extras and 1 category.

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

Requires BLUETOOTH permission to receive.

Constant Value: "android.bluetooth.headset.action.VENDOR_SPECIFIC_HEADSET_EVENT"

public static final int AT_CMD_TYPE_ACTION

Added in API level 11

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)

public static final int AT_CMD_TYPE_BASIC

Added in API level 11

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)

public static final int AT_CMD_TYPE_READ

Added in API level 11

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)

public static final int AT_CMD_TYPE_SET

Added in API level 11

AT command type SET used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, AT+VGM=.

Constant Value: 2 (0x00000002)

public static final int AT_CMD_TYPE_TEST

Added in API level 11

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)

public static final String EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_ARGS

Added in API level 11

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"

public static final String EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD

Added in API level 11

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"

public static final String EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE

Added in API level 11

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"

public static final int STATE_AUDIO_CONNECTED

Added in API level 11

Headset state when SCO audio is connected. This state can be one of EXTRA_STATE or EXTRA_PREVIOUS_STATE of ACTION_AUDIO_STATE_CHANGED intent.

Constant Value: 12 (0x0000000c)

public static final int STATE_AUDIO_CONNECTING

Added in API level 11

Headset state when SCO audio is connecting. This state can be one of EXTRA_STATE or EXTRA_PREVIOUS_STATE of ACTION_AUDIO_STATE_CHANGED intent.

Constant Value: 11 (0x0000000b)

public static final int STATE_AUDIO_DISCONNECTED

Added in API level 11

Headset state when SCO audio is not connected. This state can be one of EXTRA_STATE or EXTRA_PREVIOUS_STATE of ACTION_AUDIO_STATE_CHANGED intent.

Constant Value: 10 (0x0000000a)

public static final String VENDOR_RESULT_CODE_COMMAND_ANDROID

Added in API level 19

A vendor-specific command for unsolicited result code.

Constant Value: "+ANDROID"

public static final String VENDOR_SPECIFIC_HEADSET_EVENT_COMPANY_ID_CATEGORY

Added in API level 11

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

public List<BluetoothDevice> getConnectedDevices ()

Added in API level 11

Get connected devices for this specific profile.

Return the set of devices which are in state STATE_CONNECTED

Requires BLUETOOTH permission.

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

public int getConnectionState (BluetoothDevice device)

Added in API level 11

Get the current connection state of the profile

Requires BLUETOOTH permission.

Parameters
device Remote bluetooth device.
Returns
int State of the profile connection. One of STATE_CONNECTED, STATE_CONNECTING, STATE_DISCONNECTED, STATE_DISCONNECTING

public List<BluetoothDevice> getDevicesMatchingConnectionStates (int[] states)

Added in API level 11

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.

Requires BLUETOOTH permission.

Parameters
states Array of states. States can be one of STATE_CONNECTED, STATE_CONNECTING, STATE_DISCONNECTED, STATE_DISCONNECTING,
Returns
List<BluetoothDevice> List of devices. The list will be empty on error.

public boolean isAudioConnected (BluetoothDevice device)

Added in API level 11

Check if Bluetooth SCO audio is connected.

Requires BLUETOOTH permission.

Parameters
device Bluetooth headset
Returns
boolean true if SCO is connected, false otherwise or on error

public boolean sendVendorSpecificResultCode (BluetoothDevice device, String command, String arg)

Added in API level 19

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.

Requires BLUETOOTH permission.

Parameters
device Bluetooth headset.
command A vendor-specific command.
arg 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.

public boolean startVoiceRecognition (BluetoothDevice device)

Added in API level 11

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 EXTRA_STATE set to STATE_AUDIO_CONNECTING.

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.

Requires BLUETOOTH permission.

Parameters
device Bluetooth headset
Returns
boolean false if there is no headset connected of if the connected headset doesn't support voice recognition or on error, true otherwise

public boolean stopVoiceRecognition (BluetoothDevice device)

Added in API level 11

Stop Bluetooth Voice Recognition mode, and shut down the Bluetooth audio path.

Requires BLUETOOTH permission.

Parameters
device Bluetooth headset
Returns
boolean false if there is no headset connected or on error, true otherwise