webrtc README

The project's README from github.com/pion/webrtc. As one markdown file: README.md.

Pion WebRTC
Pion WebRTC

A pure Go implementation of the WebRTC API

Pion WebRTC Sourcegraph Widget join us on Discord Follow us on Bluesky Twitter Widget
GitHub Workflow Status Go Reference Coverage Status Go Report Card License: MIT


New Release

Pion WebRTC v4.0.0 has been released! See the release notes to learn about new features and breaking changes.

If you aren't able to upgrade yet check the tags for the latest v3 release.

We would love your feedback! Please create GitHub issues or Join the Discord to follow development and speak with the maintainers.


Usage

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.

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

Now go build something awesome! Here are some ideas to get your creative juices flowing:

Need Help?

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

Pion has an active community on Discord. Please ask for help about anything, questions don't have to be Pion specific! Come share your interesting project you are working on. We are here to support you.

One of the maintainers of Pion Sean-Der is available to help. Schedule at siobud.com/meeting He is available to talk about Pion or general WebRTC questions, feel free to reach out about anything!

Features

PeerConnection API

Connectivity

DataChannels

Media

Security

Pure Go

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.

Sponsoring

Work on Pion's congestion control and bandwidth estimation was funded through the User-Operated Internet fund, a fund established by NLnet made possible by financial support from the PKT Community/The Network Steward and stichting Technology Commons Trust.

Community

Pion has an active community on the Discord.

Follow the Pion Bluesky or 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

webrtc (pion/webrtc)

Searching Database…

16.8K ·GitHub
Что это такое?Чистая реализация WebRTC API на Go: программы на Go могут обмениваться аудио, видео и данными в реальном времени с браузерами и другими участниками — без Cgo и без нативных библиотек WebRTC.
Это библиотека, которую я подключаю в свой код, или готовое приложение?Это библиотека, которую вы подключаете в свой Go-проект; она реализует стандартный API PeerConnection (webrtc-pc и webrtc-stats). В репозитории также есть отдельные примеры приложений, построенных поверх неё.
Как добавить её в Go-проект?Через Go Modules: установите GO111MODULE=on и импортируйте github.com/pion/webrtc/v4 — суффикс /v4 обязателен. Примеры приложений из репозитория показывают типовые сценарии использования от начала до конца.
Правда, что всё написано на чистом Go?Есть одно исключение: захват локальной камеры или микрофона через getUserMedia требует Cgo. Вся остальная часть стека — ICE, DTLS, SRTP, упаковка медиаданных — работает вообще без C-зависимостей.
Где это работает?Практически везде, где компилируется Go: Windows, macOS, Linux, FreeBSD, iOS и Android, а также WASM в браузере. Среди поддерживаемых архитектур — 386, amd64, arm, mips и ppc64.
А если я пока не могу перейти на v4?В версии v4.0.0 есть несовместимые изменения, но v3 по-прежнему доступна — в README есть ссылки на теги последнего релиза v3, если обновиться пока не получается.
Насколько быстро идёт сборка и тесты?Очень быстро: на старом Core i5 пример play-from-disk скомпилировался за 0,66 секунды, а весь набор тестов выполнился примерно за 1 минуту 17 секунд.
Поддерживаются ли simulcast и оценка пропускной способности?Да — медиастек включает simulcast, SVC, NACK, отчёты отправителя и получателя, transport-wide congestion control feedback и оценку пропускной способности, с аппаратным ускорением для наборов GCM.
Есть ли платная поддержка?Да — помимо бесплатного сообщества в Discord, FAQ и справочника GoDoc, команда предлагает коммерческую поддержку через [email protected].
Creator
pion
Size
6.9 MB
Stars
16.8K
Age
8y
Commits · 90 Days