aggregator: improve section docs
authorStefan Sauer <ensonic@users.sf.net>
Sun, 15 Oct 2017 08:44:44 +0000 (10:44 +0200)
committerStefan Sauer <ensonic@users.sf.net>
Sun, 15 Oct 2017 08:51:24 +0000 (10:51 +0200)
Mention how data ends up in the queues. Document the relation of the pad
functions and the class vmethods to get events and queries.

gst-libs/gst/base/gstaggregator.c

index afeb9ba2b432c3b25729a58e4e93bf93dced2a7e..864654effe6c0bd8876e0dc6babd7a59817cc9dd 100644 (file)
  *  * Base class for mixers and muxers. Subclasses should at least implement
  *    the #GstAggregatorClass.aggregate() virtual method.
  *
+ *  * Installs a #GstPadChainFunction, a #GstPadEventFullFunction and a
+ *    #GstPadQueryFunction to queue all serialized data packets per sink pad.
+ *    Subclasses should not overwrite those, but instead implement
+ *    #GstAggregatorClass.sink_event() and #GstAggregatorClass.sink_query() as
+ *    needed.
+ *
  *  * When data is queued on all pads, the aggregate vmethod is called.
  *
  *  * One can peek at the data on any given GstAggregatorPad with the