<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>valve</title> <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> <link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual"> <link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> <link rel="prev" href="gst-plugins-bad-plugins-trm.html" title="trm"> <link rel="next" href="gst-plugins-bad-plugins-videoanalyse.html" title="videoanalyse"> <meta name="generator" content="GTK-Doc V1.11 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> <link rel="chapter" href="ch01.html" title="gst-plugins-bad Elements"> <link rel="chapter" href="ch02.html" title="gst-plugins-bad Plugins"> <link rel="chapter" href="ch03.html" title="gst-plugins-bad Classes"> </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="gst-plugins-bad-plugins-trm.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 Bad Plugins 0.10 Plugins Reference Manual</th> <td><a accesskey="n" href="gst-plugins-bad-plugins-videoanalyse.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#gst-plugins-bad-plugins-valve.synopsis" class="shortcut">Top</a> | <a href="#gst-plugins-bad-plugins-valve.description" class="shortcut">Description</a> | <a href="#gst-plugins-bad-plugins-valve.object-hierarchy" class="shortcut">Object Hierarchy</a> | <a href="#gst-plugins-bad-plugins-valve.properties" class="shortcut">Properties</a> </td></tr> </table> <div class="refentry" title="valve"> <a name="gst-plugins-bad-plugins-valve"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-valve.top_of_page"></a>valve</span></h2> <p>valve — This element drops all packets when drop is TRUE</p> </td> <td valign="top" align="right"></td> </tr></table></div> <div class="refsynopsisdiv" title="Synopsis"> <a name="gst-plugins-bad-plugins-valve.synopsis"></a><h2>Synopsis</h2> <a name="GstValve"></a><pre class="synopsis"> <a class="link" href="gst-plugins-bad-plugins-valve.html#GstValve-struct" title="GstValve">GstValve</a>; </pre> </div> <div class="refsect1" title="Object Hierarchy"> <a name="gst-plugins-bad-plugins-valve.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="synopsis"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject" >GObject</a> +----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html" >GstObject</a> +----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html" >GstElement</a> +----GstValve </pre> </div> <div class="refsect1" title="Properties"> <a name="gst-plugins-bad-plugins-valve.properties"></a><h2>Properties</h2> <pre class="synopsis"> "<a class="link" href="gst-plugins-bad-plugins-valve.html#GstValve--drop" title='The "drop" property'>drop</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean" >gboolean</a> : Read / Write </pre> </div> <div class="refsect1" title="Description"> <a name="gst-plugins-bad-plugins-valve.description"></a><h2>Description</h2> <p> The valve is a simple element that drops buffers when the <span class="type">"drop"</span> property is set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS" ><code class="literal">TRUE</code></a> and lets then through otherwise. </p> <p> Any downstream error received while the <span class="type">"drop"</span> property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS" ><code class="literal">FALSE</code></a> is ignored. So downstream element can be set to <code class="literal">GST_STATE_NULL</code> and removed, without using pad blocking. </p> <p> Last reviewed on 2008-02-10 (0.10.11)</p> <div class="refsynopsisdiv" title="Synopsis"> <h2>Synopsis</h2> <div class="refsect2" title="Element Information"> <a name="id521767"></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="gst-plugins-bad-plugins-plugin-valve.html#plugin-valve">valve</a> </td> </tr> <tr> <td><p><span class="term">author</span></p></td> <td>Olivier Crete <olivier.crete@collabora.co.uk></td> </tr> <tr> <td><p><span class="term">class</span></p></td> <td>Filter</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" title="Element Pads"> <a name="id521829"></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 class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term">name</span></p></td> <td>src</td> </tr> <tr> <td><p><span class="term">direction</span></p></td> <td>source</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" title="Details"> <a name="gst-plugins-bad-plugins-valve.details"></a><h2>Details</h2> <div class="refsect2" title="GstValve"> <a name="GstValve-struct"></a><h3>GstValve</h3> <pre class="programlisting">typedef struct _GstValve GstValve;</pre> <p> The private valve structure</p> <p> </p> </div> </div> <div class="refsect1" title="Property Details"> <a name="gst-plugins-bad-plugins-valve.property-details"></a><h2>Property Details</h2> <div class="refsect2" title='The "drop" property'> <a name="GstValve--drop"></a><h3>The <code class="literal">"drop"</code> property</h3> <pre class="programlisting"> "drop" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean" >gboolean</a> : Read / Write</pre> <p>If this property if TRUE, the element will drop all buffers, if its FALSE, it will let them through.</p> <p>Default value: FALSE</p> </div> </div> </div> <div class="footer"> <hr> Generated by GTK-Doc V1.11</div> </body> </html>