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.  Formatting/framing information is provided with
  13 a powerful negotiation framework.  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 and thus can be changed
  23 to increase the sanity/noise ratio.
  24 </para>
  25
  26 <para>
  27 The <application>GStreamer</application> library should be initialized with gst_init() before
  28 it can be used. You should pass a pointer to the main argc and argv variables so that GStreamer can
  29 process its own command line options, as shown in the following example.
  30
  31   <programlisting>
  32   int
  33   main (int argc, char *argv[])
  34   {
  35     /* initialize the GStreamer library */
  36     gst_init (&amp;argc, &amp;argv);
  37     ...
  38   }
  39   </programlisting>
  40 </para>
  41 <para>
  42 It's allowed to pass two NULL pointers to gst_init() in case you don't want to pass the command
  43 line args to GStreamer.
  44 </para>
  45
  46 <para>
  47 You can also use a popt table to initialize your own parameters as shown in the next code
  48 fragment:
  49   <programlisting>
  50   static gboolean stats = FALSE;
  51   ...
  52
  53   int
  54   main (int argc, char *argv[])
  55   {
  56     struct poptOption options[] = {
  57       { "stats",  's',  POPT_ARG_NONE|POPT_ARGFLAG_STRIP,   &amp;stats,   0,
  58           "Show pad stats", NULL},
  59         POPT_TABLEEND
  60       };
  61
  62     /* initialize the GStreamer library */
  63     gst_init_with_popt_table (&amp;argc, &amp;argv, options);
  64
  65     ...
  66   }
  67   </programlisting>
  68 </para>
  69 <para>
  70   Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros
  71   to find the version at compile time.
  72 </para>
  73 <para>
  74 gst_main() and gst_main_quit() enter and exit the main loop. GStreamer doesn't currently require
  75 you to us a mainloop but can intergrate with it without problems.
  76 </para>
  77
  78 <!-- ##### SECTION See_Also ##### -->
  79 <para>
  80 Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's
  81 pipeline</ulink> and Microsoft's DirectShow for some background.
  82 </para>
  83
  84 <!-- ##### FUNCTION gst_init ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @argc:
  90 @argv:
  91
  92
  93 <!-- ##### FUNCTION gst_init_get_popt_table ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @Returns:
  99
 100
 101 <!-- ##### FUNCTION gst_init_with_popt_table ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @argc:
 107 @argv:
 108 @popt_options:
 109 <!-- # Unused Parameters # -->
 110 @Param3:
 111 @Returns:
 112
 113
 114 <!-- ##### FUNCTION gst_init_check ##### -->
 115 <para>
 116
 117 </para>
 118
 119 @argc:
 120 @argv:
 121 @Returns:
 122
 123
 124 <!-- ##### FUNCTION gst_init_check_with_popt_table ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @argc:
 130 @argv:
 131 @popt_options:
 132 @Returns:
 133 <!-- # Unused Parameters # -->
 134 @Param3:
 135
 136
 137 <!-- ##### FUNCTION gst_version ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @major:
 143 @minor:
 144 @micro:
 145
 146
 147 <!-- ##### FUNCTION gst_main ##### -->
 148 <para>
 149
 150 </para>
 151
 152
 153
 154 <!-- ##### FUNCTION gst_main_quit ##### -->
 155 <para>
 156
 157 </para>
 158
 159
 160
 161 <!-- ##### FUNCTION gst_has_threads ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @Returns:
 167
 168
 169 <!-- ##### FUNCTION gst_use_threads ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @use_threads:
 175
 176
 177 <!-- ##### VARIABLE g_log_domain_gstreamer ##### -->
 178 <para>
 179 The variable that holds the GStreamer log domain
 180 </para>
 181
 182
 183 <!-- ##### MACRO GST_VERSION_MAJOR ##### -->
 184 <para>
 185 The major version of GStreamer at compile time
 186 </para>
 187
 188
 189
 190 <!-- ##### MACRO GST_VERSION_MINOR ##### -->
 191 <para>
 192 The minor version of GStreamer at compile time
 193 </para>
 194
 195
 196
 197 <!-- ##### MACRO GST_VERSION_MICRO ##### -->
 198 <para>
 199 The micro version of GStreamer at compile time
 200 </para>
 201
 202
 203