Skip to content

Commit

Permalink
Update local streaming docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SchultzC committed Jul 31, 2024
1 parent 23972ff commit 70f7641
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 12 deletions.
11 changes: 8 additions & 3 deletions templates/apps/kit_base_editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,6 @@ This will bundle your application into a distributable format, ready for deploym

### Local Streaming

> **NOTE:** Local streaming is currently supported on Windows 10/11 and Ubuntu 22.04. Ubuntu 20.04 is not currently supported by the web viewer sample

The UI-based template applications in this repository produce more than a single `.kit` file. For the Kit Base Editor template application, this includes `{your-app-name}_streaming.kit` which we will use for local streaming. This file inherits from the base application and adds necessary streaming components like `omni.kit.livestream.webrtc`. To try local streaming, you need a web client to connect to the streaming server.

#### 1. Clone Web Viewer Sample
Expand Down Expand Up @@ -229,8 +227,15 @@ import Window from './WindowNoUI';
#### 3. Start the streaming Kit Application
:warning: **Important**: Launching the streaming application with `--no-window` passes an argument directly to Kit allowing it to run without the main application window to prevent conflicts with the streaming client.
**Linux:**
```bash
./repo.sh launch
./repo.sh launch -- --no-window
```
**Windows:**
```powershell
.\repo.bat launch -- --no-window
```
Select the `{your-app-name}_streaming.kit` and wait for the application to start
Expand Down
11 changes: 8 additions & 3 deletions templates/apps/usd_composer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,6 @@ This will bundle your application into a distributable format, ready for deploym

### Local Streaming

> **NOTE:** Local streaming is currently supported on Windows 10/11 and Ubuntu 22.04. Ubuntu 20.04 is not currently supported by the web viewer sample

The UI-based template applications in this repository produce more than a single `.kit` file. For the USD Composer template application, this includes `{your-app-name}_streaming.kit` which we will use for local streaming. This file inherits from the base application and adds necessary streaming components like `omni.kit.livestream.webrtc`. To try local streaming, you need a web client to connect to the streaming server.

#### 1. Clone Web Viewer Sample
Expand Down Expand Up @@ -246,8 +244,15 @@ import Window from './WindowNoUI';
#### 3. Start the streaming Kit Application
:warning: **Important**: Launching the streaming application with `--no-window` passes an argument directly to Kit allowing it to run without the main application window to prevent conflicts with the streaming client.
**Linux:**
```bash
./repo.sh launch
./repo.sh launch -- --no-window
```
**Windows:**
```powershell
.\repo.bat launch -- --no-window
```
Select the `{your-app-name}_streaming.kit` and wait for the application to start
Expand Down
11 changes: 8 additions & 3 deletions templates/apps/usd_explorer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,6 @@ This will bundle your application into a distributable format, ready for deploym

### Local Streaming

> **NOTE:** Local streaming is currently supported on Windows 10/11 and Ubuntu 22.04. Ubuntu 20.04 is not currently supported by the web viewer sample

The UI-based template applications in this repository produce more than a single `.kit` file. For the USD Explorer template application, this includes `{your-app-name}_streaming.kit` which we will use for local streaming. This file inherits from the base application and adds necessary streaming components like `omni.kit.livestream.webrtc`. To try local streaming, you need a web client to connect to the streaming server.

#### 1. Clone Web Viewer Sample
Expand Down Expand Up @@ -249,8 +247,15 @@ import Window from './WindowNoUI';
#### 3. Start the streaming Kit Application
:warning: **Important**: Launching the streaming application with `--no-window` passes an argument directly to Kit allowing it to run without the main application window to prevent conflicts with the streaming client.
**Linux:**
```bash
./repo.sh launch
./repo.sh launch -- --no-window
```
**Windows:**
```powershell
.\repo.bat launch -- --no-window
```
Select the `{your-app-name}_streaming.kit` and wait for the application to start
Expand Down
11 changes: 8 additions & 3 deletions templates/apps/usd_viewer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,6 @@ This will bundle your application into a distributable format, ready for deploym

### Local Streaming

> **NOTE:** Local streaming is currently supported on Windows 10/11 and Ubuntu 22.04. Ubuntu 20.04 is not currently supported by the web viewer sample
The UI-based template applications in this repository produce more than a single `.kit` file. For the USD Viewer template application, this includes `{your-app-name}_gdn.kit` and `{your-app-name}_streaming.kit`. For local streaming, we'll use the `{your-app-name}_streaming.kit` file. This file inherits from the base application and adds necessary streaming components like `omni.kit.livestream.webrtc`. To try local streaming, you need a web client to connect to the streaming server.

#### 1. Clone Web Viewer Sample
Expand All @@ -215,8 +213,15 @@ Follow the instructions in the README to install the necessary dependencies.

#### 2. Start the streaming Kit Application

:warning: **Important**: Launching the streaming application with `--no-window` passes an argument directly to Kit allowing it to run without the main application window to prevent conflicts with the streaming client.

**Linux:**
```bash
./repo.sh launch
./repo.sh launch -- --no-window
```
**Windows:**
```powershell
.\repo.bat launch -- --no-window
```

Select the `{your-app-name}_streaming.kit` and wait for the application to start
Expand Down

0 comments on commit 70f7641

Please sign in to comment.