Package org.robolectric.shadows

Class ShadowBluetoothHeadset

java.lang.Object

org.robolectric.shadows.ShadowBluetoothHeadset

@NotThreadSafe
@Implements(android.bluetooth.BluetoothHeadset.class)
public class ShadowBluetoothHeadset
extends Object

Shadow for BluetoothHeadset

Constructor Summary

Constructors

Constructor	Description
ShadowBluetoothHeadset()

Method Summary

Modifier and Type	Method	Description
void	addConnectedDevice(BluetoothDevice device)	Adds the given BluetoothDevice to the shadow's list of "connected devices"
void	addDevice(BluetoothDevice bluetoothDevice, int connectionState)	Adds the provided BluetoothDevice to the shadow profile's device list with an associated connectionState.
protected boolean	connect(BluetoothDevice device)	Overrides behavior of connect(android.bluetooth.BluetoothDevice).
protected boolean	disconnect(BluetoothDevice device)	Overrides behavior of disconnect(android.bluetooth.BluetoothDevice).
protected BluetoothDevice	getActiveDevice()
protected List<BluetoothDevice>	getConnectedDevices()	Overrides behavior of getConnectedDevices().
protected int	getConnectionState(BluetoothDevice device)	Overrides behavior of getConnectionState(android.bluetooth.BluetoothDevice).
protected List<BluetoothDevice>	getDevicesMatchingConnectionStates(int[] states)
protected boolean	isAudioConnected(BluetoothDevice bluetoothDevice)
protected boolean	isVoiceRecognitionSupported(BluetoothDevice device)	Checks whether the headset supports voice recognition.
void	removeDevice(BluetoothDevice bluetoothDevice)	Remove the given BluetoothDevice from the shadow profile's device list
protected boolean	sendVendorSpecificResultCode(BluetoothDevice device, String command, String arg)	Overrides behavior of sendVendorSpecificResultCode(android.bluetooth.BluetoothDevice,java.lang.String,java.lang.String).
protected boolean	setActiveDevice(BluetoothDevice bluetoothDevice)
void	setAllowsSendVendorSpecificResultCode(boolean allowsSendVendorSpecificResultCode)	Affects the behavior of BluetoothHeadset.sendVendorSpecificResultCode(android.bluetooth.BluetoothDevice, java.lang.String, java.lang.String)
void	setVoiceRecognitionSupported(boolean supported)	Sets whether the headset supports voice recognition.
protected boolean	startVoiceRecognition(BluetoothDevice bluetoothDevice)	Overrides behavior of startVoiceRecognition(android.bluetooth.BluetoothDevice).
protected boolean	stopVoiceRecognition(BluetoothDevice bluetoothDevice)	Overrides the behavior of stopVoiceRecognition(android.bluetooth.BluetoothDevice).

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowBluetoothHeadset

public ShadowBluetoothHeadset()

Method Details

getConnectedDevices

@Implementation
protected List<BluetoothDevice> getConnectedDevices()

Overrides behavior of getConnectedDevices(). Returns list of devices that is set up by call(s) to addConnectedDevice(android.bluetooth.BluetoothDevice) or connect(android.bluetooth.BluetoothDevice). Returns an empty list by default.

addConnectedDevice

public void addConnectedDevice(BluetoothDevice device)

Adds the given BluetoothDevice to the shadow's list of "connected devices"

addDevice

public void addDevice(BluetoothDevice bluetoothDevice,
 int connectionState)

Adds the provided BluetoothDevice to the shadow profile's device list with an associated connectionState. The provided connection state will be returned by getConnectionState(android.bluetooth.BluetoothDevice).

removeDevice

public void removeDevice(BluetoothDevice bluetoothDevice)

Remove the given BluetoothDevice from the shadow profile's device list

getConnectionState

@Implementation
protected int getConnectionState(BluetoothDevice device)

Overrides behavior of getConnectionState(android.bluetooth.BluetoothDevice).

