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
  20     meson build && ninja -C build/
  21     I
  22 HACKING
  23 -------
  24
  25 While hacking on the code generator or the `.metadata` files, you will
  26 need to force code regeneration with `ninja update-code`, a full rebuild
  27 is triggered right after.
  28
  29 Updating to new GStreamer version
  30 --------------------------------
  31
  32 * Make sure [bindinator] is installed on the system
  33
  34 Make sure you are in an environement where latest `.gir` files are available (either install
  35 or through the `$GI_TYPELIB_PATH` env var).
  36
  37     ninja -C update-all
  38
  39 * Verify newly generated code and `git add` files in `sources/generated/` and `ges/generated`
  40 * Commit
  41
  42 Supported Platforms
  43 ----
  44 * Linux
  45 * Mac OS X
  46
  47 Quick Start
  48 ----
  49 gstreamer-sharp provides ports of all samples from gst-docs in the samples folder.
  50
  51 Documentation
  52 ----
  53
  54 Since this is a gobject-introspection binding the recommended documentation is
  55 the native [gstreamer] documentation. A monodoc generated documentation will be installed.
  56
  57 Roadmap
  58 ----
  59 * Add an easy way to compile on Windows
  60 * iOS and Android support
  61 * Provide binaries for these platforms
  62
  63 License
  64 ----
  65 gstreamer-sharp is licensed under the [LGPL 2.1](https://www.gnu.org/licenses/lgpl-2.1.html)
  66
  67 [bindinator]:https://github.com/GLibSharp/bindinator
  68 [gtk-sharp]:https://github.com/GLibSharp/GtlSharp
  69 [gstreamer]: http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/