# Displays: Performance & Encoding **Page:** api/displays/performance [Download Raw Markdown](./api/displays/performance.md) --- {/* AUTO-GENERATED — Do not edit manually. Regenerate with: npm run docs:api:generate */} ## Performance & Encoding These parameters tune video encoding, bandwidth usage, and rendering performance for the HTML5 Display client. Adjust them to balance quality, latency, and resource consumption based on network conditions and client capabilities. ### `GET /api/v1/display/` Serves the HTML5 Display client web interface with optional URL-based configuration. **Use this endpoint for:** - RESTful API compliance - Versioned client access - API gateway integrations **Example:** ```bash https://domain.com/api/v1/display/?displayId=10&readonly=true&decorations=false ``` ### 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` | ### Response ```json { "description": "HTML5 Display client interface loaded successfully", "content": { "text/html": { "schema": { "type": "string" }, "example": "\n\nHoody Display Client\n\n \n\n\n" } } } ``` ### SDK Usage ```javascript const result = await client.display.accessClient({ encoding: "auto", offscreen: false, bandwidth_limit: 0, override_width: "auto", video: true, mediasource_video: true }); ```