funnel: fix documentation
authorMathieu Duponchelle <mathieu@centricular.com>
Tue, 6 Aug 2019 13:28:58 +0000 (15:28 +0200)
committerMathieu Duponchelle <mduponchelle1@gmail.com>
Tue, 6 Aug 2019 13:30:12 +0000 (13:30 +0000)
funnel no longer sends its own segment since:

bbb26f875692a6cd84050c545ba85a7d2129cf5d

Update the documentation to reflect that

plugins/elements/gstfunnel.c

index af52f38..8827f49 100644 (file)
  *
  * 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.
- *
+ * #GstFunnel will forward sticky events from its first active sink pad
+ * and, if #GstFunnel:forward-sticky-events is set to true, it will
+ * forward sticky events each time a pad becomes active.
  */
 
 #ifdef HAVE_CONFIG_H