Web Page (Chromium, cross-platform)
Web Page (Chromium, cross-platform) input properties for Script Engine. Renders a live web page as a video source using a Chromium-based browser engine. Point it at any HTTP/HTTPS URL — a graphics overlay system, a scoreboard, a real-time dashboard, a social-media feed, or any other browser-renderable content — and Composer captures the page as a video layer it can mix with the rest of the project. Includes auto-start on load, automatic reload on error, configurable resolution, edge-padding tweaks for clean captures, and a free-form pass-through for Chromium command-line switches. 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.
| 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 |
BrowserLoadState |
get |
Current browser state (read-only). Reflects whether the browser is Idle, loading, or actively rendering. Driven indirectly by StartCommand, StopCommand, ReloadCommand, and the AutoStart behaviour at load time. Read this from a script to decide whether the page is live. |
LoadResult |
LoadResult |
get |
Outcome of the most recent page load — Completed, Failed, or Stopped (read-only). Completed means the page finished loading successfully; Failed means it didn't (network error, bad URL, etc.); Stopped means the load was cancelled. Useful from a script to react to load failures. |
StartCommand |
Command |
get |
Start loading the URL and rendering the page. |
ReloadCommand |
Command |
get |
Reload the current page. |
StopCommand |
Command |
get |
Stop rendering the page. |
SaveToDiskCommand |
Command |
get |
Save the most recently rendered frame to disk as an image file. |
ComponentLog |
ComponentLog |
get |
Recent log lines from the input — load, navigation, and error events (read-only). A short rolling history of significant events from the browser. Useful for diagnosing why a page failed to load or why the renderer stopped. |
AddJsConsoleToComposerLog |
bool |
get/set |
Whether messages logged by the page's JavaScript are written to Composer's main log file. [default=false, debug]. Useful for debugging custom HTML overlays — console.log calls from the page show up alongside Composer's other log messages. |
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. |
AutoReloadPageOnError |
bool |
get/set |
Whether the page is automatically reloaded after a load error. [default=false]. When true, a failed load is retried automatically. Useful when the source server may be temporarily unavailable. Disable for one-shot loads that should not retry. |
UnMultiplyAlpha |
bool |
get/set |
Whether to convert pre-multiplied colours from the browser to straight (un-multiplied) colours. [default=false]. Browsers typically deliver pixels with the colour values already multiplied by the alpha channel. Composer expects straight colours for its compositing, so enable this when transparent regions of the page look incorrectly tinted or darkened. Leave off for fully opaque pages where it makes no visible difference. |
ChromiumSwitches |
string |
get/set |
Space-separated list of Chromium command-line options to pass to the browser engine. Forwarded directly to Chromium when the input starts. Useful for diagnosing rendering issues or tweaking GPU/compositing behaviour — for example --disable-gpu --disable-gpu-compositing. Leave empty for the standard configuration. |
NumReloadsPerformed |
int |
get |
Total number of times the page has been reloaded since the input was started (read-only, debug). Driven by both manual ReloadCommand invocations and automatic reloads triggered by AutoReloadPageOnError. |
VideoQueueSize |
int |
get |
Number of rendered frames currently buffered ahead of playback (read-only, debug). Should sit close to zero on a healthy system. A growing queue means the rest of the pipeline is consuming frames more slowly than the browser is producing them. |
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=800]. 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. |
EdgePaddingPx |
int |
get/set |
Extra pixels rendered around the edges and then cropped, to hide rendering artefacts. [min=0, max=32, default=0]. On some pages the edges of the rendered image can show subtle artefacts caused by browser scaling. Increasing this captures a slightly larger area and then crops it back to the configured size, hiding those edge artefacts. Most pages don't need it. |
InjectEdgePaddingCompensation |
bool |
get/set |
Whether to automatically add CSS padding to the page so its layout still fits inside the visible area when EdgePaddingPx is non-zero. [default=false]. Only relevant when EdgePaddingPx is set above 0. Without this on, the extra capture area can clip page content; with it on, Composer injects a small CSS padding into the page to keep the visible content centred and unclipped. |
IsLoading |
bool |
get |
True while the page is currently loading (read-only, debug). true from the moment a load starts until the page either finishes loading or errors out. Read this from a script to wait until the page is ready before triggering follow-up actions. |
RenderStart |
DateTime |
get |
Local timestamp of when the input most recently started rendering (read-only, debug). |
LastFrameRendered |
DateTime |
get |
Local timestamp of the most recently rendered frame (read-only, debug). Useful for detecting "no frames in N seconds" type stalls. |
FirstFrameRenderedDateTime |
DateTime |
get |
Local timestamp of the very first frame rendered after the page loaded (read-only, debug). Compared with RenderStart to gauge how long the page took to deliver its first frame. |
FramesRendered |
long |
get |
Total number of frames rendered from the page since the input was started (read-only, debug). Should grow steadily during healthy rendering. A counter that stops moving while the browser is running indicates the page itself has stalled (e.g. an infinite JS loop or no animation/updates). |
Fps |
double |
get |
Recent rendering frame rate, in frames per second (read-only, debug). Reflects how often the browser is producing new frames. Pages that don't animate may report a low or zero frame rate even while loaded successfully. |
Inherits from: AbstractInput, AbstractAudioProcessing, AbstractAudioMetering.
See also: Web Page (Chromium, cross-platform) in Inputs — user-facing introduction, screenshots, and section summaries.