Document the GstValve

This commit is contained in:
Olivier Crête 2009-02-10 18:52:54 +00:00 committed by Edward Hervey
parent 15c74af4d0
commit a4ed8c5d96
2 changed files with 18 additions and 0 deletions

View file

@ -21,6 +21,18 @@
* Boston, MA 02111-1307, USA.
*
*/
/**
* SECTION:element-valve
*
* The valve is a simple element that drops buffers when the #GstValve::drop
* property is set to %TRUE and lets then through otherwise.
*
* Any downstream error received while the #GstValve::drop property is %FALSE
* is ignored. So downstream element can be set to %GST_STATE_NULL and removed,
* without using pad blocking.
*
* Last reviewed on 2008-02-10 (0.10.11)
*/
#ifdef HAVE_CONFIG_H
#include "config.h"

View file

@ -45,8 +45,14 @@ typedef struct _GstValve GstValve;
typedef struct _GstValveClass GstValveClass;
typedef struct _GstValvePrivate GstValvePrivate;
/**
* GstValve:
*
* The private valve structure
*/
struct _GstValve
{
/*< private >*/
GstElement parent;
/* Protected by the object lock */