Pion WebRTC

A Golang implementation of the WebRTC API

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

Install

Currently Pion uses CGO and OpenSSL for DTLS. We are actively working on replacing it. For now you have to make sure to install a C compliler and the OpenSSL headers for your platform:

Ubuntu/Debian

sudo apt-get install libssl-dev

OSX

brew install openssl
export CPATH=`brew --prefix`/opt/openssl/include
export LIBRARY_PATH=`brew --prefix`/opt/openssl/lib
go get -u github.com/pions/webrtc

Fedora

sudo yum install openssl-devel

Windows

Install mingw-w64
Install pkg-config-lite
Build (or install precompiled) openssl for mingw32-w64
Set PKG_CONFIG_PATH to the directory containing openssl.pc (i.e. c:\mingw64\mingw64\lib\pkgconfig)

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.

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.
[WIP] pions/dcnet: A package providing Golang net interfaces around Pion WebRTC data channels.

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

License

MIT License - see LICENSE.md for full text

mikeykhalil / webrtc