webrtc

by pion

pion / webrtc

Pure Go implementation of the WebRTC API

5.7K Stars 674 Forks Last release: 6 days ago (v3.0.0-beta.10) MIT License 1.3K Commits 88 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Pion WebRTC
Pion WebRTC

A pure Go implementation of the WebRTC API

Pion webrtc Sourcegraph Widget Slack Widget Twitter Widget
Build Status PkgGoDev Coverage Status Go Report Card Codacy Badge License: MIT


Breaking Changes

Pion WebRTC v3.0.0 has started! See the release notes to learn about new features and breaking changes.

Until

v3.0.0
has been tagged using
v2
is suggested. Check the tags for the latest
v2
release.

Go Modules are mandatory for using Pion WebRTC. So make sure you set

export GO111MODULE=on
, and explicitly specify
/v2
or
/v3
when importing.

We are actively planning and would love your feedback! Please create GitHub issues or join the Slack channel to follow development and speak with the maintainers.


Pion WebRTC is a pure Go implementation of WebRTC. It has zero non-Go dependencies and no 3rd party Go dependencies. It is designed to follow WebRTC API, but may deviate when required. See DESIGN.md for the guiding principals/inspirations of the project.

Usage

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 Slack we are always looking to expand it.

Now go build something awesome! 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.

Want to learn more about WebRTC?

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. Leran the tools of the trade and how to approach WebRTC issues.

This book is vendor agnostic and will not have any Pion specific information.

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

Community

Pion has an active community on the Slack.

Follow the 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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.