Stream on a Workstation#

The shortest route to run the example is to create a USD Viewer Kit application and web client and execute them on a local workstation. This is supported on both Windows and Linux.

Startup#

To run the solution on a Windows system, turn off hardware accelerated GPU scheduling. This allows USD Viewer to remain performant while not in focus.

  1. Open System > Display > Graphics > Default Graphics Settings.

  2. Toggle Hardware-accelerated GPU scheduling to Off.

Create a custom application based on the USD Viewer template.

  1. Clone or download the kit-app-template repository.

  2. Follow the repository USD Viewer instructions for how to:

    • Create a USD Viewer application from the template. Be sure to complete all steps of the process.

    • Build and launch USD Viewer. Select the kit file with the streaming suffix.

    Note

    Wait for the application to have a black background. The first time you launch the application it can take several minutes to complete. Subsequent startups will be faster.

Run the web client to interact with your application.

  1. Clone and download the web-viewer-sample repository.

  2. Follow the repository README Quick Start instructions for running the web client in dev mode.

The solution is now up and running.

Shutdown#

When you are ready to shut down the solution:

  1. Close the browser window/tab of the web client.

  2. Close the terminal running the web client dev server.

  3. Close the USD Viewer application.

Troubleshooting#

Things don’t always turn out as expected. If you are not getting the expected results, use the following steps to troubleshoot.

  • Shut down the web client’s dev server and close the browser window.

  • Shut down USD Viewer.

  • Restart USD Viewer.

  • Restart the web client’s dev server and open the Chromium browser window.

Note

If the troubleshooting steps do not fix the solution, look for errors in the browser console. Contact your IT person to resolve any network issues blocking the stream.