Pion WebRTC

A pure Go implementation of the WebRTC API

See DESIGN.md for an overview of features and future goals.

Breaking Changes

Pion WebRTC v2.0.0 is coming soon! HEAD will be unstable for the next few weeks as we prepare for the new release. See the release notes to learn about the new features breaking changes.

Have any questions? Join the Slack channel to follow development and speak with the maintainers.

Use the tag v1.2.0 if you'd like to continue using the v1.0 API in the meantime. After v2.0 is released v1.0 will be deprecated and unmaintained.

Usage

Check out the example applications to help you along your Pion WebRTC journey.

The Pion WebRTC API closely matches the JavaScript WebRTC API. Most existing documentation is therefore also usefull when working with Pion. Furthermore, our GoDoc is actively maintained.

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

• Send a video file to multiple browser in real time for perfectly synchronized movie watching.
• Send a webcam on an embedded device to your browser with no additional server required!
• Securely send data between two servers, without using pub/sub.
• Record your webcam and do special effects server side.
• Build a conferencing application that processes audio/video and make decisions off of it.

WebAssembly

Pion WebRTC can be used when compiled to WebAssembly, also known as Wasm. In this case the library will act as a wrapper around the JavaScript WebRTC API. This allows you to use WebRTC from Go in both server and browser side code with little to no changes. Check out the example applications for instructions on how to compile and run the WebAssembly examples. You can also visit the Wiki page on WebAssembly Development for more information.

Roadmap

The library is in active development, please refer to the roadmap to track our major milestones.

Community

Pion has an active community on the Golang Slack. Sign up and join the #pion channel for discussions and support. You can also use Pion mailing list.

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 team@pion.ly

Related projects

• pions/turn: A simple extendable Golang TURN server
• [WIP] pions/media-server: A Pion WebRTC powered media server, providing the building blocks for anything RTC.

Contributing

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

• John Bradley - Original Author
• Michael Melvin Santry - Mascot
• Raphael Randschau - STUN
• Sean DuBois - Original Author
• Michiel De Backker - SDP, Public API, Project Management
• Brendan Rius - Cleanup
• Konstantin Itskov - SDP Parsing
• chenkaiC4 - Fix GolangCI Linter
• Ronan J - Fix STCP PPID
• wattanakorn495
• Max Hawkins - RTCP
• Justin Okamoto - Fix Docs
• leeoxiang - Implement Janus examples
• Denis - Adding docker-compose to pion-to-pion example
• earle - Generate DTLS fingerprint in Go
• Jake B - Fix Windows installation instructions
• Michael MacDonald
• Oleg Kovalov Use wildcards instead of hardcoding travis-ci config
• Woodrow Douglass RTCP, RTP improvements, G.722 support, Bugfixes
• Tobias Fridén SRTP authentication verification
• Yutaka Takeda Fix ICE connection timeout
• Hugo Arregui Fix connection timeout
• Rob Deutsch RTPReceiver graceful shutdown
• Jin Lei - SFU example use http
• Will Watson - Enable gocritic
• Luke Curley
• Antoine Baché - OGG Opus export
• frank - Building examples on OSX
• mxmCherry
• Alex Browne - JavaScript/Wasm bindings
• adwpc - SFU example with websocket
• imalic3 - SFU websocket example with datachannel broadcast
• Žiga Željko

License

MIT License - see LICENSE for full text