Installation and Verification#

Installing USD Composer#

  • Download and Install the Omniverse Launcher if you don’t already have it.

  • Search for and install USD Composer 2023.2.3 from within the Launcher Exchange tab.

  • Extract omni.usd_composer.streaming.bat.zip and copy omni.usd_composer.streaming.bat file into the USD Composer installation directory.

    • To find the installation directory, go to the Launcher Library tab.

    • Select USD Composer.

    • Click on the Settings icon.

  • Click on the folder icon for version 2023.2.3. This will open a file browser for the installation directory.

  • Start USD Composer from the Launcher.

  • Install the most recent streaming and messaging Extensions.

    • In USD Composer, open the Extension Manager using the menu Window > Extensions.

    Note

    When installing/updating Extensions below, do not change their Enabled state and do not change their Autoload state.

    • Search for omni.kit.livestream.webrtc.setup and click Install. Use version 1.0.1.

    • Search for omni.kit.livestream.messaging and click Install. Use version 1.1.0.

    • Search for omni.kit.streamsdk.plugins and click Install. Use version 2.6.2.

    • Search for omni.kit.livestream.core and click Install. Use version 2.4.0.

    • Search for omni.graph.action and click Update. Use version 1.58.3.

    Note

    There will be an error once the update process is complete.

  • Close USD Composer. Do not continue without restarting the application.

Verify USD Composer Streaming Capability#

  • Navigate into the USD Composer 2023.2.3 installation directory.

  • Launch the application with omni.usd_composer.streaming.bat.

  • Open the Extension Manager using menu Window > Extensions.

    • Search for omni.kit.livestream.webrtc.setup. Click the toggle labeled Disabled to enable the Extension. The application is most likely resized at this point. It will remain this size for the remainder of the application session

    • Search for omni.services.streamclient.webrtc and click the toggle labeled Disabled to enable the Extension.

  • When omni.services.streamclient.webrtc is enabled above, a new Streaming menu appears in USD Composer. Click on Streaming > Local Stream URLs > and the listed local URL. This copies the URL to the clipboard.

  • Paste the URL in a Chrome browser running on the same computer as USD Composer.

  • The browser should display USD Composer in a web page.

  • If you cannot see USD Composer streamed in the web page at this point, please repeat the installation and verification steps to make sure no steps were missed. Please contact your NVIDIA representative for further troubleshooting.

  • Close the web page.

  • Close USD Composer.

Install Web Sample#

Web sample requires installation of Node.js and NPM.

  • Extract the provided kit-streaming-sample.zip archive.

  • Navigate into the root directory of the kit-streaming-sample project.

  • In a command prompt window, run npm install.

Verify Web Sample and USD Composer Streaming Capability#

  • Navigate to the USD Composer 2023.2.3 installation directory.

  • Launch the application with omni.usd_composer.streaming.bat.

  • Open the Extension Manager using menu Window > Extensions.

    • Search for omni.kit.livestream.webrtc.setup and click the toggle labeled Disabled to enable the Extension. The application is most likely resized at this point. It’ll remain this size for the remainder of the application session.

    • Search for omni.kit.livestream.messaging and click the toggle labeled Disabled to enable the Extension.

  • Open the included Bag.usd asset in USD Composer.

    Note

    It is critical that you first enable the above Extensions prior to opening the USD asset. The file contains Action Graph nodes that require the above Extensions to be enabled when loaded.

  • Wait for the Bag.usd textures to load. Note the progress in the application status bar.

  • USD Composer should now be in a streaming state and ready to communicate. Let us verify by running the web sample.

  • Navigate into the root directory of the kit-streaming-sample project.

  • In a command prompt window, run npm run dev.

  • Copy the URL presented in the command line and paste it into a Chrome web page.

  • You should now see USD Composer streamed into the web page.

  • Verify USD Composer is streaming in the web page.

    • Click on the White and Black buttons and verify that the bag material is changing.

    • Click on the Plinths, Desk, and Marble Wall buttons and verify that the bag background is changing.

    • Open the web browser developer tool view and make the console visible. Again, click on the web buttons and verify that you see messages in the console such as Kit App confirms color selection… and Kit App confirms backdrop selection…

    • Close USD Composer.

    • Close the web page.

  • Return to the command prompt running the web page. Use CTRL+C to terminate the web client - or just close the prompt.

➤ Next Steps: Develop custom messages

On this page