Web Page (Ultralight, cross-platform)
Web Page (Ultralight, cross-platform) input properties for Script Engine. Renders a live web page as a video source using the Ultralight browser engine — a lightweight HTML/CSS/JavaScript renderer designed for embedded use, with a much smaller footprint than a full Chromium engine. Point it at any HTTP/HTTPS URL — graphics overlays, scoreboards, dashboards, social-media feeds — and Composer captures the page as a video layer it can mix with the rest of the project. Cross-platform (Windows, Linux). Note: this input does not capture audio from the page — it produces a video-only signal. Use a dedicated audio input alongside it if the production needs sound. Ultralight supports a smaller subset of modern web features than Chromium, so for very complex pages prefer the Chromium variant on Windows.
| Property | Type | Access | Description |
|---|---|---|---|
ShowAdvancedOptions |
bool |
get/set |
Show or hide the input's advanced settings in the editor UI. [default=false]. |
WebPageRendererUrl |
string |
get/set |
HTTP or HTTPS URL of the web page to render. Set to any standard web URL. Changing this from a script lets you swap the rendered page at runtime — handy for cycling through dashboards, scoreboards, or status pages. |
BrowserLoadState |
UltralightLoadingState |
get |
Current page-load state of the renderer (read-only). Reflects whether the page is loading, has loaded successfully, or has hit an error. Driven indirectly by StartCommand / StopCommand and by changes to WebPageRendererUrl. Read this from a script to decide whether the page is ready. |
Width |
int |
get/set |
Width of the rendered page, in pixels. [min=32, max=4096, default=1024]. Acts like the browser's viewport width. Pages adapt their layout to this size, so set it to match how you want the page to render. |
Height |
int |
get/set |
Height of the rendered page, in pixels. [min=32, max=4096, default=480]. Acts like the browser's viewport height. Pages adapt their layout to this size, so set it to match how you want the page to render. |
StartCommand |
Command |
get |
Load the URL and start rendering the page. |
StopCommand |
Command |
get |
Stop rendering the page. |
AutoStart |
bool |
get/set |
Whether the input starts rendering as soon as the project loads. [default=false]. When true, the input invokes its start logic immediately on load (equivalent to running StartCommand). Disable to require an explicit start, useful when the page should only come live on operator action or via a script trigger. |
EnableConsoleLogging |
bool |
get/set |
Whether messages logged by the page's JavaScript are written to Composer's log. [default=false, debug]. Useful for debugging custom HTML overlays — console.log calls from the page show up alongside Composer's other log messages. |
PurgeIntervall |
int |
get/set |
How often the renderer reclaims unused memory, in milliseconds. [min=100, max=5000, default=300, debug]. Ultralight periodically frees cached resources to keep memory use under control. Shorter intervals reclaim memory more aggressively at a small extra cost; longer intervals reduce that cost slightly but let memory grow further between purges. |
PageRenderTime |
string |
get |
Recent per-frame rendering time, formatted as a millisecond string (read-only). Useful while monitoring how heavy the page is to render. Pages with complex content or animations take longer to render than static pages. |
EngineSleepTime |
string |
get |
Time the rendering engine spent idle between frames, formatted as a millisecond string (read-only, debug). Indicates how much headroom the renderer has — high values mean the engine has time to spare; very low values mean it's working close to capacity. |
EngineQueueSize |
int |
get |
Number of pending render requests in the engine's internal queue (read-only, debug). Should sit close to zero on a healthy system. A growing queue suggests the renderer can't keep up with the requested frame rate. |
PageRendersPerformed |
int |
get |
Total number of times the page has been rendered since the input was started (read-only, debug). |
PurgeMemoryPerformed |
int |
get |
Total number of memory-purge cycles the renderer has run since the input was started (read-only, debug). Driven by PurgeIntervall. |
Inherits from: AbstractInput, AbstractAudioProcessing, AbstractAudioMetering.
See also: Web Page (Ultralight, cross-platform) in Inputs — user-facing introduction, screenshots, and section summaries.