README.md: Document the binaries and Cerbero

Also mention where to file bug reports about the plugin itself.
This commit is contained in:
Nirbheek Chauhan 2018-03-10 13:21:34 +05:30
parent 55e86469d9
commit 429f4bb65f

View file

@ -2,15 +2,29 @@
All demos use the same signalling server in the `signalling/` directory All demos use the same signalling server in the `signalling/` directory
## Build ## Downloading GStreamer
The GStreamer WebRTC implementation has now been merged upstream, so all The GStreamer WebRTC implementation has now been merged upstream, and is in the GStreamer 1.14 release. Binaries can be found here:
you need is the latest GStreamer git master, as of 2 February 2018 or later:
https://gstreamer.freedesktop.org/download/
## Building GStreamer from source
If you don't want to use the binaries provided by GStreamer or on your Linux distro, you can build GStreamer from source.
The easiest way to build the webrtc plugin and all the plugins it needs, is to [use Cerbero](https://gstreamer.freedesktop.org/documentation/installing/building-from-source-using-cerbero.html). These instructions should work out of the box for all platforms, including cross-compiling for iOS and Android.
One thing to note is that it's written in Python 2, so you may need to replace all instances of `./cerbero-uninstalled` (or `cerbero`) with `python2 cerbero-uninstalled` or whatever Python 2 is called on your platform.
## Building GStreamer manually from source
For hacking on the webrtc plugin, you may want to build manually using the git repositories:
- http://cgit.freedesktop.org/gstreamer/gstreamer - http://cgit.freedesktop.org/gstreamer/gstreamer
- http://cgit.freedesktop.org/gstreamer/gst-plugins-base - http://cgit.freedesktop.org/gstreamer/gst-plugins-base
- http://cgit.freedesktop.org/gstreamer/gst-plugins-good - http://cgit.freedesktop.org/gstreamer/gst-plugins-good
- http://cgit.freedesktop.org/gstreamer/gst-plugins-bad - http://cgit.freedesktop.org/gstreamer/gst-plugins-bad
- http://cgit.freedesktop.org/libnice/libnice
You can build these with either Autotools gst-uninstalled: You can build these with either Autotools gst-uninstalled:
@ -24,6 +38,12 @@ You may need to install the following packages using your package manager:
json-glib, libsoup, libnice, libnice-gstreamer1 (the gstreamer plugin for libnice) json-glib, libsoup, libnice, libnice-gstreamer1 (the gstreamer plugin for libnice)
## Filing bugs
Please only file bugs about the demos here. Bugs about GStreamer's WebRTC implementation should be filed on the [GStreamer bugzilla](https://bugzilla.gnome.org/enter_bug.cgi?product=GStreamer&component=gst-plugins-bad).
You can also find us on IRC by joining #gstreamer @ FreeNode.
## Documentation ## Documentation
Currently, the best way to understand the API is to read the examples. This post breaking down the API should help with that: Currently, the best way to understand the API is to read the examples. This post breaking down the API should help with that: