mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-07 15:02:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Port all docstring to gtk-doc markdown

Browse source
This commit is contained in:
Thibault Saunier 2017-03-08 15:01:13 -03:00 committed by Tim-Philipp Müller
parent 47460d6326
commit 6e24e42d9a
1 changed files with 14 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
libs/gst/base/gstaggregator.c
View file

@ -21,46 +21,40 @@
*/ */
/** /**
* SECTION: gstaggregator * SECTION: gstaggregator
* @title: GstAggregator
* @short_description: manages a set of pads with the purpose of * @short_description: manages a set of pads with the purpose of
* aggregating their buffers. * aggregating their buffers.
* @see_also: gstcollectpads for historical reasons. * @see_also: gstcollectpads for historical reasons.
* *
* Manages a set of pads with the purpose of aggregating their buffers. * Manages a set of pads with the purpose of aggregating their buffers.
* Control is given to the subclass when all pads have data. * Control is given to the subclass when all pads have data.
* <itemizedlist> *
* <listitem><para> * * Base class for mixers and muxers. Subclasses should at least implement
* Base class for mixers and muxers. Subclasses should at least implement
* the #GstAggregatorClass.aggregate() virtual method. * the #GstAggregatorClass.aggregate() virtual method.
* </para></listitem> *
* <listitem><para> * * When data is queued on all pads, tha aggregate vmethod is called.
* When data is queued on all pads, tha aggregate vmethod is called. *
* </para></listitem> * * One can peek at the data on any given GstAggregatorPad with the
* <listitem><para>
* One can peek at the data on any given GstAggregatorPad with the
* gst_aggregator_pad_get_buffer () method, and take ownership of it * gst_aggregator_pad_get_buffer () method, and take ownership of it
* with the gst_aggregator_pad_steal_buffer () method. When a buffer * with the gst_aggregator_pad_steal_buffer () method. When a buffer
* has been taken with steal_buffer (), a new buffer can be queued * has been taken with steal_buffer (), a new buffer can be queued
* on that pad. * on that pad.
* </para></listitem> *
* <listitem><para> * * If the subclass wishes to push a buffer downstream in its aggregate
* If the subclass wishes to push a buffer downstream in its aggregate
* implementation, it should do so through the * implementation, it should do so through the
* gst_aggregator_finish_buffer () method. This method will take care * gst_aggregator_finish_buffer () method. This method will take care
* of sending and ordering mandatory events such as stream start, caps * of sending and ordering mandatory events such as stream start, caps
* and segment. * and segment.
* </para></listitem> *
* <listitem><para> * * Same goes for EOS events, which should not be pushed directly by the
* Same goes for EOS events, which should not be pushed directly by the
* subclass, it should instead return GST_FLOW_EOS in its aggregate * subclass, it should instead return GST_FLOW_EOS in its aggregate
* implementation. * implementation.
* </para></listitem> *
* <listitem><para> * * Note that the aggregator logic regarding gap event handling is to turn
* Note that the aggregator logic regarding gap event handling is to turn
* these into gap buffers with matching PTS and duration. It will also * these into gap buffers with matching PTS and duration. It will also
* flag these buffers with GST_BUFFER_FLAG_GAP and GST_BUFFER_FLAG_DROPPABLE * flag these buffers with GST_BUFFER_FLAG_GAP and GST_BUFFER_FLAG_DROPPABLE
* to ease their identification and subsequent processing. * to ease their identification and subsequent processing.
* </para></listitem> *
* </itemizedlist>
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H