Displays: Session & Sharing

Download Page (.md)

Session sharing and control parameters configure how the HTML5 Display client handles concurrent users, read-only access, and resource management when the browser tab loses focus. Use these parameters to build dashboard views, demo environments, and multi-user collaboration scenarios.

`GET /api/v1/display/`

Access the HTML5 Display client interface with optional URL-based session configuration. This is the versioned API endpoint equivalent of the root display URL.

Name	In	Type	Required	Default	Description
`readonly`	query	boolean	No	`false`	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.
`sharing`	query	boolean	No	`false`	Allow session sharing
`steal`	query	boolean	No	`true`	Steal existing sessions
`suspend_inactive_tab`	query	boolean	No	`true`	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.

Example request:

curl "https://domain.com/api/v1/display/?displayId=10&readonly=true&sharing=true&steal=false&suspend_inactive_tab=true"

Parameters

Name	In	Type	Required	Description
`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.
`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.
`sharing`	query	boolean	No	Allow session sharing
`steal`	query	boolean	No	Steal existing sessions

The HTML5 Display client interface is served with the requested session configuration applied.

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

SDK Usage

// Allow session sharing, permit stealing (default), enable read-only mode
const result = await client.display.accessClient({
  displayId: 10,
  sharing: true,
  steal: true,
  readonly: true,
  suspend_inactive_tab: true
});

// Dashboard / monitoring scenario: read-only, no sharing, no stealing
const result = await client.display.accessClient({
  displayId: 42,
  readonly: true,
  sharing: false,
  steal: false
});

// Power-saving kiosk: allow sharing, suspend on tab blur
const result = await client.display.accessClient({
  displayId: 7,
  sharing: true,
  steal: false,
  suspend_inactive_tab: true
});

Common Configuration Patterns

Public Dashboard

Set readonly=true to block all input, sharing=false to prevent others from joining, and steal=false to never disrupt an existing session. Ideal for status boards and monitoring screens.

Collaborative Session

Set sharing=true to allow multiple users, steal=true so any collaborator can take control, and readonly=false to permit input from all clients.

Demo / Kiosk

Set readonly=true for unattended demos, suspend_inactive_tab=true to reduce CPU when the tab is not in the foreground, and steal=false to keep the demo uninterrupted.