diff options
author | Wim Taymans <wim.taymans@gmail.com> | 2007-05-23 13:08:52 +0000 |
---|---|---|
committer | Tim-Philipp Müller <tim.muller@collabora.co.uk> | 2009-08-11 02:30:27 +0100 |
commit | 2a8cfc6410cf29f58287d4ad985e4381e9ff6c61 (patch) | |
tree | f05e8a81ff11e9495af008751d6e930ec113ba06 /gst/rtpmanager/gstrtpssrcdemux.c | |
parent | 3bc059707de50fc6f5e9d100cb5f4094d6ca30b7 (diff) |
Document stuff.
Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* gst/rtpmanager/gstrtpbin.c: (gst_rtp_bin_class_init):
* gst/rtpmanager/gstrtpbin.h:
* gst/rtpmanager/gstrtpclient.c:
* gst/rtpmanager/gstrtpjitterbuffer.c:
(gst_rtp_jitter_buffer_class_init),
(gst_rtp_jitter_buffer_clear_pt_map), (gst_rtp_jitter_buffer_loop):
* gst/rtpmanager/gstrtpjitterbuffer.h:
* gst/rtpmanager/gstrtpptdemux.c: (gst_rtp_pt_demux_class_init),
(gst_rtp_pt_demux_clear_pt_map):
* gst/rtpmanager/gstrtpptdemux.h:
* gst/rtpmanager/gstrtpsession.c: (gst_rtp_session_class_init),
(rtcp_thread), (gst_rtp_session_clear_pt_map):
* gst/rtpmanager/gstrtpsession.h:
* gst/rtpmanager/gstrtpssrcdemux.c:
(gst_rtp_ssrc_demux_class_init):
Document stuff.
Add clear-pt-map action signal where needed.
Diffstat (limited to 'gst/rtpmanager/gstrtpssrcdemux.c')
-rw-r--r-- | gst/rtpmanager/gstrtpssrcdemux.c | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/gst/rtpmanager/gstrtpssrcdemux.c b/gst/rtpmanager/gstrtpssrcdemux.c index 17e421fe..bd0c6b05 100644 --- a/gst/rtpmanager/gstrtpssrcdemux.c +++ b/gst/rtpmanager/gstrtpssrcdemux.c @@ -19,6 +19,33 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-rtpssrcdemux + * @short_description: separate RTP payloads based on the SSRC + * + * <refsect2> + * <para> + * rtpssrcdemux acts as a demuxer for RTP packets based on the SSRC of the + * packets. Its main purpose is to allow an application to easily receive and + * decode an RTP stream with multiple SSRCs. + * </para> + * <para> + * For each SSRC that is detected, a new pad will be created and the + * ::new-ssrc-pad signal will be emitted. + * </para> + * <title>Example pipelines</title> + * <para> + * <programlisting> + * gst-launch udpsrc caps="application/x-rtp" ! rtpssrcdemux ! fakesink + * </programlisting> + * Takes an RTP stream and send the RTP packets with the first detected SSRC + * to fakesink, discarding the other SSRCs. + * </para> + * </refsect2> + * + * Last reviewed on 2007-05-23 (0.10.6) + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif @@ -49,7 +76,7 @@ GST_STATIC_PAD_TEMPLATE ("src_%d", static GstElementDetails gst_rtp_ssrc_demux_details = { "RTP SSRC Demux", - "Codec/Demux/Network", + "Demux/Network/RTP", "Splits RTP streams based on the SSRC", "Wim Taymans <wim@fluendo.com>" }; @@ -165,6 +192,14 @@ gst_rtp_ssrc_demux_class_init (GstRTPSsrcDemuxClass * klass) gobject_klass->finalize = GST_DEBUG_FUNCPTR (gst_rtp_ssrc_demux_finalize); + /** + * GstRTPSsrcDemux::new-ssrc-pad: + * @demux: the object which received the signal + * @ssrc: the SSRC of the pad + * @pad: the new pad. + * + * Emited when a new SSRC pad has been created. + */ gst_rtp_ssrc_demux_signals[SIGNAL_NEW_SSRC_PAD] = g_signal_new ("new-ssrc-pad", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, |