Displays: Input & Clipboard
Section titled “Displays: Input & Clipboard”This page documents the keyboard, clipboard, and scrolling parameters available on the HTML5 Display client. Use these parameters when embedding the display client via its API endpoint to control on-screen keyboard behavior, Cmd/Ctrl key swapping, clipboard sharing format, and scroll direction. Other configuration parameters (audio, video, notifications, debugging, etc.) are documented on dedicated pages.
Access the HTML5 Display client interface
Section titled “Access the HTML5 Display client interface”GET /api/v1/display/
Section titled “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 that supports the same configuration parameters via query string.
The endpoint accepts fragment-style query parameters that pre-configure the client on load. All parameters are optional; sensible defaults are applied when omitted.
Parameters
Section titled “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 (us, gb, fr, de, etc.) |
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. Allowed values: text/plain, text/html, UTF8_STRING |
scroll_reverse_y | query | string | No | "auto" | Reverse vertical scrolling direction (auto, true, false) |
scroll_reverse_x | query | boolean | No | false | Reverse horizontal scrolling direction |
Request Body
Section titled “Request Body”This endpoint accepts no request body.
Response
Section titled “Response”HTML5 Display client interface loaded successfully. The response body is the HTML5 client shell.
<!DOCTYPE html><html><head><title>Hoody Display Client</title></head><body> <!-- Display HTML5 client interface --></body></html>SDK Usage
Section titled “SDK Usage”curl -G "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com/api/v1/display/" \ --data-urlencode "keyboard=true" \ --data-urlencode "keyboard_layout=fr" \ --data-urlencode "swap_keys=true" \ --data-urlencode "clipboard=true" \ --data-urlencode "clipboard_preferred_format=text/html" \ --data-urlencode "scroll_reverse_y=true" \ --data-urlencode "scroll_reverse_x=false"import { HoodyClient } from 'hoody-sdk';
const client = new HoodyClient({ baseURL: 'https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com', token: process.env.HOODY_TOKEN });
await client.display.accessClient({ keyboard: true, keyboard_layout: 'fr', swap_keys: true, clipboard: true, clipboard_preferred_format: 'text/html', scroll_reverse_y: 'true', scroll_reverse_x: false,});