mobile/docs/plugins/html/gstreamer-plugins-fakesink.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>fakesink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Core Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gstreamer Elements">
   9 <link rel="prev" href="gstreamer-plugins-fakesrc.html" title="fakesrc">
  10 <link rel="next" href="gstreamer-plugins-fdsink.html" title="fdsink">
  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="gstreamer-plugins-fakesrc.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 Core Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gstreamer-plugins-fdsink.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="#gstreamer-plugins-fakesink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gstreamer-plugins-fakesink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gstreamer-plugins-fakesink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gstreamer-plugins-fakesink.properties" class="shortcut">Properties</a>
  31                    |
  32                   <a href="#gstreamer-plugins-fakesink.signals" class="shortcut">Signals</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gstreamer-plugins-fakesink"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gstreamer-plugins-fakesink.top_of_page"></a>fakesink</span></h2>
  40 <p>fakesink — Black hole for data</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gstreamer-plugins-fakesink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstFakeSink"></a><pre class="synopsis">struct              <a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink-struct" title="struct GstFakeSink">GstFakeSink</a>;
  47 enum                <a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSinkStateError" title="enum GstFakeSinkStateError">GstFakeSinkStateError</a>;
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="gstreamer-plugins-fakesink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  52 <pre class="synopsis">
  53   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  54    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  55          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  56                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
  57                      +----GstFakeSink
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="gstreamer-plugins-fakesink.properties"></a><h2>Properties</h2>
  62 <pre class="synopsis">
  63   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink--can-activate-pull" title='The "can-activate-pull" property'>can-activate-pull</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  64   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink--can-activate-push" title='The "can-activate-push" property'>can-activate-push</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  65   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink--dump" title='The "dump" property'>dump</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  66   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink--last-message" title='The "last-message" property'>last-message</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  67   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink--signal-handoffs" title='The "signal-handoffs" property'>signal-handoffs</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  68   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink--silent" title='The "silent" property'>silent</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  69   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink--state-error" title='The "state-error" property'>state-error</a>"              <a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSinkStateError" title="enum GstFakeSinkStateError"><span class="type">GstFakeSinkStateError</span></a>  : Read / Write
  70   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink--num-buffers" title='The "num-buffers" property'>num-buffers</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  71 </pre>
  72 </div>
  73 <div class="refsect1">
  74 <a name="gstreamer-plugins-fakesink.signals"></a><h2>Signals</h2>
  75 <pre class="synopsis">
  76   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink-handoff" title='The "handoff" signal'>handoff</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>
  77   "<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink-preroll-handoff" title='The "preroll-handoff" signal'>preroll-handoff</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 </pre>
  79 </div>
  80 <div class="refsect1">
  81 <a name="gstreamer-plugins-fakesink.description"></a><h2>Description</h2>
  82 <p>
  83 Dummy sink that swallows everything.
  84 </p>
  85 <p>
  86 </p>
  87 <div class="refsect2">
  88 <a name="idp9602416"></a><h3>Example launch line</h3>
  89 <div class="informalexample">
  90   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  91     <tbody>
  92       <tr>
  93         <td class="listing_lines" align="right"><pre>1</pre></td>
  94         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch audiotestsrc num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">1000</span> <span class="gtkdoc opt">!</span> fakesink sync<span class="gtkdoc opt">=</span><span class="keyword">false</span></pre></td>
  95       </tr>
  96     </tbody>
  97   </table>
  98 </div>
  99  Render 1000 audio buffers (of default size) as fast as possible.
 100 </div>
 101 <p>
 102 </p>
 103 <div class="refsynopsisdiv">
 104 <h2>Synopsis</h2>
 105 <div class="refsect2">
 106 <a name="idp9605024"></a><h3>Element Information</h3>
 107 <div class="variablelist"><table border="0">
 108 <col align="left" valign="top">
 109 <tbody>
 110 <tr>
 111 <td><p><span class="term">plugin</span></p></td>
 112 <td>
 113             <a class="link" href="gstreamer-plugins-plugin-coreelements.html#plugin-coreelements">coreelements</a>
 114           </td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term">author</span></p></td>
 118 <td>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;, Wim Taymans &lt;wim@fluendo.com&gt;, Mr. 'frag-me-more' Vanderwingo &lt;wingo@fluendo.com&gt;</td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term">class</span></p></td>
 122 <td>Sink</td>
 123 </tr>
 124 </tbody>
 125 </table></div>
 126 </div>
 127 <hr>
 128 <div class="refsect2">
 129 <a name="idp9612560"></a><h3>Element Pads</h3>
 130 <div class="variablelist"><table border="0">
 131 <col align="left" valign="top">
 132 <tbody>
 133 <tr>
 134 <td><p><span class="term">name</span></p></td>
 135 <td>sink</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term">direction</span></p></td>
 139 <td>sink</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term">presence</span></p></td>
 143 <td>always</td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term">details</span></p></td>
 147 <td>ANY</td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 </div>
 152 </div>
 153 <p>
 154 </p>
 155 </div>
 156 <div class="refsect1">
 157 <a name="gstreamer-plugins-fakesink.details"></a><h2>Details</h2>
 158 <div class="refsect2">
 159 <a name="GstFakeSink-struct"></a><h3>struct GstFakeSink</h3>
 160 <pre class="programlisting">struct GstFakeSink;</pre>
 161 <p>
 162 The opaque <a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink"><span class="type">GstFakeSink</span></a> data structure.
 163 </p>
 164 </div>
 165 <hr>
 166 <div class="refsect2">
 167 <a name="GstFakeSinkStateError"></a><h3>enum GstFakeSinkStateError</h3>
 168 <pre class="programlisting">typedef enum {
 169   FAKE_SINK_STATE_ERROR_NONE = 0,
 170   FAKE_SINK_STATE_ERROR_NULL_READY,
 171   FAKE_SINK_STATE_ERROR_READY_PAUSED,
 172   FAKE_SINK_STATE_ERROR_PAUSED_PLAYING,
 173   FAKE_SINK_STATE_ERROR_PLAYING_PAUSED,
 174   FAKE_SINK_STATE_ERROR_PAUSED_READY,
 175   FAKE_SINK_STATE_ERROR_READY_NULL
 176 } GstFakeSinkStateError;
 177 </pre>
 178 <p>
 179 Possible state change errors for the state-error property.
 180 </p>
 181 <div class="variablelist"><table border="0">
 182 <col align="left" valign="top">
 183 <tbody>
 184 <tr>
 185 <td><p><a name="FAKE-SINK-STATE-ERROR-NONE:CAPS"></a><span class="term"><code class="literal">FAKE_SINK_STATE_ERROR_NONE</code></span></p></td>
 186 <td>no error
 187 </td>
 188 </tr>
 189 <tr>
 190 <td><p><a name="FAKE-SINK-STATE-ERROR-NULL-READY:CAPS"></a><span class="term"><code class="literal">FAKE_SINK_STATE_ERROR_NULL_READY</code></span></p></td>
 191 <td>cause the NULL to READY state change to fail
 192 </td>
 193 </tr>
 194 <tr>
 195 <td><p><a name="FAKE-SINK-STATE-ERROR-READY-PAUSED:CAPS"></a><span class="term"><code class="literal">FAKE_SINK_STATE_ERROR_READY_PAUSED</code></span></p></td>
 196 <td>cause the READY to PAUSED state change to fail:
 197 </td>
 198 </tr>
 199 <tr>
 200 <td><p><a name="FAKE-SINK-STATE-ERROR-PAUSED-PLAYING:CAPS"></a><span class="term"><code class="literal">FAKE_SINK_STATE_ERROR_PAUSED_PLAYING</code></span></p></td>
 201 <td>cause the PAUSED to PLAYING state change to fail:
 202 </td>
 203 </tr>
 204 <tr>
 205 <td><p><a name="FAKE-SINK-STATE-ERROR-PLAYING-PAUSED:CAPS"></a><span class="term"><code class="literal">FAKE_SINK_STATE_ERROR_PLAYING_PAUSED</code></span></p></td>
 206 <td>cause the PLAYING to PAUSED state change to fail:
 207 </td>
 208 </tr>
 209 <tr>
 210 <td><p><a name="FAKE-SINK-STATE-ERROR-PAUSED-READY:CAPS"></a><span class="term"><code class="literal">FAKE_SINK_STATE_ERROR_PAUSED_READY</code></span></p></td>
 211 <td>cause the PAUSED to READY state change to fail:
 212 </td>
 213 </tr>
 214 <tr>
 215 <td><p><a name="FAKE-SINK-STATE-ERROR-READY-NULL:CAPS"></a><span class="term"><code class="literal">FAKE_SINK_STATE_ERROR_READY_NULL</code></span></p></td>
 216 <td>cause the READY to NULL state change to fail:
 217 </td>
 218 </tr>
 219 </tbody>
 220 </table></div>
 221 </div>
 222 </div>
 223 <div class="refsect1">
 224 <a name="gstreamer-plugins-fakesink.property-details"></a><h2>Property Details</h2>
 225 <div class="refsect2">
 226 <a name="GstFakeSink--can-activate-pull"></a><h3>The <code class="literal">"can-activate-pull"</code> property</h3>
 227 <pre class="programlisting">  "can-activate-pull"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 228 <p>Can activate in pull mode.</p>
 229 <p>Default value: FALSE</p>
 230 </div>
 231 <hr>
 232 <div class="refsect2">
 233 <a name="GstFakeSink--can-activate-push"></a><h3>The <code class="literal">"can-activate-push"</code> property</h3>
 234 <pre class="programlisting">  "can-activate-push"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 235 <p>Can activate in push mode.</p>
 236 <p>Default value: TRUE</p>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="GstFakeSink--dump"></a><h3>The <code class="literal">"dump"</code> property</h3>
 241 <pre class="programlisting">  "dump"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 242 <p>Dump buffer contents to stdout.</p>
 243 <p>Default value: FALSE</p>
 244 </div>
 245 <hr>
 246 <div class="refsect2">
 247 <a name="GstFakeSink--last-message"></a><h3>The <code class="literal">"last-message"</code> property</h3>
 248 <pre class="programlisting">  "last-message"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 249 <p>The message describing current status.</p>
 250 <p>Default value: NULL</p>
 251 </div>
 252 <hr>
 253 <div class="refsect2">
 254 <a name="GstFakeSink--signal-handoffs"></a><h3>The <code class="literal">"signal-handoffs"</code> property</h3>
 255 <pre class="programlisting">  "signal-handoffs"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 256 <p>Send a signal before unreffing the buffer.</p>
 257 <p>Default value: FALSE</p>
 258 </div>
 259 <hr>
 260 <div class="refsect2">
 261 <a name="GstFakeSink--silent"></a><h3>The <code class="literal">"silent"</code> property</h3>
 262 <pre class="programlisting">  "silent"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 263 <p>Don't produce last_message events.</p>
 264 <p>Default value: FALSE</p>
 265 </div>
 266 <hr>
 267 <div class="refsect2">
 268 <a name="GstFakeSink--state-error"></a><h3>The <code class="literal">"state-error"</code> property</h3>
 269 <pre class="programlisting">  "state-error"              <a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSinkStateError" title="enum GstFakeSinkStateError"><span class="type">GstFakeSinkStateError</span></a>  : Read / Write</pre>
 270 <p>Generate a state change error.</p>
 271 <p>Default value: No state change errors</p>
 272 </div>
 273 <hr>
 274 <div class="refsect2">
 275 <a name="GstFakeSink--num-buffers"></a><h3>The <code class="literal">"num-buffers"</code> property</h3>
 276 <pre class="programlisting">  "num-buffers"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 277 <p>Number of buffers to accept going EOS.</p>
 278 <p>Allowed values: &gt;= G_MAXULONG</p>
 279 <p>Default value: -1</p>
 280 </div>
 281 </div>
 282 <div class="refsect1">
 283 <a name="gstreamer-plugins-fakesink.signal-details"></a><h2>Signal Details</h2>
 284 <div class="refsect2">
 285 <a name="GstFakeSink-handoff"></a><h3>The <code class="literal">"handoff"</code> signal</h3>
 286 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink"><span class="type">GstFakeSink</span></a> *fakesink,
 287                                                         <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>   *buffer,
 288                                                         <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a>      *pad,
 289                                                         <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>
 290 <p>
 291 This signal gets emitted before unreffing the buffer.
 292 </p>
 293 <div class="variablelist"><table border="0">
 294 <col align="left" valign="top">
 295 <tbody>
 296 <tr>
 297 <td><p><span class="term"><em class="parameter"><code>fakesink</code></em> :</span></p></td>
 298 <td>the fakesink instance</td>
 299 </tr>
 300 <tr>
 301 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 302 <td>the buffer that just has been received</td>
 303 </tr>
 304 <tr>
 305 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 306 <td>the pad that received it</td>
 307 </tr>
 308 <tr>
 309 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 310 <td>user data set when the signal handler was connected.</td>
 311 </tr>
 312 </tbody>
 313 </table></div>
 314 </div>
 315 <hr>
 316 <div class="refsect2">
 317 <a name="GstFakeSink-preroll-handoff"></a><h3>The <code class="literal">"preroll-handoff"</code> signal</h3>
 318 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink"><span class="type">GstFakeSink</span></a> *fakesink,
 319                                                         <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>   *buffer,
 320                                                         <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a>      *pad,
 321                                                         <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>
 322 <p>
 323 This signal gets emitted before unreffing the buffer.
 324 </p>
 325 <div class="variablelist"><table border="0">
 326 <col align="left" valign="top">
 327 <tbody>
 328 <tr>
 329 <td><p><span class="term"><em class="parameter"><code>fakesink</code></em> :</span></p></td>
 330 <td>the fakesink instance</td>
 331 </tr>
 332 <tr>
 333 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 334 <td>the buffer that just has been received</td>
 335 </tr>
 336 <tr>
 337 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 338 <td>the pad that received it</td>
 339 </tr>
 340 <tr>
 341 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 342 <td>user data set when the signal handler was connected.</td>
 343 </tr>
 344 </tbody>
 345 </table></div>
 346 <p class="since">Since 0.10.7</p>
 347 </div>
 348 </div>
 349 <div class="refsect1">
 350 <a name="gstreamer-plugins-fakesink.see-also"></a><h2>See Also</h2>
 351 <a class="link" href="gstreamer-plugins-fakesrc.html#GstFakeSrc"><span class="type">GstFakeSrc</span></a>
 352 </div>
 353 </div>
 354 <div class="footer">
 355 <hr>
 356           Generated by GTK-Doc V1.18</div>
 357 </body>
 358 </html>