github.com/pion/webrtc/v3@v3.2.24/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/v3"><img src="https://pkg.go.dev/badge/github.com/pion/webrtc/v3.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/v3"><img src="https://goreportcard.com/badge/github.com/pion/webrtc/v3" 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  ### Usage
    24  [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 `/v2` or `/v3` when importing.
    25  
    26  
    27  **[example applications](examples/README.md)** contains code samples of common things people build with Pion WebRTC.
    28  
    29  **[example-webrtc-applications](https://github.com/pion/example-webrtc-applications)** contains more full featured examples that use 3rd party libraries.
    30  
    31  **[awesome-pion](https://github.com/pion/awesome-pion)** contains projects that have used Pion, and serve as real world examples of usage.
    32  
    33  **[GoDoc](https://pkg.go.dev/github.com/pion/webrtc/v3)** is an auto generated API reference. All our Public APIs are commented.
    34  
    35  **[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.
    36  
    37  Now go build something awesome! Here are some **ideas** to get your creative juices flowing:
    38  * Send a video file to multiple browser in real time for perfectly synchronized movie watching.
    39  * Send a webcam on an embedded device to your browser with no additional server required!
    40  * Securely send data between two servers, without using pub/sub.
    41  * Record your webcam and do special effects server side.
    42  * Build a conferencing application that processes audio/video and make decisions off of it.
    43  * Remotely control a robots and stream its cameras in realtime.
    44  
    45  ### Want to learn more about WebRTC?
    46  Join our [Office Hours](https://github.com/pion/webrtc/wiki/OfficeHours). Come hang out, ask questions, get help debugging and
    47  hear about the cool things being built with WebRTC. We also start every meeting with basic project planning.
    48  
    49  Check out [WebRTC for the Curious](https://webrtcforthecurious.com). A book about WebRTC in depth, not just about the APIs.
    50  Learn the full details of ICE, SCTP, DTLS, SRTP, and how they work together to make up the WebRTC stack.
    51  
    52  This is also a great resource if you are trying to debug. Learn the tools of the trade and how to approach WebRTC issues.
    53  
    54  This book is vendor agnostic and will not have any Pion specific information.
    55  
    56  ### Features
    57  #### PeerConnection API
    58  * Go implementation of [webrtc-pc](https://w3c.github.io/webrtc-pc/) and [webrtc-stats](https://www.w3.org/TR/webrtc-stats/)
    59  * DataChannels
    60  * Send/Receive audio and video
    61  * Renegotiation
    62  * Plan-B and Unified Plan
    63  * [SettingEngine](https://pkg.go.dev/github.com/pion/webrtc/v3#SettingEngine) for Pion specific extensions
    64  
    65  
    66  #### Connectivity
    67  * Full ICE Agent
    68  * ICE Restart
    69  * Trickle ICE
    70  * STUN
    71  * TURN (UDP, TCP, DTLS and TLS)
    72  * mDNS candidates
    73  
    74  #### DataChannels
    75  * Ordered/Unordered
    76  * Lossy/Lossless
    77  
    78  #### Media
    79  * API with direct RTP/RTCP access
    80  * Opus, PCM, H264, VP8 and VP9 packetizer
    81  * API also allows developer to pass their own packetizer
    82  * IVF, Ogg, H264 and Matroska provided for easy sending and saving
    83  * [getUserMedia](https://github.com/pion/mediadevices) implementation (Requires Cgo)
    84  * Easy integration with x264, libvpx, GStreamer and ffmpeg.
    85  * [Simulcast](https://github.com/pion/webrtc/tree/master/examples/simulcast)
    86  * [SVC](https://github.com/pion/rtp/blob/master/codecs/vp9_packet.go#L138)
    87  * [NACK](https://github.com/pion/interceptor/pull/4)
    88  * [Sender/Receiver Reports](https://github.com/pion/interceptor/tree/master/pkg/report)
    89  * [Transport Wide Congestion Control Feedback](https://github.com/pion/interceptor/tree/master/pkg/twcc)
    90  * [Bandwidth Estimation](https://github.com/pion/webrtc/tree/master/examples/bandwidth-estimation-from-disk)
    91  
    92  #### Security
    93  * TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 and TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA for DTLS v1.2
    94  * SRTP_AEAD_AES_256_GCM and SRTP_AES128_CM_HMAC_SHA1_80 for SRTP
    95  * Hardware acceleration available for GCM suites
    96  
    97  #### Pure Go
    98  * No Cgo usage
    99  * Wide platform support
   100    * Windows, macOS, Linux, FreeBSD
   101    * iOS, Android
   102    * [WASM](https://github.com/pion/webrtc/wiki/WebAssembly-Development-and-Testing) see [examples](examples/README.md#webassembly)
   103    *  386, amd64, arm, mips, ppc64
   104  * Easy to build *Numbers generated on Intel(R) Core(TM) i5-2520M CPU @ 2.50GHz*
   105    * **Time to build examples/play-from-disk** - 0.66s user 0.20s system 306% cpu 0.279 total
   106    * **Time to run entire test suite** - 25.60s user 9.40s system 45% cpu 1:16.69 total
   107  * Tools to measure performance [provided](https://github.com/pion/rtsp-bench)
   108  
   109  ### Roadmap
   110  The library is in active development, please refer to the [roadmap](https://github.com/pion/webrtc/issues/9) to track our major milestones.
   111  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.
   112  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.
   113  
   114  ### Sponsoring
   115  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/).
   116  
   117  ### Community
   118  Pion has an active community on the [Slack](https://pion.ly/slack).
   119  
   120  Follow the [Pion Twitter](https://twitter.com/_pion) for project updates and important WebRTC news.
   121  
   122  We are always looking to support **your projects**. Please reach out if you have something to build!
   123  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)
   124  
   125  ### Contributing
   126  Check out the [contributing wiki](https://github.com/pion/webrtc/wiki/Contributing) to join the group of amazing people making this project possible: [AUTHORS.txt](./AUTHORS.txt)
   127  
   128  ### License
   129  MIT License - see [LICENSE](LICENSE) for full text