LiveURLOptions

Properties

Property	Type	Description
captureScale?	number	Encoded backing pixels per CSS pixel. Must be 1 or 2. Defaults to 1; 2 increases stream resolution without changing the page's CSS viewport. Default 1
compressed?	boolean	Whether to compress each frame of the streamed image data. When true (default), frames are compressed to reduce bandwidth usage. Set to false to disable compression for lower latency at the cost of increased bandwidth usage. Default true
detached?	boolean	Give the viewer its own Chrome connection so it survives the minting client's disconnect. Ends on link expiry, browser termination, explicit close, or secret-fill teardown. Defaults to false. Default false
emulateComponents?	boolean	Whether to emulate HTML components such as <select> dropdowns and the virtual keyboard. Setting this to false will force the virtual keyboard to not appear on the end-user's screen when interacting with input fields. Defaults to true. Default true
instructions?	string	Plain-text task shown in an Instructions modal with Done / Couldn't finish buttons on interactive links. Omitted or blank instructions show no modal, collapsed pill, or completion buttons; interactivity is unchanged. Whitespace is trimmed; text over 2048 characters is truncated.
interactable?	boolean	Whether the session is interactable or not. Set to "false" to not allow click and mouse events to be forwarded through to the end-user Default true
mode?	LiveURLMode	Defaults to tab when targetId is supplied, otherwise follow. An explicit mode always wins.
quality?	number	The quality of the stream, represented as number from 1 - 100. Only used when "type" is "jpeg". Default is 70. Default 70
resizable?	boolean	Whether or not to resize the underlying browser to match the end-user's screen size. When false the underlying browser will retain it's current viewport, and the end users's screen wil maintain the appropriate aspect ratio. Default true
showBrowserInterface?	boolean	Whether to show the browser interface and tabs in the live URL. When false (default), only the browser content is shown. When true, navigation bar and tabs are displayed. Default false
targetId?	string	Page target id from windows; defaults to the active window. May name a tab in any browser context. Does not switch the active window.
timeout?	number	The maximum time allowed for the browser to remain alive. Once the time is reached, the end-user will receive a prompt that the session has closed. Capped to the session's remaining time; the applied value is returned as timeout.
type?	LiveURLStreamType	The binary-type of the streamed imaged. "jpeg" will consumer lower bandwidth and useful low bandwidth networks and devices. "png" is a much higher quality but will consume considerably more bandwidth. Use "jpeg" when setting a custom quality Default jpeg