Displays: Performance & Encoding

Tune encoding, bandwidth limits, and rendering settings to optimize display performance. These parameters control how the display stream is encoded, the bandwidth ceiling for the WebSocket connection, whether the client uses an offscreen canvas, and whether video and MediaSource APIs are exposed to the browser.

Get 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. This page documents only the performance and encoding subset.

Parameters

Name	In	Type	Required	Description
`encoding`	query	string	No	Video encoding type. Use `auto` for best automatic selection. Allowed values: `auto`, `webp`, `jpeg`, `png`, `rgb`, `rgb24`, `rgb32`, `h264`, `vp8`, `vp9`, `mpeg1`, `mpeg4+mp4`, `h264+mp4`, `vp8+webm`, `scroll`, `void`. 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`.

Request

This endpoint accepts no request body.

Response

HTML5 Display client interface loaded successfully.

{
  "description": "HTML5 Display client interface loaded successfully",
  "content": {
    "text/html": {
      "schema": {
        "type": "string"
      },
      "example": "<!DOCTYPE html>\n<html>\n<head><title>Hoody Display Client</title></head>\n<body>\n  <!-- Display HTML5 client interface -->\n</body>\n</html>\n"
    }
  }
}

curl "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com/api/v1/display/?encoding=webp&bandwidth_limit=5000000&video=true&mediasource_video=true&offscreen=false&override_width=auto"

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({
  encoding: 'webp',
  bandwidth_limit: 5000000,
  video: true,
  mediasource_video: true,
  offscreen: false,
  override_width: 'auto',
});