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