Displays: Input & Clipboard

Access Display Client — Input & Clipboard

Configure keyboard behavior, clipboard sharing formats, and scroll direction when connecting to a display client. These parameters are passed as query strings on the GET /api/v1/display/ endpoint to customize the HTML5 client experience.

Use these parameters when you need to:

Enable an on-screen virtual keyboard for touch-only devices
Match the keyboard layout to the user’s physical keyboard
Swap Cmd and Ctrl for cross-platform workflows
Control clipboard synchronization format and behavior
Reverse scroll direction for trackpad or natural-scrolling preferences

Get Display Client

Parameters

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

`GET /api/v1/display/`

Serves the HTML5 Display client web interface with optional URL-based configuration. This versioned endpoint accepts the same query parameters as the root endpoint for full client customization.

Parameters

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

Response

{
  "description": "HTML5 Display client interface loaded successfully"
}

The endpoint returns an text/html response containing the HTML5 Display client interface.

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

SDK Usage

const client = new HoodyClient(config);

// Access the display client with input and clipboard configuration
await client.display.accessClient({
  keyboard: true,
  keyboard_layout: "fr",
  swap_keys: true,
  clipboard: true,
  clipboard_preferred_format: "text/html",
  scroll_reverse_y: "false",
  scroll_reverse_x: false
});

Example Request

curl -G "https://domain.com/api/v1/display/" \
  --data-urlencode "keyboard=true" \
  --data-urlencode "keyboard_layout=de" \
  --data-urlencode "swap_keys=true" \
  --data-urlencode "clipboard=true" \
  --data-urlencode "clipboard_preferred_format=text/html" \
  --data-urlencode "scroll_reverse_y=false" \
  --data-urlencode "scroll_reverse_x=false"