From: Sebastian Dröge <sebastian.droege@collabora.co.uk>
Date: Tue, 29 Mar 2011 09:18:36 +0000 (+0200)
Subject: funnel: Add some more documentation about the behaviour of funnel
X-Git-Tag: RELEASE-0.10.33~266
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b6caaf4eadc7c011ddf7720885a65b8731c7576d;p=platform%2Fupstream%2Fgstreamer.git

funnel: Add some more documentation about the behaviour of funnel
---

diff --git a/plugins/elements/gstfunnel.c b/plugins/elements/gstfunnel.c
index df9f842..36ab532 100644
--- a/plugins/elements/gstfunnel.c
+++ b/plugins/elements/gstfunnel.c
@@ -26,7 +26,15 @@
  * SECTION:element-funnel
  * @short_description: N-to-1 simple funnel
  *
- * Takes packets from various input sinks into one output source
+ * Takes packets from various input sinks into one output source.
+ *
+ * funnel always outputs a single, open ended segment from
+ * 0 with in %GST_FORMAT_TIME and outputs the buffers of the
+ * different sinkpads with timestamps that are set to the
+ * running time for that stream. funnel does not synchronize
+ * the different input streams but simply forwards all buffers
+ * immediately when they arrive.
+ *
  */
 
 #ifdef HAVE_CONFIG_H