Displays: Session & Sharing

Download Page (.md)

Configure how the HTML5 Display client handles concurrent access, view-only mode, and tab lifecycle. These URL parameters control whether multiple users can share the same session, whether connecting clients take over active sessions, whether the client blocks user input for read-only scenarios, and whether rendering is suspended to save power when the browser tab is hidden.

Access the HTML5 Display client interface

GET /api/v1/display/

Serves the HTML5 Display client web interface. The session-sharing and control parameters listed below control how the client behaves with respect to concurrent connections, input blocking, and background tab handling. The endpoint also accepts additional parameters for window decorations, networking, notifications, keyboard layouts, and debug logging, which are documented separately.

Parameters

Name	In	Type	Required	Description
`sharing`	query	boolean	No	Allow session sharing. Default: `false`
`steal`	query	boolean	No	Steal existing sessions. Default: `true`
`readonly`	query	boolean	No	Enable read-only/view-only mode. Blocks all keyboard and mouse input from the client. Perfect for dashboards, monitoring, or demo scenarios. Works independently or combines with server readonly setting. Default: `false`
`suspend_inactive_tab`	query	boolean	No	Suspend client updates when browser tab is inactive. Enables power saving by calling client.suspend() on tab hide and client.resume() on tab show. Recommended to keep enabled for better performance. Default: `true`

Response

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

Example Request

https://myproject-mycontainer-display-1.myserver.containers.hoody.icu/api/v1/display/?sharing=true&steal=true&readonly=false&suspend_inactive_tab=true

await client.display.accessClient({
  sharing: true,
  steal: true,
  readonly: false,
  suspend_inactive_tab: true
});

curl "https://myproject-mycontainer-display-1.myserver.containers.hoody.icu/api/v1/display/?sharing=true&steal=true&readonly=false&suspend_inactive_tab=true"