lib/input

Keyboard, pointer, touch, wheel and gamepad capture on the stream element, sent to the server as the text messages of the input protocol.

Keyboard: every event resolves to an X11 keysym through noVNC's key tables and KeyboardUtil, and what is held server-side is tracked per physical code so a keyup releases what its keydown pressed. While anything is held a kh heartbeat repeats the held keysyms so the server can release keys whose keyup was lost, and modifiers a trusted event reports up are healed. IME composition streams the preedit as momentary presses diffed per codepoint; a shortcut chord pressed mid-composition is held until the commit lands so it applies after the text. A soft keyboard types into the off-screen assist field, whose value is mirrored to the server by the same diff and emptied once nothing composes in it. Chords on non-Latin layouts resolve from the physical key position, and a chord whose modifier keydown never reached the server is sent self-contained, wrapped in the missing modifiers. macOS Command is remapped onto Control, and Windows defers a ControlLeft keydown briefly to tell AltGr apart.

Pointer: absolute positions map through the presenting sink (the canvas or <video> box) where the stream has a fixed size, and through the element's window math otherwise; motion is coalesced to one send per animation frame. Under pointer lock the payload is a relative delta, scaled to server pixels and quantized with a carried remainder. Gaming mode is document fullscreen plus pointer and keyboard lock. Touch is direct (tap, drag, long-press right click, two-finger scroll) or a trackpad emulation. Wheel events are classified as discrete wheel or trackpad and accumulated in fractional notches so no distance is lost. The server-drawn cursor is painted on a page canvas or applied as a CSS cursor.

Wire messages: kd,<keysym>, ku,<keysym>, kh,<keysym>,..., kr; m,<x>,<y>,<mask>,<magnitude> (absolute) and m2,<dx>,<dy>,<mask>,<magnitude> (relative; scroll pulses ride mask bits 3 to 7); p,<0|1> and SET_NATIVE_CURSOR_RENDERING,<0|1> on pointer lock changes; js,c, js,d, js,b, js,a and js,h for gamepads.

Classes

Input

Defined in: lib/input.js:1347

Captures input on the stream element and sends it to the server.

One instance is live per page: attach detaches any previous one. Hotkeys: Ctrl+Shift+M opens the dashboard menu (onmenuhotkey), Ctrl+Shift+F enters plain fullscreen (onfullscreenhotkey, enterFullscreen by default), Ctrl+Shift+X toggles gaming mode (ongaminghotkey, toggleGamingMode by default), Ctrl+Shift+G toggles the gamepad overlay (ongamepadhotkey), and Ctrl+Shift+Click takes pointer lock; shortcutsEnabled false passes every one of them to the session instead. Three quick Escape presses in a row also leave gaming mode (_escapeHatch), whatever that flag says. Elements carrying the allow-native-input class keep native keyboard and touch handling.

Constructors

Constructor

new Input(
   element, 
   send, 
   isSharedMode?, 
   playerIndex?, 
   useCssScaling?, 
   initialSlot?
): Input;

Defined in: lib/input.js:1356

Parameters

Parameter	Type	Default value	Description
`element`	`HTMLElement`	`undefined`	Overlay element the stream input lands on; it also hosts IME composition.
`send`	(`message`) => `void`	`undefined`	Sends one input protocol message to the server.
`isSharedMode?`	`boolean`	`false`	Viewer-only session: listeners are limited to suppressing touch defaults.
`playerIndex?`	`number`	`0`	Gamepad slot used while the server has assigned no controller slot.
`useCssScaling?`	`boolean`	`false`	Whether the stream is realized in CSS pixels, so no device pixel ratio applies.
`initialSlot?`	`number`	`null`	One-based controller slot assigned by the server.

Parameter	Type	Description
`cursorData`	{ `curdata?`: `string`; `handle`: `string` \| `number`; `hotx?`: `string` \| `number`; `hoty?`: `string` \| `number`; }	Base64 PNG and hotspot as the server sends them.
`cursorData.curdata?`	`string`	-
`cursorData.handle`	`string` \| `number`	-
`cursorData.hotx?`	`string` \| `number`	-
`cursorData.hoty?`	`string` \| `number`	-

Parameter	Type	Description
`layouts`	{ }	-
`ownId`	`string`	Display id this page renders.

On this page