github.com/pion/webrtc/v4@v4.0.1/README.md (about) 1 <h1 align="center"> 2 <a href="https://pion.ly"><img src="./.github/pion-gopher-webrtc.png" alt="Pion WebRTC" height="250px"></a> 3 <br> 4 Pion WebRTC 5 <br> 6 </h1> 7 <h4 align="center">A pure Go implementation of the WebRTC API</h4> 8 <p align="center"> 9 <a href="https://pion.ly"><img src="https://img.shields.io/badge/pion-webrtc-gray.svg?longCache=true&colorB=brightgreen" alt="Pion WebRTC"></a> 10 <a href="https://sourcegraph.com/github.com/pion/webrtc?badge"><img src="https://sourcegraph.com/github.com/pion/webrtc/-/badge.svg" alt="Sourcegraph Widget"></a> 11 <a href="https://pion.ly/slack"><img src="https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen" alt="Slack Widget"></a> 12 <a href="https://twitter.com/_pion?ref_src=twsrc%5Etfw"><img src="https://img.shields.io/twitter/url.svg?label=Follow%20%40_pion&style=social&url=https%3A%2F%2Ftwitter.com%2F_pion" alt="Twitter Widget"></a> 13 <a href="https://github.com/pion/awesome-pion" alt="Awesome Pion"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a> 14 <br> 15 <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/pion/webrtc/test.yaml"> 16 <a href="https://pkg.go.dev/github.com/pion/webrtc/v4"><img src="https://pkg.go.dev/badge/github.com/pion/webrtc/v4.svg" alt="Go Reference"></a> 17 <a href="https://codecov.io/gh/pion/webrtc"><img src="https://codecov.io/gh/pion/webrtc/branch/master/graph/badge.svg" alt="Coverage Status"></a> 18 <a href="https://goreportcard.com/report/github.com/pion/webrtc/v4"><img src="https://goreportcard.com/badge/github.com/pion/webrtc/v4" alt="Go Report Card"></a> 19 <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a> 20 </p> 21 <br> 22 23 ### New Release 24 25 Pion WebRTC v4.0.0 has been released! See the [release notes](https://github.com/pion/webrtc/wiki/Release-WebRTC@v4.0.0) to learn about new features and breaking changes. 26 27 If you aren't able to upgrade yet check the [tags](https://github.com/pion/webrtc/tags) for the latest `v3` release. 28 29 We would love your feedback! Please create GitHub issues or join [the Slack channel](https://pion.ly/slack) to follow development and speak with the maintainers. 30 31 ----- 32 33 ### Usage 34 [Go Modules](https://blog.golang.org/using-go-modules) are mandatory for using Pion WebRTC. So make sure you set `export GO111MODULE=on`, and explicitly specify `/v4` (or an earlier version) when importing. 35 36 37 **[example applications](examples/README.md)** contains code samples of common things people build with Pion WebRTC. 38 39 **[example-webrtc-applications](https://github.com/pion/example-webrtc-applications)** contains more full featured examples that use 3rd party libraries. 40 41 **[awesome-pion](https://github.com/pion/awesome-pion)** contains projects that have used Pion, and serve as real world examples of usage. 42 43 **[GoDoc](https://pkg.go.dev/github.com/pion/webrtc/v4)** is an auto generated API reference. All our Public APIs are commented. 44 45 **[FAQ](https://github.com/pion/webrtc/wiki/FAQ)** has answers to common questions. If you have a question not covered please ask in [Slack](https://pion.ly/slack) we are always looking to expand it. 46 47 Now go build something awesome! Here are some **ideas** to get your creative juices flowing: 48 * Send a video file to multiple browser in real time for perfectly synchronized movie watching. 49 * Send a webcam on an embedded device to your browser with no additional server required! 50 * Securely send data between two servers, without using pub/sub. 51 * Record your webcam and do special effects server side. 52 * Build a conferencing application that processes audio/video and make decisions off of it. 53 * Remotely control a robots and stream its cameras in realtime. 54 55 ### Need Help? 56 Check out [WebRTC for the Curious](https://webrtcforthecurious.com). A book about WebRTC in depth, not just about the APIs. 57 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 58 resource if you are trying to debug. Learn the tools of the trade and how to approach WebRTC issues. This book is vendor 59 agnostic and will not have any Pion specific information. 60 61 Pion has an active community on [Slack](https://pion.ly/slack). Please ask for help about anything, questions don't have to be Pion specific! 62 Come share your interesting project you are working on. We are here to support you. 63 64 One of the maintainers of Pion [Sean-Der](https://github.com/sean-der) is available to help. Schedule at [siobud.com/meeting](https://siobud.com/meeting) 65 He is available to talk about Pion or general WebRTC questions, feel free to reach out about anything! 66 67 ### Features 68 #### PeerConnection API 69 * Go implementation of [webrtc-pc](https://w3c.github.io/webrtc-pc/) and [webrtc-stats](https://www.w3.org/TR/webrtc-stats/) 70 * DataChannels 71 * Send/Receive audio and video 72 * Renegotiation 73 * Plan-B and Unified Plan 74 * [SettingEngine](https://pkg.go.dev/github.com/pion/webrtc/v4#SettingEngine) for Pion specific extensions 75 76 77 #### Connectivity 78 * Full ICE Agent 79 * ICE Restart 80 * Trickle ICE 81 * STUN 82 * TURN (UDP, TCP, DTLS and TLS) 83 * mDNS candidates 84 85 #### DataChannels 86 * Ordered/Unordered 87 * Lossy/Lossless 88 89 #### Media 90 * API with direct RTP/RTCP access 91 * Opus, PCM, H264, VP8 and VP9 packetizer 92 * API also allows developer to pass their own packetizer 93 * IVF, Ogg, H264 and Matroska provided for easy sending and saving 94 * [getUserMedia](https://github.com/pion/mediadevices) implementation (Requires Cgo) 95 * Easy integration with x264, libvpx, GStreamer and ffmpeg. 96 * [Simulcast](https://github.com/pion/webrtc/tree/master/examples/simulcast) 97 * [SVC](https://github.com/pion/rtp/blob/master/codecs/vp9_packet.go#L138) 98 * [NACK](https://github.com/pion/interceptor/pull/4) 99 * [Sender/Receiver Reports](https://github.com/pion/interceptor/tree/master/pkg/report) 100 * [Transport Wide Congestion Control Feedback](https://github.com/pion/interceptor/tree/master/pkg/twcc) 101 * [Bandwidth Estimation](https://github.com/pion/webrtc/tree/master/examples/bandwidth-estimation-from-disk) 102 103 #### Security 104 * TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 and TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA for DTLS v1.2 105 * SRTP_AEAD_AES_256_GCM and SRTP_AES128_CM_HMAC_SHA1_80 for SRTP 106 * Hardware acceleration available for GCM suites 107 108 #### Pure Go 109 * No Cgo usage 110 * Wide platform support 111 * Windows, macOS, Linux, FreeBSD 112 * iOS, Android 113 * [WASM](https://github.com/pion/webrtc/wiki/WebAssembly-Development-and-Testing) see [examples](examples/README.md#webassembly) 114 * 386, amd64, arm, mips, ppc64 115 * Easy to build *Numbers generated on Intel(R) Core(TM) i5-2520M CPU @ 2.50GHz* 116 * **Time to build examples/play-from-disk** - 0.66s user 0.20s system 306% cpu 0.279 total 117 * **Time to run entire test suite** - 25.60s user 9.40s system 45% cpu 1:16.69 total 118 * Tools to measure performance [provided](https://github.com/pion/rtsp-bench) 119 120 ### Roadmap 121 The library is in active development, please refer to the [roadmap](https://github.com/pion/webrtc/issues/9) to track our major milestones. 122 We also maintain a list of [Big Ideas](https://github.com/pion/webrtc/wiki/Big-Ideas) these are things we want to build but don't have a clear plan or the resources yet. 123 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. 124 125 ### Sponsoring 126 Work on Pion's congestion control and bandwidth estimation was funded through the [User-Operated Internet](https://nlnet.nl/useroperated/) fund, a fund established by [NLnet](https://nlnet.nl/) made possible by financial support from the [PKT Community](https://pkt.cash/)/[The Network Steward](https://pkt.cash/network-steward) and stichting [Technology Commons Trust](https://technologycommons.org/). 127 128 ### Community 129 Pion has an active community on the [Slack](https://pion.ly/slack). 130 131 Follow the [Pion Twitter](https://twitter.com/_pion) for project updates and important WebRTC news. 132 133 We are always looking to support **your projects**. Please reach out if you have something to build! 134 If you need commercial support or don't want to use public methods you can contact us at [team@pion.ly](mailto:team@pion.ly) 135 136 ### Contributing 137 Check out the [contributing wiki](https://github.com/pion/webrtc/wiki/Contributing) to join the group of amazing people making this project possible 138 139 ### License 140 MIT License - see [LICENSE](LICENSE) for full text