Giter Site home page Giter Site logo

BitWHIP

License Discord

What is BitWHIP

BitWHIP is a CLI WebRTC Agent written in Rust. These are some of the things you can do with it today.

BitWHIP is built on open protocols so should work pretty much anywhere. It should also interop with your favorite tools and libraries like OBS, FFmpeg or GStreamer.

Building

BitWHIP uses just to make installing dependencies and building easier. To build this project first you install just and then execute install-deps.

Install Just

cargo install just

Install dependencies

just install-deps

Using

Now that you have built you have three different paths.

Play WHIP

Play WHIP starts a local WHIP server that clients can push too. You can use this to push video from BitWHIP or other WHIP clients like OBS or GStreamer.

just run play whip

The WHIP client would use a URL of http://localhost:1337/ and any Bearer Token you like. You can stream to it via BitWHIP by running just run stream http://localhost:1337/ bitwhip.

Play WHEP

Play WHEP connects to a WHEP server and plays video. Below is an example of pulling from https://b.siobud.com/ with a Bearer Token of bitwhip

just run play-whep https://b.siobud.com/api/whep bitwhip

After running this open https://b.siobud.com/publish/bitwhip and your video should open in a native player.

Stream

Currently only Windows with NVIDIA cards are supported, more to be added

Stream captures your local desktop and publish via WHIP. To run this you need a URL and a Bearer Token. Below is an example of pushing to https://b.siobud.com/ with a Bearer Token of bitwhip

just run stream https://b.siobud.com/api/whip bitwhip

TODO

  • Create binaries
  • Improve Build System
  • Support more Capture
    • gdigrab (Windows)
    • x11grab (Linux)
  • Support more Encoding
    • QuickSync
    • x264

More

Selkies-GStreamer is a WebRTC remote desktop streaming implementation that has achieved 0-16ms of latency.

Join the Discord and we are ready to help!

bitwhip's Projects

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.