BrowserRenderSettings interface

appConfig?

BrowserAppSettings

(Optional) The CEF settings to use for this browser render instance

browserSourceName

string

The source name for the browser output stream key

frameRate

{ frames: number; seconds: number; }

The frame rate for the browser output

maxQueueDepth?

number

(Optional) Maximum number of input frames to queue while waiting for browser renders. When exceeded, the oldest queued frame is dropped. Default: 2.

resolution

{ width: number; height: number; }

The resolution of the browser window (and therefore the output browser frames)

startupBehaviour?

"bufferUntilReady" | "passthroughUntilReady"

(Optional) How to handle input frames arriving before the CEF browser is ready (i.e. before the first successful paint). CEF takes a moment to load the page and produce its first frame. - "bufferUntilReady" (default): Queue input frames without bound until the browser is ready. Once ready, maxQueueDepth is enforced. Good for file inputs where every frame must be preserved. - "passthroughUntilReady": Emit input frames on the original pin immediately with no corresponding browser frame. Good for live inputs where startup latency matters more than having a browser overlay for the first fraction of a second.

url

string

The URL to load in the browser session