Table of Contents

Installation

To build the GStreamer bindings or anything depending on them, you need to
have at least GStreamer 1.8 and gst-plugins-base 1.8 installed. In addition,
some of the examples/tutorials require various GStreamer plugins to be
available, which can be found in gst-plugins-base, gst-plugins-good,
gst-plugins-bad, gst-plugins-ugly and/or gst-libav.

Linux/BSDs

You need to install the above mentioned packages with your distributions
package manager, or build them from source.

The minimum required version of the above libraries is >= 1.8. If you
build the gstreamer-player sub-crate, or any of the examples that
depend on gstreamer-player, you must ensure that in addition to the
above packages, libgstreamer-plugins-bad1.0-dev is installed and
that the version is >= 1.12. See the Cargo.toml files for the full
details,

# Only if you wish to install gstreamer-player, make sure the version
# of this package is >=1.12.$ apt-get install libgstreamer-plugins-bad1.0-dev

Package names on other distributions should be similar.
Please submit a pull request with instructions for yours.

macOS

You can install GStreamer and the plugins via Homebrew or
by installing the binaries
provided by the GStreamer project.

Homebrew

Homebrew only installs various plugins if explicitly enabled, so some extra
--with-* flags may be required.

Getting Started

The API reference can be found
here, however it is
only the Rust API reference and does not explain any of the concepts.

For getting started with GStreamer development, the best would be to follow
the documentation on the
GStreamer website, especially the Application Development
Manual.
While being C-centric, it explains all the fundamental concepts of GStreamer
and the code examples should be relatively easily translatable to Rust. The
API is basically the same, function/struct names are the same and everything
is only more convenient (hopefully) and safer.

In addition there are
tutorials on the
GStreamer website. Many of them were ported to Rust already and the code can
be found in the
tutorials
directory.

Some further examples for various aspects of GStreamer and how to use it from
Rust can be found in the
examples
directory.

Various GStreamer plugins written in Rust can be found in the
gst-plugins-rs
repository.

LICENSE

gstreamer-rs and all crates contained in here are licensed under either of

Contribution

Any kinds of contributions are welcome as a pull request.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in gstreamer-rs by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.