samples README

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

WebRTC Code Samples

This is a repository for the WebRTC JavaScript code samples. All of the samples can be tested from webrtc.github.io/samples.

To run the samples locally

npm install && npm start

and open your browser on the page indicated.

Contributing

We welcome contributions and bugfixes. Please see CONTRIBUTING.md for details.

Bugs

If you encounter a bug or problem with one of the samples, please submit a new issue so we know about it and can fix it.

Please avoid submitting issues on this repository for general problems you have with WebRTC. If you have found a bug in the WebRTC APIs, please see webrtc.org/bugs for how to submit bugs on the affected browsers. If you need support on how to implement your own WebRTC-based application, please see the discuss-webrtc Google Group.

samples (webrtc/samples)

Searching Database…

14.6K ·GitHub
What is this?This is the official collection of WebRTC JavaScript code samples, demonstrating how to use WebRTC APIs for real-time audio, video, and data communication in the browser.
Is this a library or a bunch of standalone demos?It is a set of standalone demo pages, one per WebRTC feature, not a packaged library you import into your app.
How do I run the samples locally?Start a local server with the provided npm start script and open your browser on the page you want to try, or just visit the hosted versions at webrtc.github.io/samples.
Do I need any special backend or account to try these?No backend or API key is needed for most samples; they rely on browser-native WebRTC APIs, though some may need a local HTTP server due to camera/mic permission restrictions.
Where do these samples run?They run entirely in a web browser.
Is this repo actively maintained by Google/the WebRTC project?Yes, it's hosted under the official webrtc GitHub organization and has CI workflows (interop-tests.yml, test.yml) running against it.
Creator
webrtc
Size
18 MB
Stars
14.6K
Updated
CommitJul 14
Age
13y
Commits · 90 Days