Skip to main content

Viewer App

This page is an easy way to send somebody a direct link to a stream of your application or iframe into your own site.

info

https://omnistream.zerolight.com/

URL Parameters​

This page doesn't load anything by default and must be configured with OmniStream Render Service details and options. The easiest way to get a valid URL for the viewer app is through the Stream button within Portal.

The full set of valid URL params is:

customer [required] - Customer name accessible from the Portal Stream dialog.
service [required] - Render Service name accessible from the Portal Stream dialog.
appname [optional] - App name given to you by ZeroLight used to distinguish between apps on Render Services that run multiple apps.
appid [optional] - App ID given to you by ZeroLight used to distinguish between apps on Render Services that run multiple apps.
showcontrols [optional] - Pass "showcontrols=true" to show stream controls, leave empty to hide them.
pointerlock [optional] - Pass "pointerlock=true" to lock the mouse cursor when in fullscreen, leave empty to leave the mouse cursor under normal desktop control.
autostartaudio [optional] - Pass "autostartaudio=true" to un-mute the stream on the first click on the stream window.
consumeclicks [optional] - Pass "consumeclicks=true" for OmniStream to consume all mouse events and prevent browser default actions.
fakemousewithtouch [optional] - Pass "fakemousewithtouch=true" to translate touch inputs to mouse inputs for easy mobile integration. Pass "fakemousewithtouch=false" to enable touch/multi touch events when on touch devices.
idledisconnecttime [optional] - Time in ms that a user who does not interact with the stream will be disconnected, defaults to 900000ms (15 minutes).

Example of a valid url: https://omnistream.zerolight.com/?customer=mycompanyname&service=myrenderservicename

These options are also printed in the console of the page if you load it without any url parameters.

iframe​

To add this page to your website as an iframe, copy the snippet below and modify the parameters for your use case.

<iframe
  src="https://omnistream.zerolight.com/?customer=mycompanyname&service=myrenderservicename"
  width="1280"
  height="720"
  allow="fullscreen"
  style="border: none;"
></iframe>