From cf21405a7fa73666b5009d59bb5ab382626edccb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Olivier=20Cr=C3=AAte?= Date: Tue, 10 Feb 2009 18:38:11 +0000 Subject: [PATCH] Document the liveadder --- gst/liveadder/liveadder.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/gst/liveadder/liveadder.c b/gst/liveadder/liveadder.c index dc1c753180..bb4cf3050f 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"