| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>fakesink</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
| <link rel="home" href="index.html" title="GStreamer Core Plugins 1.0 Plugins Reference Manual"> |
| <link rel="up" href="ch01.html" title="gstreamer Elements"> |
| <link rel="prev" href="gstreamer-plugins-fakesrc.html" title="fakesrc"> |
| <link rel="next" href="gstreamer-plugins-fdsink.html" title="fdsink"> |
| <meta name="generator" content="GTK-Doc V1.18 (XML mode)"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> |
| <tr valign="middle"> |
| <td><a accesskey="p" href="gstreamer-plugins-fakesrc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> |
| <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> |
| <th width="100%" align="center">GStreamer Core Plugins 1.0 Plugins Reference Manual</th> |
| <td><a accesskey="n" href="gstreamer-plugins-fdsink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> |
| </tr> |
| <tr><td colspan="5" class="shortcuts"> |
| <a href="#gstreamer-plugins-fakesink.synopsis" class="shortcut">Top</a> |
| | |
| <a href="#gstreamer-plugins-fakesink.description" class="shortcut">Description</a> |
| | |
| <a href="#gstreamer-plugins-fakesink.object-hierarchy" class="shortcut">Object Hierarchy</a> |
| | |
| <a href="#gstreamer-plugins-fakesink.properties" class="shortcut">Properties</a> |
| | |
| <a href="#gstreamer-plugins-fakesink.signals" class="shortcut">Signals</a> |
| </td></tr> |
| </table> |
| <div class="refentry"> |
| <a name="gstreamer-plugins-fakesink"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="gstreamer-plugins-fakesink.top_of_page"></a>fakesink</span></h2> |
| <p>fakesink — Black hole for data</p> |
| </td> |
| <td valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsynopsisdiv"> |
| <a name="gstreamer-plugins-fakesink.synopsis"></a><h2>Synopsis</h2> |
| <a name="GstFakeSink"></a><pre class="synopsis">struct <a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink-struct" title="struct GstFakeSink">GstFakeSink</a>; |
| enum <a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSinkStateError" title="enum GstFakeSinkStateError">GstFakeSinkStateError</a>; |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-plugins-fakesink.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="synopsis"> |
| <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> |
| +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> |
| +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a> |
| +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a> |
| +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a> |
| +----GstFakeSink |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-plugins-fakesink.properties"></a><h2>Properties</h2> |
| <pre class="synopsis"> |
| "<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 |
| "<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 |
| "<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 |
| "<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 |
| "<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 |
| "<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 |
| "<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 |
| "<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 |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-plugins-fakesink.signals"></a><h2>Signals</h2> |
| <pre class="synopsis"> |
| "<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> |
| "<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> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-plugins-fakesink.description"></a><h2>Description</h2> |
| <p> |
| Dummy sink that swallows everything. |
| </p> |
| <p> |
| </p> |
| <div class="refsect2"> |
| <a name="idp9180112"></a><h3>Example launch line</h3> |
| <div class="informalexample"> |
| <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> |
| <tbody> |
| <tr> |
| <td class="listing_lines" align="right"><pre>1</pre></td> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| Render 1000 audio buffers (of default size) as fast as possible. |
| </div> |
| <p> |
| </p> |
| <div class="refsynopsisdiv"> |
| <h2>Synopsis</h2> |
| <div class="refsect2"> |
| <a name="idp9509216"></a><h3>Element Information</h3> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">plugin</span></p></td> |
| <td> |
| <a class="link" href="gstreamer-plugins-plugin-coreelements.html#plugin-coreelements">coreelements</a> |
| </td> |
| </tr> |
| <tr> |
| <td><p><span class="term">author</span></p></td> |
| <td>Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>, Mr. 'frag-me-more' Vanderwingo <wingo@fluendo.com></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">class</span></p></td> |
| <td>Sink</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="idp9516752"></a><h3>Element Pads</h3> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">name</span></p></td> |
| <td>sink</td> |
| </tr> |
| <tr> |
| <td><p><span class="term">direction</span></p></td> |
| <td>sink</td> |
| </tr> |
| <tr> |
| <td><p><span class="term">presence</span></p></td> |
| <td>always</td> |
| </tr> |
| <tr> |
| <td><p><span class="term">details</span></p></td> |
| <td>ANY</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| </div> |
| <p> |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-plugins-fakesink.details"></a><h2>Details</h2> |
| <div class="refsect2"> |
| <a name="GstFakeSink-struct"></a><h3>struct GstFakeSink</h3> |
| <pre class="programlisting">struct GstFakeSink;</pre> |
| <p> |
| The opaque <a class="link" href="gstreamer-plugins-fakesink.html#GstFakeSink"><span class="type">GstFakeSink</span></a> data structure. |
| </p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstFakeSinkStateError"></a><h3>enum GstFakeSinkStateError</h3> |
| <pre class="programlisting">typedef enum { |
| FAKE_SINK_STATE_ERROR_NONE = 0, |
| FAKE_SINK_STATE_ERROR_NULL_READY, |
| FAKE_SINK_STATE_ERROR_READY_PAUSED, |
| FAKE_SINK_STATE_ERROR_PAUSED_PLAYING, |
| FAKE_SINK_STATE_ERROR_PLAYING_PAUSED, |
| FAKE_SINK_STATE_ERROR_PAUSED_READY, |
| FAKE_SINK_STATE_ERROR_READY_NULL |
| } GstFakeSinkStateError; |
| </pre> |
| <p> |
| Possible state change errors for the state-error property. |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <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> |
| <td>no error |
| </td> |
| </tr> |
| <tr> |
| <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> |
| <td>cause the NULL to READY state change to fail |
| </td> |
| </tr> |
| <tr> |
| <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> |
| <td>cause the READY to PAUSED state change to fail: |
| </td> |
| </tr> |
| <tr> |
| <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> |
| <td>cause the PAUSED to PLAYING state change to fail: |
| </td> |
| </tr> |
| <tr> |
| <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> |
| <td>cause the PLAYING to PAUSED state change to fail: |
| </td> |
| </tr> |
| <tr> |
| <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> |
| <td>cause the PAUSED to READY state change to fail: |
| </td> |
| </tr> |
| <tr> |
| <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> |
| <td>cause the READY to NULL state change to fail: |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-plugins-fakesink.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GstFakeSink--can-activate-pull"></a><h3>The <code class="literal">"can-activate-pull"</code> property</h3> |
| <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> |
| <p>Can activate in pull mode.</p> |
| <p>Default value: FALSE</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstFakeSink--can-activate-push"></a><h3>The <code class="literal">"can-activate-push"</code> property</h3> |
| <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> |
| <p>Can activate in push mode.</p> |
| <p>Default value: TRUE</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstFakeSink--dump"></a><h3>The <code class="literal">"dump"</code> property</h3> |
| <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> |
| <p>Dump buffer contents to stdout.</p> |
| <p>Default value: FALSE</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstFakeSink--last-message"></a><h3>The <code class="literal">"last-message"</code> property</h3> |
| <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> |
| <p>The message describing current status.</p> |
| <p>Default value: NULL</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstFakeSink--signal-handoffs"></a><h3>The <code class="literal">"signal-handoffs"</code> property</h3> |
| <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> |
| <p>Send a signal before unreffing the buffer.</p> |
| <p>Default value: FALSE</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstFakeSink--silent"></a><h3>The <code class="literal">"silent"</code> property</h3> |
| <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> |
| <p>Don't produce last_message events.</p> |
| <p>Default value: TRUE</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstFakeSink--state-error"></a><h3>The <code class="literal">"state-error"</code> property</h3> |
| <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> |
| <p>Generate a state change error.</p> |
| <p>Default value: No state change errors</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstFakeSink--num-buffers"></a><h3>The <code class="literal">"num-buffers"</code> property</h3> |
| <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> |
| <p>Number of buffers to accept going EOS.</p> |
| <p>Allowed values: >= G_MAXULONG</p> |
| <p>Default value: -1</p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-plugins-fakesink.signal-details"></a><h2>Signal Details</h2> |
| <div class="refsect2"> |
| <a name="GstFakeSink-handoff"></a><h3>The <code class="literal">"handoff"</code> signal</h3> |
| <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, |
| <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer, |
| <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad, |
| <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> |
| <p> |
| This signal gets emitted before unreffing the buffer. |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term"><em class="parameter"><code>fakesink</code></em> :</span></p></td> |
| <td>the fakesink instance</td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> |
| <td>the buffer that just has been received</td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td> |
| <td>the pad that received it</td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> |
| <td>user data set when the signal handler was connected.</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstFakeSink-preroll-handoff"></a><h3>The <code class="literal">"preroll-handoff"</code> signal</h3> |
| <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, |
| <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer, |
| <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad, |
| <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> |
| <p> |
| This signal gets emitted before unreffing the buffer. |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term"><em class="parameter"><code>fakesink</code></em> :</span></p></td> |
| <td>the fakesink instance</td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> |
| <td>the buffer that just has been received</td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td> |
| <td>the pad that received it</td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> |
| <td>user data set when the signal handler was connected.</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-plugins-fakesink.see-also"></a><h2>See Also</h2> |
| <a class="link" href="gstreamer-plugins-fakesrc.html#GstFakeSrc"><span class="type">GstFakeSrc</span></a> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr> |
| Generated by GTK-Doc V1.18</div> |
| </body> |
| </html> |
