Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0 px
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents

This object allows you to emulate USB HID devices, but currently, the only supported type of device is a USB keyboard. 

BrightSign players with USB-C (except for LS3 and LS4) can use this object.

Warning
titleImportant

USB keyboard codes are different from PS/2, ASCII, and BrightSign keyboard codes. 

ifUsbHidEmulator 

Enable() As Boolean 

Enables the HID device. This method returns true on success. If there's a failure, use GetFailureReason() to get the reason for the failure. 

KeyDown(a As Integer) As Boolean 

Sends a keydown event for the specified USB key code. This method returns true on success. If there's a failure, use GetFailureReason() to get the reason for the failure. 

Note
titleNote

USB keyboards only have 6-key rollover, therefore only six keys can be down at one time.

KeyUp(a As Integer) As Boolean 

Sends a keyup event for the specified USB key code. This method returns true on success, and returns fails on failure (e.g. if the specified key was not already down). If there's a failure, use GetFailureReason() to get the reason for the failure. 

KeyPress(a As Integer) As Boolean 

Equivalent to KeyDown(key code) followed by KeyUp(key code). This method allows you to avoid leaving keys stuck down. 

Clear() As Boolean 

Clears all active keystrokes and modifiers.

GetModifierState() As Object

Returns an associative array with the current state of all modifiers (i.e. shift, alt, ctrl). 

SetModifierState(a As Object) As Boolean 

Sets the current modifier state as specified by an associative array. Only modifiers that are listed will cause the state to change.

Note
titleNote

Modifiers will persist until changed or Clear() is called. 


Code Block
languagejs
titleExample
hidkey.SetModifierState({ LeftShift : true });
GetLedState() As Object

Returns an associative array with the current state of all LED states on the keyboard. 

Note
titleNote

The host may send an LED state change if a lock key (i.e. Number Lock, Capital Lock, Scrolling Lock) is pressed, generating theroUsbHidLedEmulatorEvent object. The GetLedState() method can be used to get the current LED state without using an event. 

ifUserData

SetUserData(user_data As Object) 

Sets the user data that will be returned when events are raised. 

GetUserData() As Object 

Returns the user data that has previously been set via SetUserData(). It will return Invalid if no data has been set. 

ifMessagePort

SetPort(port as roMessagePort)

Posts messages of type roUsbHidEmulatorLedEvent to the attached message port. 

ifFailureReason 

GetFailureReason() As String 

Returns additional information if a method fails.