Displays: Session & Sharing

Download Page (.md)

The HTML5 Display client endpoint accepts URL query parameters that control how multiple users interact with the same session. Use these parameters to permit concurrent viewers, decide whether a new connection takes over an active session, lock input for safe observation, or pause updates when the browser tab is hidden.

This page documents only the session-sharing and control parameters — sharing, steal, readonly, and suspend_inactive_tab. Other query parameters for the same endpoint are documented on their own pages.

Access the Display Client

`GET /api/v1/display/`

Loads the HTML5 Display client web interface. Query parameters customize session behavior on a per-request basis; the four parameters documented here govern sharing, session-stealing, view-only mode, and tab suspension.

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. Works independently or combines with the server readonly setting. Default: `false`.
`suspend_inactive_tab`	query	boolean	No	Suspend client updates when the browser tab is inactive. Calls `client.suspend()` on tab hide and `client.resume()` on tab show for power saving. Default: `true`.

This endpoint takes no body.

Response

The HTML5 Display client interface is returned as an HTML document.

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

curl -G "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com/api/v1/display/" \
  --data-urlencode "sharing=true" \
  --data-urlencode "steal=false" \
  --data-urlencode "readonly=true" \
  --data-urlencode "suspend_inactive_tab=true"

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({ sharing: true, steal: false, readonly: true, suspend_inactive_tab: true });