Returns:

BluetoothProfile.STATE_CONNECTED if the given device has been previously added by a call to addConnectedDevice(android.bluetooth.BluetoothDevice) or connect(android.bluetooth.BluetoothDevice), and BluetoothProfile.STATE_DISCONNECTED otherwise.

getDevicesMatchingConnectionStates

@Implementation
protected List<BluetoothDevice> getDevicesMatchingConnectionStates(int[] states)

connect

@Implementation
protected boolean connect(BluetoothDevice device)

Overrides behavior of connect(android.bluetooth.BluetoothDevice). Returns true and adds device to the shadow profile's connected device list if device is currently disconnected, and returns false otherwise.

disconnect

@Implementation
protected boolean disconnect(BluetoothDevice device)

Overrides behavior of disconnect(android.bluetooth.BluetoothDevice). Returns true and removes device from the shadow profile's connected device list if device is currently connected, and returns false otherwise.

startVoiceRecognition

@Implementation
protected boolean startVoiceRecognition(BluetoothDevice bluetoothDevice)

Overrides behavior of startVoiceRecognition(android.bluetooth.BluetoothDevice). Returns false if 'bluetoothDevice' is null or voice recognition is already started. Users can listen to ACTION_AUDIO_STATE_CHANGED. If this function returns true, this intent will be broadcasted once with BluetoothProfile.EXTRA_STATE set to STATE_AUDIO_CONNECTING and once set to STATE_AUDIO_CONNECTED.

stopVoiceRecognition

@Implementation
protected boolean stopVoiceRecognition(BluetoothDevice bluetoothDevice)

Overrides the behavior of stopVoiceRecognition(android.bluetooth.BluetoothDevice). Returns false if voice recognition was not started or voice recognition has already ended on this headset. If this function returns true, ACTION_AUDIO_STATE_CHANGED intent is broadcasted with BluetoothProfile.EXTRA_STATE set to STATE_DISCONNECTED.

isAudioConnected

@Implementation
protected boolean isAudioConnected(BluetoothDevice bluetoothDevice)

sendVendorSpecificResultCode

@Implementation
protected boolean sendVendorSpecificResultCode(BluetoothDevice device,
 String command,
 String arg)

Overrides behavior of sendVendorSpecificResultCode(android.bluetooth.BluetoothDevice,java.lang.String,java.lang.String).

Returns:

'true' only if the given device has been previously added by a call to addConnectedDevice(android.bluetooth.BluetoothDevice) or connect(android.bluetooth.BluetoothDevice), and setAllowsSendVendorSpecificResultCode(boolean) has not been called with 'false' argument.

Throws:

IllegalArgumentException - if 'command' argument is null, per Android API

getActiveDevice

@Nullable
@Implementation(minSdk=28)
protected BluetoothDevice getActiveDevice()

setActiveDevice

@Implementation(minSdk=28)
protected boolean setActiveDevice(@Nullable
 BluetoothDevice bluetoothDevice)

setVoiceRecognitionSupported

public void setVoiceRecognitionSupported(boolean supported)

Sets whether the headset supports voice recognition.

By default voice recognition is supported.

See Also:

• isVoiceRecognitionSupported(BluetoothDevice)

isVoiceRecognitionSupported

@Implementation(minSdk=31)
protected boolean isVoiceRecognitionSupported(BluetoothDevice device)

Checks whether the headset supports voice recognition.

See Also:

• setVoiceRecognitionSupported(boolean)

setAllowsSendVendorSpecificResultCode

public void setAllowsSendVendorSpecificResultCode(boolean allowsSendVendorSpecificResultCode)

Affects the behavior of BluetoothHeadset.sendVendorSpecificResultCode(android.bluetooth.BluetoothDevice, java.lang.String, java.lang.String)

Parameters:

allowsSendVendorSpecificResultCode - can be set to 'false' to simulate the situation where the system is unable to send vendor-specific result codes to a device