Hoody Display Client

# Displays: Web Client Interface **Page:** api/displays/web-client [Download Raw Markdown](./api/displays/web-client.md) --- {/* AUTO-GENERATED — Do not edit manually. Regenerate with: npm run docs:api:generate */} ## Access the HTML5 Display Client The HTML5 Display client is the browser-based viewer that connects to a container's display server. This endpoint serves the client interface and accepts URL query parameters for connection routing, transport selection, and audio behavior. Use it when embedding or deep-linking directly to the client with a pre-configured connection context. This page documents the **connection and general access** subset of query parameters. The full client accepts 50+ parameters for UI customization, encoding, clipboard, notifications, and debug logging — those are covered on their respective pages. ### `GET /api/v1/display/` Serves the HTML5 Display client web interface with optional URL-based configuration. This is the versioned, REST-style equivalent of the root endpoint, suitable for API gateways and versioned integrations. **Example:** ```bash https://domain.com/api/v1/display/?project_id=my-project&container_id=abc123&node=us-nyc-1 ``` ### Parameters | Name | In | Type | Required | Description | |------|-----|------|----------|-------------| | `node` | query | string | No | Hoody node identifier (e.g., `sg-sin-1`, `us-nyc-1`) | | `project_id` | query | string | No | Hoody project ID | | `container_id` | query | string | No | Hoody container ID | | `url_display_id` | query | string | No | Display ID for URL construction | | `ssl` | query | boolean | No | Use SSL/TLS for WebSocket connection. Default: `true` | | `webtransport` | query | boolean | No | Use WebTransport (HTTP/3) instead of WebSocket. Default: `false` | | `sound` | query | boolean | No | Enable audio forwarding. Default: `true` | | `audio_codec` | query | string | No | Preferred audio codec | | `reconnect` | query | boolean | No | Auto-reconnect on connection loss. Default: `true` | | `displayId` | query | integer | No | Display ID to use (overrides the `*-display-N.*` hostname pattern). Valid range: 1-999999 | This endpoint takes no request body. ### Response The HTML5 Display client interface is returned as `text/html`. ```html Hoody Display Client ``` ### SDK Usage ```typescript const client = new HoodyClient({ /* config */ }); // Access the HTML5 Display client with connection parameters const response = await client.display.accessClient({ // Connection and general access parameters node: "us-nyc-1", project_id: "my-project", container_id: "abc123", url_display_id: "10", ssl: true, webtransport: false, sound: true, audio_codec: "opus", reconnect: true, }); ```