Displays: Debugging

Enable debug flags to troubleshoot the Hoody HTML5 Display client from the browser developer console. Each debug_* flag targets a specific client subsystem (main loop, network, keyboard, mouse, geometry, draw, clipboard, audio, file transfer) and prints verbose logs when set to true. Append the desired flags as query parameters on the Display client URL.

Browser example

https://67e89abc123def456789abcd-890abcdef12345678901cdef-display-1.node-example-1.containers.hoody.com/api/v1/display/?debug_main=true&debug_network=true&debug_keyboard=true

Enable debug logging on the Display client

`GET /api/v1/display/`

Returns the HTML5 Display client with one or more debug subsystems enabled. The endpoint accepts any combination of debug_* flags; unspecified subsystems run silently. Other client configuration parameters are documented separately.

Parameters

Name	In	Type	Required	Description
`debug_main`	query	boolean	No	Enable main debug logging. Default: `false`
`debug_network`	query	boolean	No	Enable network debug logging. Default: `false`
`debug_keyboard`	query	boolean	No	Enable keyboard debug logging. Default: `false`
`debug_mouse`	query	boolean	No	Enable mouse debug logging. Default: `false`
`debug_geometry`	query	boolean	No	Enable geometry debug logging. Default: `false`
`debug_draw`	query	boolean	No	Enable draw debug logging. Default: `false`
`debug_clipboard`	query	boolean	No	Enable clipboard debug logging. Default: `false`
`debug_audio`	query	boolean	No	Enable audio debug logging. Default: `false`
`debug_file`	query	boolean	No	Enable file transfer debug logging. Default: `false`

Response

The HTML5 Display client interface is served with the requested debug flags enabled. The response body is the client HTML document; verbose log lines from the enabled subsystems appear in the browser console.

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

Example request

The following request enables main, network, keyboard, mouse, and clipboard debug logging on display 1.

cURL
TypeScript SDK

curl "https://67e89abc123def456789abcd-890abcdef12345678901cdef-display-1.node-example-1.containers.hoody.com/api/v1/display/?debug_main=true&debug_network=true&debug_keyboard=true&debug_mouse=true&debug_clipboard=true"

The SDK has no call for these parameters: client.embeds.display.client() refuses debug_main, debug_network, debug_keyboard, debug_mouse, debug_clipboard (the embed catalog marks them as not embeddable): add them to the URL yourself, as in the Browser tab.