docs/gst/tmpl/gst.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Gstreamer
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Media library supporting arbitrary formats and filter graphs.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 GStreamer is a framework for constructing graphs of various filters
  10 (termed elements here) that will handle streaming media.  Any discreet
  11 (packetizable) media type is supported, with provisions for automatically
  12 determining source type.  Metadata can be passed with all data to provide
  13 formatting/framing information.  Plugins are heavily used to provide for
  14 all elements, allowing one to construct plugins outside of the GST
  15 library, even released binary-only if license require (please don't).
  16 </para>
  17
  18 <para>
  19 GStreamer borrows heavily from both the <ulink
  20 url="http://www.cse.ogi.edu/sysl/">OGI media pipeline</ulink> and
  21 Microsoft's DirectShow, hopefully taking the best of both and leaving the
  22 cruft behind.  Its interface is still very fluid (I've redesigned the
  23 metadata handling twice already), and thus can be changed to increase the
  24 sanity/noise ratio.
  25 </para>
  26
  27 <para>
  28 The <application>GStreamer</application> library should be initialized with gst_init() before
  29 it can be used. You should pass a pointer to the main argc and argv variables so that GStreamer can
  30 process its own command line options, as shown in the following example.
  31
  32   <programlisting>
  33   int
  34   main (int argc, char *argv[])
  35   {
  36     // initialize the GStreamer library
  37     gst_init (&amp;argc, &amp;argv);
  38     ...
  39   }
  40   </programlisting>
  41 </para>
  42 <para>
  43   Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros
  44   to find the version at compile time.
  45 </para>
  46 <para>
  47 gst_main() and gst_main_quit() enter and exit the main loop.
  48 </para>
  49
  50 <!-- ##### SECTION See_Also ##### -->
  51 <para>
  52 Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's
  53 pipeline</ulink> and Microsoft's DirectShow for some background.
  54 </para>
  55
  56 <!-- ##### FUNCTION gst_init ##### -->
  57 <para>
  58
  59 </para>
  60
  61 @argc:
  62 @argv:
  63
  64
  65 <!-- ##### FUNCTION gst_version ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @major:
  71 @minor:
  72 @micro:
  73
  74
  75 <!-- ##### FUNCTION gst_main ##### -->
  76 <para>
  77
  78 </para>
  79
  80
  81
  82 <!-- ##### FUNCTION gst_main_quit ##### -->
  83 <para>
  84
  85 </para>
  86
  87
  88
  89 <!-- ##### MACRO GST_VERSION_MAJOR ##### -->
  90 <para>
  91 The major version of GStreamer at compile time
  92 </para>
  93
  94
  95
  96 <!-- ##### MACRO GST_VERSION_MINOR ##### -->
  97 <para>
  98 The minor version of GStreamer at compile time
  99 </para>
 100
 101
 102
 103 <!-- ##### MACRO GST_VERSION_MICRO ##### -->
 104 <para>
 105 The micro version of GStreamer at compile time
 106 </para>
 107
 108
 109