Web Page (Chromium, Windows)
Web Page (Chromium, Windows) input properties for Script Engine. Renders a live web page as a video and audio source using a Windows-native Chromium-based browser (CefSharp). Point it at any HTTP/HTTPS URL — graphics overlays, scoreboards, dashboards, social-media feeds, or any other browser-renderable content — and Composer captures the page as a layer it can mix with the rest of the project. Includes auto-start on load, automatic reload on error, configurable resolution, scroll-bar control, and optional forwarding of the page's JavaScript console output to the log. Captures both video and audio from the page. Windows-only; for Linux or other platforms, use the cross-platform Web Page input instead.
| 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. Set to an empty string to clear the page. |
ReloadCommand |
Command |
get |
Reload the current page. |
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. |
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=360]. 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. |
ScrollBarXPos |
int |
get/set |
Horizontal scroll position of the page, in pixels. [min=0, max=50000, default=0]. Scrolls the rendered page left or right to a specific position. Useful for showing part of a wide page that wouldn't otherwise fit. Setting this calls window.scrollTo inside the page. |
ScrollBarYPos |
int |
get/set |
Vertical scroll position of the page, in pixels. [min=0, max=50000, default=0]. Scrolls the rendered page up or down to a specific position. Useful for revealing content lower on the page or for animating a scroll over time from a script. Setting this calls window.scrollTo inside the page. |
StartCommand |
Command |
get |
Start loading the URL and 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. |
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. |
EnableConsoleLogging |
bool |
get/set |
Whether messages logged by the page's JavaScript are written to Composer's log. [default=false]. Useful for debugging custom HTML overlays — console.log calls from the page show up alongside Composer's other log messages. |
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. |
LastCefCallbackMessageType |
CefCallbackMessageType |
get |
Result of the most recent page load finalizer callback (read-only, debug). Internal diagnostic value reflecting how the most recent page load ended. |
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. |
PageRenderPerformance |
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 animations or video elements take longer to render than static pages. |
RenderStart |
DateTime |
get |
Local timestamp of when the input most recently started rendering (read-only, debug). |
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. |
Fps |
int |
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. |
AudioFramesReceived |
int |
get |
Total number of audio frames received from the page since the input was started (read-only, debug). Increments only when the page actually produces audio. Useful for confirming an expected audio source is delivering audio. |
AudioSamplesInQueue |
int |
get |
Number of audio samples currently buffered ahead of playback (read-only, debug). A small steady value is normal during continuous audio. A growing buffer suggests audio is arriving faster than Composer is consuming it. |
Inherits from: AbstractInput, AbstractAudioProcessing, AbstractAudioMetering.
See also: Web Page (Chromium, Windows) in Inputs — user-facing introduction, screenshots, and section summaries.