Displays: Input & Clipboard

Input and Clipboard Parameters

Configure keyboard layout, key swapping, clipboard sharing, and scrolling behavior for the HTML5 Display client. These query string parameters are passed when accessing the client endpoint and control how the user interacts with the remote desktop session.

Access the HTML5 Display client interface

`GET /api/v1/display/`

Serves the HTML5 Display client web interface with optional URL-based configuration. This is the standardized API version of the root endpoint for RESTful compliance, versioned access, and API gateway integrations.

Example:

https://domain.com/api/v1/display/?displayId=10&readonly=true&decorations=false

Parameters

Name	In	Type	Required	Description
`keyboard`	query	boolean	No	Show on-screen virtual keyboard. Default: `false`
`keyboard_layout`	query	string	No	Keyboard layout (us, gb, fr, de, etc.). Default: `"us"`
`swap_keys`	query	boolean	No	Swap Cmd/Ctrl keys (useful for macOS). Default: `false`
`clipboard`	query	boolean	No	Enable clipboard sharing. Default: `true`
`clipboard_preferred_format`	query	string	No	Preferred clipboard format. Allowed values: `"text/plain"`, `"text/html"`, `"UTF8_STRING"`. Default: `"text/plain"`
`scroll_reverse_y`	query	string	No	Reverse vertical scrolling direction. Allowed values: `"auto"`, `"true"`, `"false"`. Default: `"auto"`
`scroll_reverse_x`	query	boolean	No	Reverse horizontal scrolling direction. Default: `false`

Response

<!DOCTYPE html>
<html>
<head><title>Hoody Display Client</title></head>
<body>
  <!-- Display HTML5 client interface -->
</body>
</html>

SDK Usage

const result = await client.display.accessClient({
  keyboard: true,
  keyboard_layout: "de",
  swap_keys: true,
  clipboard: true,
  clipboard_preferred_format: "text/html",
  scroll_reverse_y: "false",
  scroll_reverse_x: false,
});