Is this page helpful?

Local Kit App Streaming#

../_images/ov_cloud_banner.jpg

Overview#

The information below explains the process for streaming a containerized Kit App locally for testing and validation.

Prerequisites#

Install NPM#

Once you have the Web Viewer Sample cloned, NPM must be installed. To do so, run the following commands:

cd web-viewer-sample/
npm install

Launch the Containerized Kit App Locally#

Launch the container locally using the following command:

docker run --gpus all --net=host <name_of_your_app>:<tag>

Required Changes to the Web Viewer Sample Configuration#

The changes below allow the Web Viewer Sample to connect to a Kit App running locally. Within the stream.config.json file, make the following changes:

"local": {
    "$comment": "Required props if source is set to 'local'.",
    "server": "<IP Address of Instance running the kit container>",
    "signalingPort": 49100,
    "mediaPort": null
}

Save the changes, then use the following command to run the Web Viewer Sample:

npm run dev

Connect to the Kit App Locally Streaming Using the Web Viewer Sample#

Access the stream by navigating to http://your-host-ip:3000/ in your web browser.

The interface will appear and show the following options:

  • UI Option selection

  • Stream configuration

  • Available Kit Apps to stream

../_images/kit-web-user-example.png


For additional information (including troubleshooting steps) for the Web Viewer Sample, see the Web Viewer Sample GitHub repository to access the GitHub Project.