docs: add StreamidDemux to documentation

https://bugzilla.gnome.org/show_bug.cgi?id=749873
This commit is contained in:
Justin Joy 2015-07-09 00:12:51 +09:00 committed by Tim-Philipp Müller
parent af62e2874f
commit 6c93236462
2 changed files with 18 additions and 3 deletions

View file

@ -23,10 +23,20 @@
*/
/**
* SECTION:element-streamid-demux
* @see_also: #GstFunnel
* SECTION:element-streamiddemux
*
* Direct input stream to one out of N output pads by stream-id.
* The basic concept was started from de-funneling element which restores one
* serialized stream via #GstFunnel to its original state. #GstStreamidDemux
* classifies each stream base on stream ids.
*
* The stream id demux always takes one input and checks how many streams
* are contained in a stream by STREAM_START event. Likewise #GstFunnel,
* #GstStreamidDemux does not synchronize the different output streams.
*
* #GstStreamidDemux:active-pad provides information about which output pad
* is activated at the moment.
*
* @see_also: #GstFunnel, #gst_event_new_stream_start
*/
#ifdef HAVE_CONFIG_H

View file

@ -42,6 +42,11 @@ G_BEGIN_DECLS
typedef struct _GstStreamidDemux GstStreamidDemux;
typedef struct _GstStreamidDemuxClass GstStreamidDemuxClass;
/**
* GstStreamidDemux:
*
* The opaque #GstStreamidDemux data structure.
*/
struct _GstStreamidDemux
{
GstElement element;