Awesome

• Overview
• Features
• Building
  • Toolchain
  • Monorepo Setup
• Open Source License
• Contributing

Overview

WebRTC.rs is a pure Rust implementation of WebRTC stack, which rewrites <a href="https://github.com/pion/webrtc/releases/tag/v3.1.5">Pion</a> stack in Rust. This project is still in active and early development stage, please refer to the Roadmap to track the major milestones and releases. Examples provide code samples to show how to use webrtc-rs to build media and data channel applications.

Features

Building

Toolchain

Minimum Supported Rust Version: 1.65.0

Our minimum supported rust version(MSRV) policy is to support versions of the compiler released within the last six months. We don't eagerly bump the minimum version we support, instead the minimum will be bumped on a needed by needed basis, usually because downstream dependencies force us to.

Note: Changes to the minimum supported version are not consider breaking from a semver perspective.

Monorepo Setup

All webrtc dependent crates and examples are included in this repository at the top level in a Cargo workspace.

To build all webrtc examples:

cd examples
cargo test # build all examples (maybe very slow)
#[ or just build single example (much faster)
cargo build --example play-from-disk-vpx # build play-from-disk-vpx example only
cargo build --example play-from-disk-h264 # build play-from-disk-h264 example only
#...
#]

To build webrtc crate:

cargo build [or clippy or test or fmt]

Devbox

This repo now supports devbox for a better development experience. In short, devbox allows to define a development environment by modifying the PATH variable in your shell. It is based on nix and runs on Linux, MacOS, and WSL. To use devbox, install it from devbox installation:

curl -fsSL https://get.jetify.com/devbox | bash

Now you can either use the different devbox scripts:

• test it: devbox run test
• build it: devbox run build
• format it: devbux run format

Or you can enter a shell with everything pre-installed:

devbox shell

Open Source License

Dual licensing under both MIT and Apache-2.0 is the currently accepted standard by the Rust language community and has been used for both the compiler and many public libraries since (see https://doc.rust-lang.org/1.6.0/complement-project-faq.html#why-dual-mitasl2-license). In order to match the community standards, webrtc-rs is using the dual MIT+Apache-2.0 license.

Contributing

Contributors or Pull Requests are Welcome!!!

If you want to contribute, please be sure to install the pre-commit hooks:

pre-commit install

Or use the devbox environment described above, which will do so automatically.