BluetoothHidDevice

Kotlin |Java

class BluetoothHidDevice : BluetoothProfile

kotlin.Any
↳	android.bluetooth.BluetoothHidDevice

Provides the public APIs to control the Bluetooth HID Device profile.

BluetoothHidDevice is a proxy object for controlling the Bluetooth HID Device Service via IPC. Use BluetoothAdapter#getProfileProxy to get the BluetoothHidDevice proxy object.

Summary

Nested classes
abstract	`Callback` The template class that applications use to call callback functions on events from the HID host.

Constants
static String	`ACTION_CONNECTION_STATE_CHANGED` Intent used to broadcast the change in connection state of the Input Host profile.
static Byte	`ERROR_RSP_INVALID_PARAM` Constant representing error response for Set Report due to "invalid parameter".
static Byte	`ERROR_RSP_INVALID_RPT_ID` Constant representing error response for Set Report due to "invalid report ID".
static Byte	`ERROR_RSP_NOT_READY` Constant representing error response for Set Report due to "not ready".
static Byte	`ERROR_RSP_SUCCESS` Constant representing success response for Set Report.
static Byte	`ERROR_RSP_UNKNOWN` Constant representing error response for Set Report with unknown reason.
static Byte	`ERROR_RSP_UNSUPPORTED_REQ` Constant representing error response for Set Report due to "unsupported request".
static Byte	`PROTOCOL_BOOT_MODE` Constant representing boot protocol mode used set by host.
static Byte	`PROTOCOL_REPORT_MODE` Constant representing report protocol mode used set by host.
static Byte	`REPORT_TYPE_FEATURE` Constant representing HID Feature Report type.
static Byte	`REPORT_TYPE_INPUT` Constant representing HID Input Report type.
static Byte	`REPORT_TYPE_OUTPUT` Constant representing HID Output Report type.
static Byte	`SUBCLASS1_COMBO` Constant representing combo keyboard and mouse subclass.
static Byte	`SUBCLASS1_KEYBOARD` Constant representing keyboard subclass.
static Byte	`SUBCLASS1_MOUSE` Constant representing mouse subclass.
static Byte	`SUBCLASS1_NONE` Constant representing unspecified HID device subclass.
static Byte	`SUBCLASS2_CARD_READER` Constant representing card reader subclass.
static Byte	`SUBCLASS2_DIGITIZER_TABLET` Constant representing digitizer tablet subclass.
static Byte	`SUBCLASS2_GAMEPAD` Constant representing gamepad subclass.
static Byte	`SUBCLASS2_JOYSTICK` Constant representing joystick subclass.
static Byte	`SUBCLASS2_REMOTE_CONTROL` Constant representing remote control subclass.
static Byte	`SUBCLASS2_SENSING_DEVICE` Constant representing sensing device subclass.
static Byte	`SUBCLASS2_UNCATEGORIZED` Constant representing uncategorized HID device subclass.

Inherited constants

From class BluetoothProfile

`Int`	`A2DP` A2DP profile.
`Int`	`CSIP_SET_COORDINATOR` Coordinated Set Identification Profile set coordinator
`String`	`EXTRA_PREVIOUS_STATE` Extra for the connection state intents of the individual profiles. This extra represents the previous connection state of the profile of the Bluetooth device.
`String`	`EXTRA_STATE` Extra for the connection state intents of the individual profiles. This extra represents the current connection state of the profile of the Bluetooth device.
`Int`	`GATT` GATT
`Int`	`GATT_SERVER` GATT_SERVER
`Int`	`HAP_CLIENT`
`Int`	`HEADSET` Headset and Handsfree profile
`Int`	`HEALTH` Health Profile
`Int`	`HEARING_AID` Hearing Aid Device
`Int`	`HID_DEVICE` HID Device
`Int`	`LE_AUDIO` LE Audio Device
`Int`	`SAP`
`Int`	`STATE_CONNECTED` The profile is in connected state
`Int`	`STATE_CONNECTING` The profile is in connecting state
`Int`	`STATE_DISCONNECTED` The profile is in disconnected state
`Int`	`STATE_DISCONNECTING` The profile is in disconnecting state

