WebSocket Browser Client¶
Overview¶
By leveraging the new WebSocket live-streaming Extensions, it is now possible to stream any Kit-based application to web browsers.
Using the provided front-end source code and sample application, you can even build your own interactive experiences. This can be used to create a variety of services:
Offering remote workflows
Using Kit-based application on phones, tablets or other devices
Having one-to-many collaborative sessions, where attendees can request control of the presentation
And more!
Built something you’d like to share or showcase? We’d love to hear about it!

Enabling the Extension¶
From the menu bar, navigate to
Window
>Extensions
Using the search field of the Extension Manager, search for “Websocket Client” Extension
Install and enable the
omni.services.streamclient.websocket
Extension
Note
Please note that it is not recommended to auto-load this Extension, as it will consume resources which may lead to sub-optimal experiences when not actively used.
User Manual¶
Using the WebSocket live-stream Extension is a straightforward process:
Enable the
omni.services.streamclient.websocket
Extension on your Kit-based applications (Kit, Create, Isaac Sim, etc.)Find the IP address of the machine hosting the Kit-based application on your local network
Navigate to the stream page in your favorite web browser:
For Kit:
http://<server IP address>:8011/streaming/client
For Create:
http://<server IP address>:8111/streaming/client
For Isaac Sim:
http://<server IP address>:8211/streaming/client
For Kaolin:
http://<server IP address>:8311/streaming/client
Click the “play” button to start streaming your Kit-based application
Note
For convenience, the URLs where the web application is exposed are available from the
Streaming
>Local Stream URLs
top-level menu, where they can be copied to the clipboard for sharing.Firefox Users on Linux may have to install additional video codecs for playback on the client browser. Ubuntu Users may wish to install
sudo apt-get install ffmpeg
for simplicity.
Should the host be located on the infrastructure of a third-party Cloud provider, it may additionally be required that the following inbound ports be opened:
WS
8899
, which can additionally be configured using the--/app/livestream/websocket/server_port=8899
application setting.
Current Limitations¶
For a best user experience, it is recommended that only a single User at a time be provided with mouse or keyboard control while others remain in spectator mode.
Support for gamepads, touch inputs, or AR/VR devices may be limited.