Repository files navigation

Go Modules are mandatory for using Pion WebRTC. So make sure you setexport GO111MODULE=on, and explicitly specify/v2 or/v3 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 inSlack we are always looking to expand it.

Now go build something awesome! Here are someideas 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.
• Remotely control a robots and stream its cameras in realtime.

Join ourOffice Hours. Come hang out, ask questions, get help debugging andhear about the cool things being built with WebRTC. We also start every meeting with basic project planning.

Check outWebRTC 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.

• Go implementation ofwebrtc-pc andwebrtc-stats
• DataChannels
• Send/Receive audio and video
• Renegotiation
• Plan-B and Unified Plan
• SettingEngine for Pion specific extensions

• Full ICE Agent
• ICE Restart
• Trickle ICE
• STUN
• TURN (UDP, TCP, DTLS and TLS)
• mDNS candidates

• Ordered/Unordered
• Lossy/Lossless

• API with direct RTP/RTCP access
• Opus, PCM, H264, VP8 and VP9 packetizer
• API also allows developer to pass their own packetizer
• IVF, Ogg, H264 and Matroska provided for easy sending and saving
• getUserMedia implementation (Requires Cgo)
• Easy integration with x264, libvpx, GStreamer and ffmpeg.
• Simulcast
• SVC
• NACK
• Sender/Receiver Reports
• Transport Wide Congestion Control Feedback
• Bandwidth Estimation

• TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 and TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA for DTLS v1.2
• SRTP_AEAD_AES_256_GCM and SRTP_AES128_CM_HMAC_SHA1_80 for SRTP
• Hardware acceleration available for GCM suites

• No Cgo usage
• Wide platform support
  • Windows, macOS, Linux, FreeBSD
  • iOS, Android
  • WASM seeexamples
  • 386, amd64, arm, mips, ppc64
• Easy to buildNumbers generated on Intel(R) Core(TM) i5-2520M CPU @ 2.50GHz
  • Time to build examples/play-from-disk - 0.66s user 0.20s system 306% cpu 0.279 total
  • Time to run entire test suite - 25.60s user 9.40s system 45% cpu 1:16.69 total
• Tools to measure performanceprovided

The library is in active development, please refer to theroadmap to track our major milestones.We also maintain a list ofBig 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.

Work on Pion's congestion control and bandwidth estimation was funded through theUser-Operated Internet fund, a fund established byNLnet made possible by financial support from thePKT Community/The Network Steward and stichtingTechnology Commons Trust.

Pion has an active community on theSlack.

Follow thePion Twitter for project updates and important WebRTC news.

We are always looking to supportyour 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 atteam@pion.ly

Check out thecontributing wiki to join the group of amazing people making this project possible:AUTHORS.txt

MIT License - seeLICENSE for full text