Displays: Performance & Encoding

: Performance & Encoding

Tune video encoding, bandwidth limits, canvas rendering, and MediaSource handling when accessing the HTML5 Display client. These query parameters on the Display client endpoint control how the stream is encoded, how much bandwidth it consumes, and which browser-side APIs are used for video playback.

Access the HTML5 Display client interface

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 and accepts the same URL parameters for full client customization. The performance and encoding subset is documented below; other parameter groups are covered on separate pages.

curl -G "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com/api/v1/display/" \
  --data-urlencode "encoding=auto" \
  --data-urlencode "offscreen=false" \
  --data-urlencode "bandwidth_limit=0" \
  --data-urlencode "override_width=auto" \
  --data-urlencode "video=true" \
  --data-urlencode "mediasource_video=true"

import { HoodyClient } from 'hoody-sdk';

const hoody = await HoodyClient.login('https://api.hoody.com', { username, password });
const box = await hoody.withContainer(containerId);

// Builds the URL of display 1; nothing is fetched. Open it in a browser or a frame.
const url = box.embeds.display.client(undefined, {
  index: 1,
  query: { encoding: 'auto', offscreen: false, bandwidth_limit: 0, override_width: 'auto', video: true, mediasource_video: true },
});

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

Parameters

Name	In	Type	Required	Description
`encoding`	query	string	No	Sets the preferred stream encoding sent to the server. Use `auto` for automatic selection. Default: `"auto"`.
`offscreen`	query	boolean	No	Use offscreen canvas for rendering. Default: `false`.
`bandwidth_limit`	query	integer	No	Bandwidth limit in bits per second (`0` = unlimited). Default: `0`.
`override_width`	query	string	No	Override virtual desktop width (`auto` or numeric value). Default: `"auto"`.
`video`	query	boolean	No	Enable video encoding support. Default: `true`.
`mediasource_video`	query	boolean	No	Enable MediaSource API for video. Default: `true`.

Responses

HTML5 Display client interface loaded successfully.

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