c803a9b584ca440a4bf47831f81e3d23387463cf
[platform/upstream/gstreamer.git] / README.md
1 gstreamer-sharp
2 =========
3
4 gstreamer-sharp is a .NET/mono binding for Gstreamer generated from gobject-introspection data using the [bindinator]. gstreamer-sharp currently wraps the API exposed by Gstreamer 1.4 and is compatible with newer gstreamer versions. It was developed under GSoC 2014 for the mono organization.
5 gstreamer-sharp covers the core and base gstreamer libraries.
6
7 Prerequisites
8 ----
9 These libraries are needed for clutter-sharp to compile:
10 * gstreamer core, base and good 1.4 or higher
11 * [gtk-sharp] 3.22.6 or higher - *NOTE: This can be built as a meson subproject if using the meson build system.*
12
13 Building & Installing
14 ----
15 With meson:
16
17     meson build && ninja -C build/
18
19 With Autotools:
20
21     ./autogen.sh --prefix=/usr && make install
22
23 Supported Platforms
24 ----
25 * Linux
26 * Mac OS X
27
28 Quick Start
29 ----
30 gstreamer-sharp provides ports of all samples from gst-docs in the samples folder.
31
32 Documentation
33 ----
34
35 Since this is a gobject-introspection binding the recommended documentation is the native [gstreamer](http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/) documentation. A monodoc generated documentation will be installed.
36
37 Roadmap
38 ----
39 * Add an easy way to compile on Windows
40 * iOS and Android support
41 * Provide binaries for these platforms
42
43 License
44 ----
45 gstreamer-sharp is licensed under the [LGPL 2.1](https://www.gnu.org/licenses/lgpl-2.1.html)
46
47 [bindinator]:https://github.com/shana/bindinator
48 [gtk-sharp]:https://github.com/openmedicus/gtk-sharp