A WHEP player web page for OBS Studio's browser source. It automatically starts playback of a WEHP stream (sent out from another instance of OBS Studio) with no mute.
dotnet-serve
.No need of isntalling npm
or node.js
for using this project. As written in the Build section, just one thing to make the app work is to host the files on a web server.
If you want to edit the source code, then you need to run npm install
for setting up Unit Test environment.
See Testing section for details.
dotnet-serve
dotnet-serve
with dotnet tool install --global dotnet-serve
.dotnet serve
in the repository's root directory.
dotnet serve --port <port number>
.dotnet serve --host <hostname>
.dotnet serve --host <hostname> --port <port number>
.dotnet serve --open
.dotnet serve --tls
. Make it sure its certificate is trusted by the Web Browser. You can use dotnet dev-certs https --trust
to trust the certificate.streamUrl
: The URL of the WHEP stream to open. It must be URL-encoded.volume
: The volume of the audio. It must be a number between 0 and 1. (default: 1
)muted
: Whether the audio is muted. It must be true
or false
.(default: flase
)autoplay
: Whether the video is automatically played. It must be true
or false
. (default: true
)loop
: Whether the video is automatically looped. It must be true
or false
. (default: false
)controls
: Whether the video controls are shown. It must be true
or false
. (default: false
)debug
: Whether the debug information is shown. It must be true
or false
. (default: false
, but it's true
when the page is NOT opened by OBS Studio's browser source)This project uses Jest with Babel and jsdom, for testing.
Before running the tests, you need to install the dependencies.
Node.js v20.10.0
is used for the initial development phase so it'd be better to use the same version of nodejs.
npm install
npm test
It automatically collects code coverage information and generates a coverage report in the coverage
directory.
No need of running npm install
or npm run build
, as long as you don't edit the source code.
This project jsut works with the files checked into this repository. index.html
is the entry point of this project.