Public methods
Boolean	`connect(device: BluetoothDevice!)` Initiates connection to host which is currently paired with this device.
Boolean	`disconnect(device: BluetoothDevice!)` Disconnects from currently connected host.
MutableList<BluetoothDevice!>!	`getConnectedDevices()` Get connected devices for this specific profile.
Int	`getConnectionState(device: BluetoothDevice!)` 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)`.
MutableList<BluetoothDevice!>!	`getDevicesMatchingConnectionStates(states: IntArray!)` Get a list of devices that match any of the given connection states.
Boolean	`registerApp(sdp: BluetoothHidDeviceAppSdpSettings!, inQos: BluetoothHidDeviceAppQosSettings!, outQos: BluetoothHidDeviceAppQosSettings!, executor: Executor!, callback: BluetoothHidDevice.Callback!)` Registers application to be used for HID device.
Boolean	`replyReport(device: BluetoothDevice!, type: Byte, id: Byte, data: ByteArray!)` Sends report to remote host as reply for GET_REPORT request from `android.bluetooth.BluetoothHidDevice.Callback#onGetReport(android.bluetooth.BluetoothDevice,byte,byte,int)`.
Boolean	`reportError(device: BluetoothDevice!, error: Byte)` Sends error handshake message as reply for invalid SET_REPORT request from `android.bluetooth.BluetoothHidDevice.Callback#onSetReport(android.bluetooth.BluetoothDevice,byte,byte,byte[])`.
Boolean	`sendReport(device: BluetoothDevice!, id: Int, data: ByteArray!)` Sends report to remote host using interrupt channel.
Boolean	`unregisterApp()` Unregisters application.

Constants

ACTION_CONNECTION_STATE_CHANGED

Added in API level 28

static val ACTION_CONNECTION_STATE_CHANGED: String

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

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.
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 android.app.Activity#requestPermissions(String[], int).
Requires android.Manifest.permission#BLUETOOTH_CONNECT

Value: "android.bluetooth.hiddevice.profile.action.CONNECTION_STATE_CHANGED"

ERROR_RSP_INVALID_PARAM

Added in API level 28

static val ERROR_RSP_INVALID_PARAM: Byte

Constant representing error response for Set Report due to "invalid parameter".

Value: 4

See Also

android.bluetooth.BluetoothHidDevice.Callback#onSetReport(BluetoothDevice, byte, byte, byte[])

ERROR_RSP_INVALID_RPT_ID

Added in API level 28

static val ERROR_RSP_INVALID_RPT_ID: Byte

Constant representing error response for Set Report due to "invalid report ID".

Value: 2

See Also

android.bluetooth.BluetoothHidDevice.Callback#onSetReport(BluetoothDevice, byte, byte, byte[])

ERROR_RSP_NOT_READY

Added in API level 28

static val ERROR_RSP_NOT_READY: Byte

Constant representing error response for Set Report due to "not ready".

Value: 1

See Also

android.bluetooth.BluetoothHidDevice.Callback#onSetReport(BluetoothDevice, byte, byte, byte[])

ERROR_RSP_SUCCESS

Added in API level 28

static val ERROR_RSP_SUCCESS: Byte

Constant representing success response for Set Report.

Value: 0

See Also

android.bluetooth.BluetoothHidDevice.Callback#onSetReport(BluetoothDevice, byte, byte, byte[])

ERROR_RSP_UNKNOWN

Added in API level 28

static val ERROR_RSP_UNKNOWN: Byte

Constant representing error response for Set Report with unknown reason.

Value: 14

See Also

android.bluetooth.BluetoothHidDevice.Callback#onSetReport(BluetoothDevice, byte, byte, byte[])

ERROR_RSP_UNSUPPORTED_REQ

Added in API level 28

static val ERROR_RSP_UNSUPPORTED_REQ: Byte

Constant representing error response for Set Report due to "unsupported request".

Value: 3

See Also

android.bluetooth.BluetoothHidDevice.Callback#onSetReport(BluetoothDevice, byte, byte, byte[])

PROTOCOL_BOOT_MODE

Added in API level 28

static val PROTOCOL_BOOT_MODE: Byte

Constant representing boot protocol mode used set by host. Default is always PROTOCOL_REPORT_MODE unless notified otherwise.

Value: 0

See Also

android.bluetooth.BluetoothHidDevice.Callback#onSetProtocol(BluetoothDevice, byte)

PROTOCOL_REPORT_MODE

Added in API level 28

static val PROTOCOL_REPORT_MODE: Byte

Constant representing report protocol mode used set by host. Default is always PROTOCOL_REPORT_MODE unless notified otherwise.

