Explainer provides a PeerConnection Explainer that parses WebRTC Offers/Answers then provides summaries and suggestions. It returns information like what codecs are supported, how many tracks each peer is attempting to send and ICE information. It also provides suggestions to fix common errors.
The goal of this project is to make learning and debugging WebRTC easier.
- Debugging - Discover common errors without having to read and compare SDP values.
- Learning - Learn SDP keys and values and how they effect your WebRTC sessions.
- Passive Monitoring - Add
Explainerto your existing Signaling and Media servers. Surface and fix existing issues. - Custom Tooling - Include
Explainerwith your own UI in an existing project. Make it easier for your customers to use WebRTC.
- Session Description Parsing - Human readable JSON output explaining your Offer/Answer
- Session Description Suggestions - Searches for errors and possible improvements, not just explaining the current values.
- Made for Learning - Returns line numbers for suggestion and parsing.
- Portable - Available in Browser, Go, nodejs, C/C++, Java, C# and more thanks to WASM.
- Interactive - Web demo provides interactive discovery of the SessionDescription.
- Flexible - Accepts SesionDescriptions or SDP, either value can be base64
- Decoupled - Easily ship your own UI,
Explainercan run on clients or servers
- getStats Parsing - Human readable JSON output explaining the status of your PeerConnection. What it is sending and why.
- getStats Suggestions - Understand why a certain bitrate is being sent or why you are seeing video corruption.
- getStats Graphing - Generate values that are easily plottable in your tool of choice.
Examples for different languages are in the examples directory. A Web UI is provided in the web directory.
Each example will have a README.md describing its specific setup.
The library is used as a part of our WebRTC implementation. Please refer to that roadmap to track our major milestones.
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]
Check out the contributing wiki to join the group of amazing people making this project possible
MIT License - see LICENSE for full text