summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOlivier CrĂȘte <olivier.crete@collabora.co.uk>2009-02-10 18:38:11 +0000
committerEdward Hervey <bilboed@bilboed.com>2009-02-17 19:29:06 +0100
commitcf21405a7fa73666b5009d59bb5ab382626edccb (patch)
tree24c5d93ea8b6e42adc313b50abcbe2ad5f87125d
parent6edfec64ee0c6a95374a628ac4ffbb662603ee1b (diff)
downloadgst-plugins-bad-cf21405a7fa73666b5009d59bb5ab382626edccb.tar.gz
gst-plugins-bad-cf21405a7fa73666b5009d59bb5ab382626edccb.tar.bz2
gst-plugins-bad-cf21405a7fa73666b5009d59bb5ab382626edccb.zip
Document the liveadder
-rw-r--r--gst/liveadder/liveadder.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/gst/liveadder/liveadder.c b/gst/liveadder/liveadder.c
index dc1c7531..bb4cf305 100644
--- a/gst/liveadder/liveadder.c
+++ b/gst/liveadder/liveadder.c
@@ -25,6 +25,18 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
+/**
+ * SECTION:element-liveadder
+ * @see_also: adder
+ *
+ * The live adder allows to mix several streams into one by adding the data.
+ * Mixed data is clamped to the min/max values of the data format.
+ *
+ * Unlike the adder, the liveadder mixes the streams according the their
+ * timestamps and waits for some milli-seconds before trying doing the mixing.
+ *
+ * Last reviewed on 2008-02-10 (0.10.11)
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"