BluetoothHidDevice

ACTION_CONNECTION_STATE_CHANGED

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

static val ERROR_RSP_INVALID_PARAM: Byte

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

Value: 4

ERROR_RSP_INVALID_RPT_ID

static val ERROR_RSP_INVALID_RPT_ID: Byte

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

Value: 2

ERROR_RSP_NOT_READY

static val ERROR_RSP_NOT_READY: Byte

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

Value: 1

ERROR_RSP_SUCCESS

static val ERROR_RSP_SUCCESS: Byte

Constant representing success response for Set Report.

Value: 0

ERROR_RSP_UNKNOWN

static val ERROR_RSP_UNKNOWN: Byte

Constant representing error response for Set Report with unknown reason.

Value: 14

ERROR_RSP_UNSUPPORTED_REQ

static val ERROR_RSP_UNSUPPORTED_REQ: Byte

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

Value: 3

PROTOCOL_BOOT_MODE

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

PROTOCOL_REPORT_MODE

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

REPORT_TYPE_FEATURE

static val REPORT_TYPE_FEATURE: Byte

Constant representing HID Feature Report type.

Value: 3

REPORT_TYPE_INPUT

static val REPORT_TYPE_INPUT: Byte

Constant representing HID Input Report type.

Value: 1

REPORT_TYPE_OUTPUT

static val REPORT_TYPE_OUTPUT: Byte

Constant representing HID Output Report type.

Value: 2

SUBCLASS1_COMBO

static val SUBCLASS1_COMBO: Byte

Constant representing combo keyboard and mouse subclass.

Value: -64

SUBCLASS1_KEYBOARD

static val SUBCLASS1_KEYBOARD: Byte

Constant representing keyboard subclass.

Value: 64

SUBCLASS1_MOUSE

static val SUBCLASS1_MOUSE: Byte

Constant representing mouse subclass.

Value: -128

SUBCLASS1_NONE

static val SUBCLASS1_NONE: Byte

Constant representing unspecified HID device subclass.

Value: 0

SUBCLASS2_CARD_READER

static val SUBCLASS2_CARD_READER: Byte

Constant representing card reader subclass.

Value: 6

SUBCLASS2_DIGITIZER_TABLET

static val SUBCLASS2_DIGITIZER_TABLET: Byte

Constant representing digitizer tablet subclass.

Value: 5

SUBCLASS2_GAMEPAD

static val SUBCLASS2_GAMEPAD: Byte

Constant representing gamepad subclass.

Value: 2

SUBCLASS2_JOYSTICK

static val SUBCLASS2_JOYSTICK: Byte

Constant representing joystick subclass.

Value: 1

SUBCLASS2_REMOTE_CONTROL

static val SUBCLASS2_REMOTE_CONTROL: Byte

Constant representing remote control subclass.

Value: 3

SUBCLASS2_SENSING_DEVICE

static val SUBCLASS2_SENSING_DEVICE: Byte

Constant representing sensing device subclass.

Value: 4

SUBCLASS2_UNCATEGORIZED

static val SUBCLASS2_UNCATEGORIZED: Byte

Constant representing uncategorized HID device subclass.

Value: 0

connect

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

disconnect

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

getConnectedDevices

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

getConnectionState

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

getDevicesMatchingConnectionStates

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

registerApp

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

replyReport

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

reportError

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

sendReport

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

unregisterApp

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