docs/plugins/html/gst-plugins-base-plugins-decodebin.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>decodebin</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-clockoverlay.html" title="clockoverlay">
  10 <link rel="next" href="gst-plugins-base-plugins-decodebin2.html" title="decodebin2">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-base-plugins-clockoverlay.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-decodebin2.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-plugins-decodebin.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-decodebin.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-decodebin.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-decodebin.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-decodebin.properties" class="shortcut">Properties</a>
  33                    |
  34                   <a href="#gst-plugins-base-plugins-decodebin.signals" class="shortcut">Signals</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="gst-plugins-base-plugins-decodebin"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  41 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-decodebin.top_of_page"></a>decodebin</span></h2>
  42 <p>decodebin — Autoplug and decode to raw media</p>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  46 <div class="refsynopsisdiv">
  47 <a name="gst-plugins-base-plugins-decodebin.synopsis"></a><h2>Synopsis</h2>
  48 <a name="GstDecodeBin"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin-struct" title="struct GstDecodeBin">GstDecodeBin</a>;
  49 </pre>
  50 </div>
  51 <div class="refsect1">
  52 <a name="gst-plugins-base-plugins-decodebin.object-hierarchy"></a><h2>Object Hierarchy</h2>
  53 <pre class="synopsis">
  54   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  55    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  56          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  57                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstBin.html">GstBin</a>
  58                      +----GstDecodeBin
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-base-plugins-decodebin.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  63 <p>
  64 GstDecodeBin implements
  65  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstChildProxy.html">GstChildProxy</a>.</p>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gst-plugins-base-plugins-decodebin.properties"></a><h2>Properties</h2>
  69 <pre class="synopsis">
  70   "<a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin--threaded" title='The "threaded" property'>threaded</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  71   "<a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin--sink-caps" title='The "sink-caps" property'>sink-caps</a>"                <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write
  72 </pre>
  73 </div>
  74 <div class="refsect1">
  75 <a name="gst-plugins-base-plugins-decodebin.signals"></a><h2>Signals</h2>
  76 <pre class="synopsis">
  77   "<a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin-new-decoded-pad" title='The "new-decoded-pad" signal'>new-decoded-pad</a>"                                : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  78   "<a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin-removed-decoded-pad" title='The "removed-decoded-pad" signal'>removed-decoded-pad</a>"                            : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  79   "<a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin-unknown-type" title='The "unknown-type" signal'>unknown-type</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  80 </pre>
  81 </div>
  82 <div class="refsect1">
  83 <a name="gst-plugins-base-plugins-decodebin.description"></a><h2>Description</h2>
  84 <p>
  85 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstBin.html"><span class="type">GstBin</span></a> that auto-magically constructs a decoding pipeline using available
  86 decoders and demuxers via auto-plugging.
  87 </p>
  88 <p>
  89 When using decodebin in your application, connect a signal handler to
  90 <a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin-new-decoded-pad" title='The "new-decoded-pad" signal'><span class="type">"new-decoded-pad"</span></a> and connect your sinks from within the
  91 callback function.
  92 </p>
  93 <p>
  94 </p>
  95 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  96 <h3 class="title">Note</h3>
  97 This element is deprecated and no longer supported. You should use the
  98 <span class="type">uridecodebin</span> or <span class="type">decodebin2</span> element instead (or, even better: <span class="type">playbin2</span>).
  99 </div>
 100 <p>
 101 </p>
 102 <div class="refsynopsisdiv">
 103 <h2>Synopsis</h2>
 104 <div class="refsect2">
 105 <a name="idp10626496"></a><h3>Element Information</h3>
 106 <div class="variablelist"><table border="0">
 107 <col align="left" valign="top">
 108 <tbody>
 109 <tr>
 110 <td><p><span class="term">plugin</span></p></td>
 111 <td>
 112             <a class="link" href="gst-plugins-base-plugins-plugin-decodebin.html#plugin-decodebin">decodebin</a>
 113           </td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term">author</span></p></td>
 117 <td>Wim Taymans &lt;wim.taymans@gmail.com&gt;</td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term">class</span></p></td>
 121 <td>Generic/Bin/Decoder</td>
 122 </tr>
 123 </tbody>
 124 </table></div>
 125 </div>
 126 <hr>
 127 <div class="refsect2">
 128 <a name="idp10633952"></a><h3>Element Pads</h3>
 129 <div class="variablelist"><table border="0">
 130 <col align="left" valign="top">
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term">name</span></p></td>
 134 <td>sink</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term">direction</span></p></td>
 138 <td>sink</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term">presence</span></p></td>
 142 <td>always</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term">details</span></p></td>
 146 <td>ANY</td>
 147 </tr>
 148 </tbody>
 149 </table></div>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term">name</span></p></td>
 155 <td>src%d</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term">direction</span></p></td>
 159 <td>source</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term">presence</span></p></td>
 163 <td>sometimes</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term">details</span></p></td>
 167 <td>ANY</td>
 168 </tr>
 169 </tbody>
 170 </table></div>
 171 </div>
 172 </div>
 173 <p>
 174 </p>
 175 </div>
 176 <div class="refsect1">
 177 <a name="gst-plugins-base-plugins-decodebin.details"></a><h2>Details</h2>
 178 <div class="refsect2">
 179 <a name="GstDecodeBin-struct"></a><h3>struct GstDecodeBin</h3>
 180 <pre class="programlisting">struct GstDecodeBin;</pre>
 181 <p>
 182 Auto-plugging decoder element structure
 183 </p>
 184 </div>
 185 </div>
 186 <div class="refsect1">
 187 <a name="gst-plugins-base-plugins-decodebin.property-details"></a><h2>Property Details</h2>
 188 <div class="refsect2">
 189 <a name="GstDecodeBin--threaded"></a><h3>The <code class="literal">"threaded"</code> property</h3>
 190 <pre class="programlisting">  "threaded"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 191 <p>Use threads.</p>
 192 <p>Default value: FALSE</p>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="GstDecodeBin--sink-caps"></a><h3>The <code class="literal">"sink-caps"</code> property</h3>
 197 <pre class="programlisting">  "sink-caps"                <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write</pre>
 198 <p>The caps of the input data. (NULL = use typefind element).</p>
 199 </div>
 200 </div>
 201 <div class="refsect1">
 202 <a name="gst-plugins-base-plugins-decodebin.signal-details"></a><h2>Signal Details</h2>
 203 <div class="refsect2">
 204 <a name="GstDecodeBin-new-decoded-pad"></a><h3>The <code class="literal">"new-decoded-pad"</code> signal</h3>
 205 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin"><span class="type">GstDecodeBin</span></a> *bin,
 206                                                         <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a>       *pad,
 207                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>      islast,
 208                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 209 <p>
 210 This signal gets emitted as soon as a new pad of the same type as one of
 211 the valid 'raw' types is added.
 212 </p>
 213 <div class="variablelist"><table border="0">
 214 <col align="left" valign="top">
 215 <tbody>
 216 <tr>
 217 <td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
 218 <td>The decodebin</td>
 219 </tr>
 220 <tr>
 221 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 222 <td>The newly created pad</td>
 223 </tr>
 224 <tr>
 225 <td><p><span class="term"><em class="parameter"><code>islast</code></em> :</span></p></td>
 226 <td>
 227 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if this is the last pad to be added. Deprecated.</td>
 228 </tr>
 229 <tr>
 230 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 231 <td>user data set when the signal handler was connected.</td>
 232 </tr>
 233 </tbody>
 234 </table></div>
 235 </div>
 236 <hr>
 237 <div class="refsect2">
 238 <a name="GstDecodeBin-removed-decoded-pad"></a><h3>The <code class="literal">"removed-decoded-pad"</code> signal</h3>
 239 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin"><span class="type">GstDecodeBin</span></a> *bin,
 240                                                         <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a>       *pad,
 241                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 242 <p>
 243 This signal is emitted when a 'final' caps pad has been removed.
 244 </p>
 245 <div class="variablelist"><table border="0">
 246 <col align="left" valign="top">
 247 <tbody>
 248 <tr>
 249 <td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
 250 <td>The decodebin</td>
 251 </tr>
 252 <tr>
 253 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 254 <td>The pad that was removed</td>
 255 </tr>
 256 <tr>
 257 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 258 <td>user data set when the signal handler was connected.</td>
 259 </tr>
 260 </tbody>
 261 </table></div>
 262 </div>
 263 <hr>
 264 <div class="refsect2">
 265 <a name="GstDecodeBin-unknown-type"></a><h3>The <code class="literal">"unknown-type"</code> signal</h3>
 266 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-plugins-decodebin.html#GstDecodeBin"><span class="type">GstDecodeBin</span></a> *bin,
 267                                                         <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a>       *pad,
 268                                                         <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>      *caps,
 269                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 270 <p>
 271 This signal is emitted when a pad for which there is no further possible
 272 decoding is added to the decodebin.
 273 </p>
 274 <div class="variablelist"><table border="0">
 275 <col align="left" valign="top">
 276 <tbody>
 277 <tr>
 278 <td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
 279 <td>The decodebin</td>
 280 </tr>
 281 <tr>
 282 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 283 <td>The new pad containing caps that cannot be resolved to a 'final'
 284 stream type.</td>
 285 </tr>
 286 <tr>
 287 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
 288 <td>The <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> of the pad that cannot be resolved.</td>
 289 </tr>
 290 <tr>
 291 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 292 <td>user data set when the signal handler was connected.</td>
 293 </tr>
 294 </tbody>
 295 </table></div>
 296 </div>
 297 </div>
 298 </div>
 299 <div class="footer">
 300 <hr>
 301           Generated by GTK-Doc V1.18</div>
 302 </body>
 303 </html>