Livestream WebSocket

Overview

By leveraging the new WebSocket livestreaming Extension, 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!

Kit WebSocket livestreaming

Enabling the Extension

  1. From the menu bar, navigate to Window > Extensions

  2. Using the search field of the Extension Manager, search for the omni.services.streamclient.websocket Extension

  3. Install and enable the 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 livestream Extension is a straightforward process:

  1. Enable the omni.services.streamclient.websocket Extension on Kit-based applications (Kit, Create, Isaac Sim, etc.)

  2. Find the IP address of the machine hosting the Kit-based application on your local network

  3. 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

  4. Click the “play” button to start streaming your Kit-based application

From there, you can control your Kit-based application as if you were using it natively using mouse and keyboard inputs.

Note

If you have multiple Kit-based applications running on the same machine, or if the server is unable to use port 8011 because it is already in use, an alternative port will be generated and displayed in the Console.

In such cases, use the provided port to access the stream page using the following pattern: http://<server IP address>:<kit port>/streaming/client

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.

  • The WebSocket livestream Extension may not work when connecting to the server from iOS devices.

  • Support for gamepads, touch inputs, or AR/VR devices may be limited.

  • Copy/paste support is not yet available.