IT. Expert System.

All Implemented Interfaces:

BluetoothProfile

public final class BluetoothHeadset
extends Object
implements BluetoothProfile

• Nested Class Summary

  • Nested classes/interfaces inherited from interface android.bluetooth.BluetoothProfile

    BluetoothProfile.ServiceListener

• Field Summary

  Fields

  Modifier and Type	Field and Description
  static String	ACTION_AUDIO_STATE_CHANGED Intent used to broadcast the change in the Audio Connection state of the A2DP profile.
  static String	ACTION_CONNECTION_STATE_CHANGED Intent used to broadcast the change in connection state of the Headset profile.
  static String	ACTION_VENDOR_SPECIFIC_HEADSET_EVENT Intent used to broadcast that the headset has posted a vendor-specific event.
  static int	AT_CMD_TYPE_ACTION AT command type ACTION used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, AT+CHUP.
  static int	AT_CMD_TYPE_BASIC AT command type BASIC used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, ATD.
  static int	AT_CMD_TYPE_READ AT command type READ used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, AT+VGM?.
  static int	AT_CMD_TYPE_SET AT command type SET used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, AT+VGM=.
  static int	AT_CMD_TYPE_TEST AT command type TEST used with EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE For example, AT+VGM=?.
  static 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.
  static 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.
  static 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.
  static int	STATE_AUDIO_CONNECTED Headset state when SCO audio is connected.
  static int	STATE_AUDIO_CONNECTING Headset state when SCO audio is connecting.
  static int	STATE_AUDIO_DISCONNECTED Headset state when SCO audio is not connected.
  static String	VENDOR_SPECIFIC_HEADSET_EVENT_COMPANY_ID_CATEGORY The intent category to be used with ACTION_VENDOR_SPECIFIC_HEADSET_EVENT for the companyId

  • Fields inherited from interface android.bluetooth.BluetoothProfile

    A2DP, EXTRA_PREVIOUS_STATE, EXTRA_STATE, HEADSET, HEALTH, INPUT_DEVICE, PAN, PBAP, PRIORITY_AUTO_CONNECT, PRIORITY_OFF, PRIORITY_ON, PRIORITY_UNDEFINED, STATE_CONNECTED, STATE_CONNECTING, STATE_DISCONNECTED, STATE_DISCONNECTING

• Method Summary

  Methods

  Modifier and Type	Method and Description
  boolean	acceptIncomingConnect(BluetoothDevice device) Accept the incoming connection.
  void	clccResponse(int index, int direction, int status, int mode, boolean mpty, String number, int type) Send Headset of CLCC response
  boolean	connect(BluetoothDevice device) Initiate connection to a profile of the remote bluetooth device.
  boolean	connectAudio() Initiates a connection of headset audio.
  boolean	disconnect(BluetoothDevice device) Initiate disconnection from a profile
  boolean	disconnectAudio() Initiates a disconnection of headset audio.
  int	getAudioState(BluetoothDevice device) Get the current audio state of the Headset.
  int	getBatteryUsageHint(BluetoothDevice device) Get battery usage hint for Bluetooth Headset service.
  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.
  int	getPriority(BluetoothDevice device) Get the priority of the profile.
  boolean	isAudioConnected(BluetoothDevice device) Check if Bluetooth SCO audio is connected.
  boolean	isAudioOn() Check if Bluetooth SCO audio is connected.
  static boolean	isBluetoothVoiceDialingEnabled(Context context) Indicates if current platform supports voice dialing over bluetooth SCO.
  void	phoneStateChanged(int numActive, int numHeld, int callState, String number, int type) Notify Headset of phone state change.
  boolean	rejectIncomingConnect(BluetoothDevice device) Reject the incoming connection.
  void	roamChanged(boolean roaming) Notify Headset of phone roam state change.
  boolean	setPriority(BluetoothDevice device, int priority) Set priority of the profile
  boolean	startScoUsingVirtualVoiceCall(BluetoothDevice device) Initiates a SCO channel connection with the headset (if connected).
  boolean	startVoiceRecognition(BluetoothDevice device) Start Bluetooth voice recognition.
  boolean	stopScoUsingVirtualVoiceCall(BluetoothDevice device) Terminates an ongoing SCO connection and the associated virtual call.
  boolean	stopVoiceRecognition(BluetoothDevice device) Stop Bluetooth Voice Recognition mode, and shut down the Bluetooth audio path.

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Field Detail

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

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

    Requires android.Manifest.permission#BLUETOOTH permission to receive.

    See Also:

    Constant Field Values

  • 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 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_AUDIO_CONNECTED, STATE_AUDIO_DISCONNECTED,

    Requires android.Manifest.permission#BLUETOOTH permission to receive.

    See Also:

    Constant Field Values

  • 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 Device
    • EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD - The vendor specific command
    • EXTRA_VENDOR_SPECIFIC_HEADSET_EVENT_CMD_TYPE - The AT command type which can be one of AT_CMD_TYPE_READ, AT_CMD_TYPE_TEST, or AT_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

    Requires android.Manifest.permission#BLUETOOTH permission to receive.

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

  • 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=.

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

  • 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

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

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

    See Also:

    Constant Field Values

