webrtc README

The project's README from github.com/pion/webrtc. As one markdown file: README.md.

Pion WebRTC
Pion WebRTC

A pure Go implementation of the WebRTC API

Pion WebRTC Sourcegraph Widget join us on Discord Follow us on Bluesky Twitter Widget
GitHub Workflow Status Go Reference Coverage Status Go Report Card License: MIT


New Release

Pion WebRTC v4.0.0 has been released! See the release notes to learn about new features and breaking changes.

If you aren't able to upgrade yet check the tags for the latest v3 release.

We would love your feedback! Please create GitHub issues or Join the Discord to follow development and speak with the maintainers.

Usage

Go Modules are mandatory for using Pion WebRTC. So make sure you set export GO111MODULE=on, and explicitly specify /v4 (or an earlier version) when importing.

example applications contains code samples of common things people build with Pion WebRTC.

example-webrtc-applications contains more full featured examples that use 3rd party libraries.

awesome-pion contains projects that have used Pion, and serve as real world examples of usage.

GoDoc is an auto generated API reference. All our Public APIs are commented.

FAQ has answers to common questions. If you have a question not covered please ask in Discord we are always looking to expand it.

Now go build something awesome! Here are some ideas to get your creative juices flowing:

Need Help?

Check out WebRTC for the Curious. A book about WebRTC in depth, not just about the APIs. Learn the full details of ICE, SCTP, DTLS, SRTP, and how they work together to make up the WebRTC stack. This is also a great resource if you are trying to debug. Learn the tools of the trade and how to approach WebRTC issues. This book is vendor agnostic and will not have any Pion specific information.

Pion has an active community on Discord. Please ask for help about anything, questions don't have to be Pion specific! Come share your interesting project you are working on. We are here to support you.

One of the maintainers of Pion Sean-Der is available to help. Schedule at siobud.com/meeting He is available to talk about Pion or general WebRTC questions, feel free to reach out about anything!

Features

PeerConnection API

Connectivity

DataChannels

Media

Security

Pure Go

Roadmap

The library is in active development, please refer to the roadmap to track our major milestones. We also maintain a list of Big Ideas these are things we want to build but don't have a clear plan or the resources yet. If you are looking to get involved this is a great place to get started! We would also love to hear your ideas! Even if you can't implement it yourself, it could inspire others.

Sponsoring

Work on Pion's congestion control and bandwidth estimation was funded through the User-Operated Internet fund, a fund established by NLnet made possible by financial support from the PKT Community/The Network Steward and stichting Technology Commons Trust.

Community

Pion has an active community on the Discord.

Follow the Pion Bluesky or Pion Twitter for project updates and important WebRTC news.

We are always looking to support your projects. Please reach out if you have something to build! If you need commercial support or don't want to use public methods you can contact us at [email protected]

Contributing

Check out the contributing wiki to join the group of amazing people making this project possible

License

MIT License - see LICENSE for full text

webrtc (pion/webrtc)

Searching Database…

16.8K ·GitHub
Webrtc
What is this?A pure Go implementation of the WebRTC API: Go programs can exchange real-time audio, video and data with browsers and other peers, with no Cgo and no native WebRTC libraries.
Is this a library I import into my own code, or a ready-made app?It is a library you import into your own Go project, implementing the standard PeerConnection API (webrtc-pc and webrtc-stats). The repo also ships separate example applications built on top of it.
How do I add it to a Go project?Via Go Modules: set GO111MODULE=on and import github.com/pion/webrtc/v4 — the /v4 suffix is mandatory. The repo's example applications then show common usage patterns end to end.
Is everything really pure Go?One exception: capturing a local camera or microphone via getUserMedia requires Cgo. The rest of the stack — ICE, DTLS, SRTP, media packetizing — works with no C dependencies at all.
Where does it run?Almost anywhere Go compiles: Windows, macOS, Linux, FreeBSD, iOS and Android, plus WASM in the browser. Supported architectures include 386, amd64, arm, mips and ppc64.
What if I can't move to v4 yet?v4.0.0 brought breaking changes, but v3 is still available — the README points to the tags for the latest v3 release if you aren't able to upgrade yet.
How fast are builds and tests?Very fast: on an old Core i5 the play-from-disk example compiled in 0.66 seconds and the entire test suite finished in about 1 minute 17 seconds.
Does it handle simulcast and bandwidth estimation?Yes — the media stack includes simulcast, SVC, NACK, sender/receiver reports, transport-wide congestion control feedback and bandwidth estimation, with hardware acceleration available for GCM suites.
Is commercial support available?Yes — beyond the free Discord community, FAQ and GoDoc reference, the team offers commercial support via [email protected].
What are similar projects?WebRTC-Experiment, mediamtx, Piik, ai-native-callcenter, samples, srs, jargo, peerjs
Which topics is it in?voip, webcam, webrtc, webassembly, p2p, wasm, real-time, audio, golang, streaming, video, networking
Creator
pion
Size
6.9 MB
Stars
16.8K
Updated
CommitOct 16Releasev4.2.24Oct 16
Age
8y
Commits · 90 Days