React Usage Instructions

  1. Unzip kit-streaming-sample.zip.

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

  3. Copy the entire kit-streaming-sample/deps into the root of your React project.

  4. Add the deps dependency to your project package.json file:

    "dependencies": {
         "@nvidia/omniverse-webrtc-streaming-library": "file:./deps/@omniverse/omniverse-webrtc-streaming-library"
         }
    
  5. Copy kit-streaming-sample/src/AppStream.jsx into your React App project src directory.

  6. Run typical install, build, and run processes for your project.

For Non-React Samples

  1. Unzip kit-streaming-sample.zip.

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

  3. Copy the entire kit-streaming-sample/deps into the root of your project.

  4. Add the deps dependency to your project package.json file:

    "dependencies": {
    "@nvidia/omniverse-webrtc-streaming-library": "file:./deps/@omniverse/omniverse-webrtc-streaming-library"
    }
    
  5. Currently, you will need to write your own custom web client component around the library. You can use kit-streaming-sample/src/AppStream.jsx as a reference.

  6. Run typical install, build, and run processes for your project.