Displays: Performance & Encoding

`GET /api/v1/display/`

The performance and encoding parameters let you tune how the HTML5 Display client streams pixels, manages bandwidth, and renders frames. Use these options to balance video quality against network and CPU consumption, enable hardware-friendly pipelines, or switch encoders for specific client conditions. This endpoint documents the subset of query parameters that control encoding, offscreen rendering, bandwidth caps, virtual desktop width override, video pipeline enablement, and the browser MediaSource extension.

Parameters

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

This endpoint accepts no request body.

Response

curl -G "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.icu/api/v1/display/" \
  --data-urlencode "encoding=h264" \
  --data-urlencode "offscreen=true" \
  --data-urlencode "bandwidth_limit=5000000" \
  --data-urlencode "override_width=1920" \
  --data-urlencode "video=true" \
  --data-urlencode "mediasource_video=true"

await client.display.accessClient({
  encoding: 'h264',
  offscreen: true,
  bandwidth_limit: 5000000,
  override_width: '1920',
  video: true,
  mediasource_video: true
});

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