Value: 1

See Also

android.bluetooth.BluetoothHidDevice.Callback#onSetProtocol(BluetoothDevice, byte)

REPORT_TYPE_FEATURE

Added in API level 28

static val REPORT_TYPE_FEATURE: Byte

Constant representing HID Feature Report type.

Value: 3

See Also

REPORT_TYPE_INPUT

Added in API level 28

static val REPORT_TYPE_INPUT: Byte

Constant representing HID Input Report type.

Value: 1

See Also

REPORT_TYPE_OUTPUT

Added in API level 28

static val REPORT_TYPE_OUTPUT: Byte

Constant representing HID Output Report type.

Value: 2

See Also

SUBCLASS1_COMBO

Added in API level 28

static val SUBCLASS1_COMBO: Byte

Constant representing combo keyboard and mouse subclass.

Value: -64

See Also

#registerApp

SUBCLASS1_KEYBOARD

Added in API level 28

static val SUBCLASS1_KEYBOARD: Byte

Constant representing keyboard subclass.

Value: 64

See Also

#registerApp

SUBCLASS1_MOUSE

Added in API level 28

static val SUBCLASS1_MOUSE: Byte

Constant representing mouse subclass.

Value: -128

See Also

#registerApp

SUBCLASS1_NONE

Added in API level 28

static val SUBCLASS1_NONE: Byte

Constant representing unspecified HID device subclass.

Value: 0

See Also

#registerApp

SUBCLASS2_CARD_READER

Added in API level 28

static val SUBCLASS2_CARD_READER: Byte

Constant representing card reader subclass.

Value: 6

See Also

#registerApp

SUBCLASS2_DIGITIZER_TABLET

Added in API level 28

static val SUBCLASS2_DIGITIZER_TABLET: Byte

Constant representing digitizer tablet subclass.

Value: 5

See Also

#registerApp

SUBCLASS2_GAMEPAD

Added in API level 28

static val SUBCLASS2_GAMEPAD: Byte

Constant representing gamepad subclass.

Value: 2

See Also

#registerApp

SUBCLASS2_JOYSTICK

Added in API level 28

static val SUBCLASS2_JOYSTICK: Byte

Constant representing joystick subclass.

Value: 1

See Also

#registerApp

SUBCLASS2_REMOTE_CONTROL

Added in API level 28

static val SUBCLASS2_REMOTE_CONTROL: Byte

Constant representing remote control subclass.

Value: 3

See Also

#registerApp

SUBCLASS2_SENSING_DEVICE

Added in API level 28

static val SUBCLASS2_SENSING_DEVICE: Byte

Constant representing sensing device subclass.

Value: 4

See Also

#registerApp

SUBCLASS2_UNCATEGORIZED

Added in API level 28

static val SUBCLASS2_UNCATEGORIZED: Byte

Constant representing uncategorized HID device subclass.

Value: 0

See Also

#registerApp

Public methods

connect

Added in API level 28

fun connect(device: BluetoothDevice!): Boolean

Initiates connection to host which is currently paired with this device. If the application is not registered, #connect(BluetoothDevice) will fail. The connection state should be tracked by the application by handling callback from Callback#onConnectionStateChanged. The connection state is not related to the return value of this method.
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

Return
`Boolean`	true if the command is successfully sent; otherwise false.

disconnect

Added in API level 28

fun disconnect(device: BluetoothDevice!): Boolean

Disconnects from currently connected host. The connection state should be tracked by the application by handling callback from Callback#onConnectionStateChanged. The connection state is not related to the return value of this method.
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

Return
`Boolean`	true if the command is successfully sent; otherwise false.

getConnectedDevices

Added in API level 28

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

Return
`MutableList<BluetoothDevice!>!`	List of devices. The list will be empty on error.

getConnectionState

Added in API level 28

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

Parameters
`device`	BluetoothDevice!: Remote bluetooth device.

Return
`Int`	State of the profile connection. One of `STATE_CONNECTED`, `STATE_CONNECTING`, `STATE_DISCONNECTED`, `STATE_DISCONNECTING` Value is `android.bluetooth.BluetoothProfile#STATE_DISCONNECTED`, `android.bluetooth.BluetoothProfile#STATE_CONNECTING`, `android.bluetooth.BluetoothProfile#STATE_CONNECTED`, or `android.bluetooth.BluetoothProfile#STATE_DISCONNECTING`

