Skip to content

Commit

Permalink
Fixing path to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
manjeshbhargav committed Jul 17, 2024
1 parent 3b599f8 commit 07e959a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
17 changes: 9 additions & 8 deletions examples/virtualbackground/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

## Setup

Checkout the latest release tag (see the latest releases [here](https://github.com/twilio/twilio-video-processors.js/releases)). For example, to checkout release 1.0.0:
Go to `${PROJECT_ROOT}/examples` and run `npm install`. It will install the dependencies and run the application server.

```
git checkout 1.0.0
```
## Running the Demo

Then, run `npm install` from the `examples` folder. It will install the dependencies and run the application server.
Open `http://localhost:3000` in a Chrome tab. The app captures your camera upon loading and plays it in a `<video>` element. You can choose to enable, disable or update the background settings using the controls on the page. Additionally, you can specify the following url parameters:

## App (Chrome Only)

Open http://localhost:3000 in a Chrome tab. The app captures your camera upon loading and plays it in a `<video>` element. You can choose to enable, disable or update the background settings using the controls on the page.
- `capFramerate` - Choose video capture frame rate (default: 30)
- `capResolution=wxh` - Choose video capture resolution (default: 1280x720)
- `debounce=true|false` - Whether to skip processing every other frame (default: false)
- `maskBlurRadius` - Radius of the mask blur filter (default: 8 for WebGL2, 4 for Canvas2D)
- `pipeline=Canvas2D|WebGL2` - Choose the canvas or webgl pipeline (default: WebGL2)
- `stats=advanced|hide|show` - Show performance benchmarks (default: show)
2 changes: 1 addition & 1 deletion examples/virtualbackground/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ <h5 class="modal-title" id="errorModalLabel">Error</h5>
<script type="module" src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@2/dist/zero-md.min.js"></script>
<script>
(async () => {
const response = await fetch('/examples/README.md');
const response = await fetch('README.md');
const text = await response.text();
const $instructions = document.getElementById('instructions');
const $zeroMd = document.createElement('zero-md');
Expand Down

0 comments on commit 07e959a

Please sign in to comment.