README

   1 WHAT IT IS
   2 ----------
   3
   4 gst-plugin is a template for writing your own GStreamer plug-in.
   5
   6 The code is deliberately kept simple so that you quickly understand the basics
   7 of how to set up autotools and your source tree.
   8
   9 This template demonstrates :
  10 - what to do in autogen.sh
  11 - how to setup configure.ac (your package name and version, GStreamer flags)
  12 - how to setup your source dir
  13 - what to put in Makefile.am
  14
  15 More features and templates might get added later on.
  16
  17 HOW TO USE IT
  18 -------------
  19
  20 To use it, either make a copy for yourself and rename the parts or use the
  21 make_element script in tools. To create sources for "myfilter" based on the
  22 "gsttransform" template run:
  23
  24 cd src;
  25 ../tools/make_element myfilter gsttransform
  26
  27 This will create gstmyfilter.c and gstmyfilter.h. Open them in an editor and
  28 start editing. There are several occurances of the string "template", update
  29 those with real values. The plugin will be called 'myfilter' and it will have
  30 one element called 'myfilter' too. Also look for "FIXME:" markers that point you
  31 to places where you need to edit the code.
  32
  33 You still need to adjust the Makefile.am.
  34