getDevicesMatchingConnectionStates

Added in API level 28

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

Parameters
`states`	IntArray!: Array of states. States can be one of `STATE_CONNECTED`, `STATE_CONNECTING`, `STATE_DISCONNECTED`, `STATE_DISCONNECTING`,

Return
`MutableList<BluetoothDevice!>!`	List of devices. The list will be empty on error.

registerApp

Added in API level 28

fun registerApp(
    sdp: BluetoothHidDeviceAppSdpSettings!, 
    inQos: BluetoothHidDeviceAppQosSettings!, 
    outQos: BluetoothHidDeviceAppQosSettings!, 
    executor: Executor!, 
    callback: BluetoothHidDevice.Callback!
): Boolean

Registers application to be used for HID device. Connections to HID Device are only possible when application is registered. Only one application can be registered at one time. When an application is registered, the HID Host service will be disabled until it is unregistered. When no longer used, application should be unregistered using unregisterApp(). The app will be automatically unregistered if it is not foreground. The registration status should be tracked by the application by handling callback from Callback#onAppStatusChanged. The app registration status is not related to the return value of this method.
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

Parameters
`sdp`	BluetoothHidDeviceAppSdpSettings!: `BluetoothHidDeviceAppSdpSettings` object of HID Device SDP record. The HID Device SDP record is required.
`inQos`	BluetoothHidDeviceAppQosSettings!: `BluetoothHidDeviceAppQosSettings` object of Incoming QoS Settings. The Incoming QoS Settings is not required. Use null or default BluetoothHidDeviceAppQosSettings.Builder for default values.
`outQos`	BluetoothHidDeviceAppQosSettings!: `BluetoothHidDeviceAppQosSettings` object of Outgoing QoS Settings. The Outgoing QoS Settings is not required. Use null or default BluetoothHidDeviceAppQosSettings.Builder for default values.
`executor`	Executor!: `Executor` object on which callback will be executed. The Executor object is required.
`callback`	BluetoothHidDevice.Callback!: `Callback` object to which callback messages will be sent. The Callback object is required.

Return
`Boolean`	true if the command is successfully sent; otherwise false.

replyReport

Added in API level 28

fun replyReport(
    device: BluetoothDevice!, 
    type: Byte, 
    id: Byte, 
    data: ByteArray!
): Boolean

Sends report to remote host as reply for GET_REPORT request from android.bluetooth.BluetoothHidDevice.Callback#onGetReport(android.bluetooth.BluetoothDevice,byte,byte,int).
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

Parameters
`type`	Byte: Report Type, as in request.
`id`	Byte: Report Id, as in request.
`data`	ByteArray!: Report data, not including Report Id.

Return
`Boolean`	true if the command is successfully sent; otherwise false.

reportError

Added in API level 28

fun reportError(
    device: BluetoothDevice!, 
    error: Byte
): Boolean

Sends error handshake message as reply for invalid SET_REPORT request from android.bluetooth.BluetoothHidDevice.Callback#onSetReport(android.bluetooth.BluetoothDevice,byte,byte,byte[]).
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

Parameters
`error`	Byte: Error to be sent for SET_REPORT via HANDSHAKE.

Return
`Boolean`	true if the command is successfully sent; otherwise false.

sendReport

Added in API level 28

fun sendReport(
    device: BluetoothDevice!, 
    id: Int, 
    data: ByteArray!
): Boolean

Sends report to remote host using interrupt channel.
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

Parameters
`id`	Int: Report Id, as defined in descriptor. Can be 0 in case Report Id are not defined in descriptor.
`data`	ByteArray!: Report data, not including Report Id.

Return
`Boolean`	true if the command is successfully sent; otherwise false.

unregisterApp

Added in API level 28

fun unregisterApp(): Boolean

Unregisters application. Active connection will be disconnected and no new connections will be allowed until registered again using (android.bluetooth.BluetoothHidDeviceAppQosSettings,android.bluetooth.BluetoothHidDeviceAppQosSettings,android.bluetooth.BluetoothHidDeviceAppQosSettings,java.util.concurrent.Executor,android.bluetooth.BluetoothHidDevice.Callback). The registration status should be tracked by the application by handling callback from Callback#onAppStatusChanged. The app registration status is not related to the return value of this method.
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

Return
`Boolean`	true if the command is successfully sent; otherwise false.