• Method Detail

  • connect

    public boolean connect(BluetoothDevice device)

    Initiate connection to a profile of the remote bluetooth device.

    Currently, the system supports only 1 connection to the headset/handsfree profile. The API will automatically disconnect connected devices before connecting.

    This API returns false in scenarios like the profile on the device is already connected or Bluetooth is not turned on. When this API returns true, it is guaranteed that connection state intent for the profile will be broadcasted with the state. Users can get the connection state of the profile from this intent.

    Requires android.Manifest.permission#BLUETOOTH_ADMIN permission.

    Parameters:

    device - Remote Bluetooth Device

    Returns:

    false on immediate error, true otherwise

  • disconnect

    public boolean disconnect(BluetoothDevice device)

    Initiate disconnection from a profile

    This API will return false in scenarios like the profile on the Bluetooth device is not in connected state etc. When this API returns, true, it is guaranteed that the connection state change intent will be broadcasted with the state. Users can get the disconnection state of the profile from this intent.

    If the disconnection is initiated by a remote device, the state will transition from BluetoothProfile.STATE_CONNECTED to BluetoothProfile.STATE_DISCONNECTED. If the disconnect is initiated by the host (local) device the state will transition from BluetoothProfile.STATE_CONNECTED to state BluetoothProfile.STATE_DISCONNECTING to state BluetoothProfile.STATE_DISCONNECTED. The transition to BluetoothProfile.STATE_DISCONNECTING can be used to distinguish between the two scenarios.

    Requires android.Manifest.permission#BLUETOOTH_ADMIN permission.

    Parameters:

    device - Remote Bluetooth Device

    Returns:

    false on immediate error, true otherwise

  • getConnectedDevices

    public List<BluetoothDevice> getConnectedDevices()

    Get connected devices for this specific profile.

    Return the set of devices which are in state BluetoothProfile.STATE_CONNECTED

    Requires android.Manifest.permission#BLUETOOTH permission.

    Specified by:

    getConnectedDevices in interface BluetoothProfile

    Returns:

    List of devices. The list will be empty on error.

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

    Requires android.Manifest.permission#BLUETOOTH permission.

    Specified by:

    getDevicesMatchingConnectionStates in interface BluetoothProfile

    Parameters:

    states - Array of states. States can be one of BluetoothProfile.STATE_CONNECTED, BluetoothProfile.STATE_CONNECTING, BluetoothProfile.STATE_DISCONNECTED, BluetoothProfile.STATE_DISCONNECTING,

    Returns:

    List of devices. The list will be empty on error.

  • getConnectionState

    public int getConnectionState(BluetoothDevice device)

    Get the current connection state of the profile

    Requires android.Manifest.permission#BLUETOOTH permission.

    Specified by:

    getConnectionState in interface BluetoothProfile

    Parameters:

    device - Remote bluetooth device.

    Returns:

    State of the profile connection. One of BluetoothProfile.STATE_CONNECTED, BluetoothProfile.STATE_CONNECTING, BluetoothProfile.STATE_DISCONNECTED, BluetoothProfile.STATE_DISCONNECTING

  • setPriority

    public boolean setPriority(BluetoothDevice device,
                      int priority)

    Set priority of the profile

    The device should already be paired. Priority can be one of BluetoothProfile.PRIORITY_ON or BluetoothProfile.PRIORITY_OFF,

    Requires android.Manifest.permission#BLUETOOTH_ADMIN permission.

    Parameters:

    device - Paired bluetooth device

    priority -

    Returns:

    true if priority is set, false on error

  • getPriority

    public int getPriority(BluetoothDevice device)

    Get the priority of the profile.

    The priority can be any of: BluetoothProfile.PRIORITY_AUTO_CONNECT, BluetoothProfile.PRIORITY_OFF, BluetoothProfile.PRIORITY_ON, BluetoothProfile.PRIORITY_UNDEFINED

    Requires android.Manifest.permission#BLUETOOTH permission.

    Parameters:

    device - Bluetooth device

    Returns:

    priority of the device

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

    Requires android.Manifest.permission#BLUETOOTH permission.

    Parameters:

    device - Bluetooth headset

    Returns:

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

  • stopVoiceRecognition

    public boolean stopVoiceRecognition(BluetoothDevice device)

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

    Requires android.Manifest.permission#BLUETOOTH permission.

    Parameters:

    device - Bluetooth headset

    Returns:

    false if there is no headset connected or on error, true otherwise

  • isAudioConnected

    public boolean isAudioConnected(BluetoothDevice device)

    Check if Bluetooth SCO audio is connected.

    Requires android.Manifest.permission#BLUETOOTH permission.

    Parameters:

    device - Bluetooth headset

    Returns:

    true if SCO is connected, false otherwise or on error

  • getBatteryUsageHint

    public int getBatteryUsageHint(BluetoothDevice device)

    Get battery usage hint for Bluetooth Headset service. This is a monotonically increasing integer. Wraps to 0 at Integer.MAX_INT, and at boot. Current implementation returns the number of AT commands handled since boot. This is a good indicator for spammy headset/handsfree units that can keep the device awake by polling for cellular status updates. As a rule of thumb, each AT command prevents the CPU from sleeping for 500 ms

    Parameters:

    device - the bluetooth headset.

    Returns:

    monotonically increasing battery usage hint, or a negative error code on error

  • isBluetoothVoiceDialingEnabled

    public static boolean isBluetoothVoiceDialingEnabled(Context context)

    Indicates if current platform supports voice dialing over bluetooth SCO.

    Returns:

    true if voice dialing over bluetooth is supported, false otherwise.

  • acceptIncomingConnect

    public boolean acceptIncomingConnect(BluetoothDevice device)

    Accept the incoming connection. Note: This is an internal function and shouldn't be exposed

  • rejectIncomingConnect

    public boolean rejectIncomingConnect(BluetoothDevice device)

    Reject the incoming connection.

  • getAudioState

    public int getAudioState(BluetoothDevice device)

    Get the current audio state of the Headset. Note: This is an internal function and shouldn't be exposed

  • isAudioOn

    public boolean isAudioOn()

    Check if Bluetooth SCO audio is connected.

    Requires android.Manifest.permission#BLUETOOTH permission.

    Returns:

    true if SCO is connected, false otherwise or on error

  • connectAudio

    public boolean connectAudio()

    Initiates a connection of headset audio. It setup SCO channel with remote connected headset device.

    Returns:

    true if successful false if there was some error such as there is no connected headset

  • disconnectAudio

    public boolean disconnectAudio()

    Initiates a disconnection of headset audio. It tears down the SCO channel from remote headset device.

    Returns:

    true if successful false if there was some error such as there is no connected SCO channel

  • startScoUsingVirtualVoiceCall

    public boolean startScoUsingVirtualVoiceCall(BluetoothDevice device)

    Initiates a SCO channel connection with the headset (if connected). Also initiates a virtual voice call for Handsfree devices as many devices do not accept SCO audio without a call. This API allows the handsfree device to be used for routing non-cellular call audio.

    Parameters:

    device - Remote Bluetooth Device

    Returns:

    true if successful, false if there was some error.

  • stopScoUsingVirtualVoiceCall

    public boolean stopScoUsingVirtualVoiceCall(BluetoothDevice device)

    Terminates an ongoing SCO connection and the associated virtual call.

    Parameters:

    device - Remote Bluetooth Device

    Returns:

    true if successful, false if there was some error.

  • phoneStateChanged

    public void phoneStateChanged(int numActive,
                         int numHeld,
                         int callState,
                         String number,
                         int type)

    Notify Headset of phone state change. This is a backdoor for phone app to call BluetoothHeadset since there is currently not a good way to get precise call state change outside of phone app.

  • roamChanged

    public void roamChanged(boolean roaming)

    Notify Headset of phone roam state change. This is a backdoor for phone app to call BluetoothHeadset since there is currently not a good way to get roaming state change outside of phone app.

  • clccResponse

    public void clccResponse(int index,
                    int direction,
                    int status,
                    int mode,
                    boolean mpty,
                    String number,
                    int type)

    Send Headset of CLCC response