From a4500c0e741bc8047c7d981ac5eab525ac1bf60a Mon Sep 17 00:00:00 2001 From: =?utf8?q?Olivier=20Cr=C3=AAte?= Date: Fri, 7 May 2010 18:54:49 -0400 Subject: [PATCH] rtpdtmfmux: Update doc for simplification --- gst/rtpmanager/gstrtpdtmfmux.c | 36 +++++------------------------------- 1 file changed, 5 insertions(+), 31 deletions(-) diff --git a/gst/rtpmanager/gstrtpdtmfmux.c b/gst/rtpmanager/gstrtpdtmfmux.c index e759972..a198d04 100644 --- a/gst/rtpmanager/gstrtpdtmfmux.c +++ b/gst/rtpmanager/gstrtpdtmfmux.c @@ -27,38 +27,12 @@ /** * SECTION:element-rtpdtmfmux - * @see_also: rtpdtmfsrc, dtmfsrc - * - * The RTPDTMFMuxer mixes/muxes RTP DTMF stream(s) into other RTP - * streams. It does exactly what it's parent (rtpmux) does, except - * that it allows upstream peer elements to request exclusive access - * to the stream, which is required by the RTP DTMF standards (see RFC - * 2833, section 3.2, para 1 for details). The peer upstream element - * requests the acquisition and release of a stream lock beginning - * using custom downstream gstreamer events. To request the acquisition - * of the lock, the peer element must send an event of type - * GST_EVENT_CUSTOM_DOWNSTREAM_OOB, having a - * structure of name "stream-lock" with only one boolean field: - * "lock". If this field is set to TRUE, the request is for the - * acquisition of the lock, otherwise it is for release of the lock. - * - * For example, the following code in an upstream peer element - * requests the acquisition of the stream lock: - * - * - * GstEvent *event; - * GstStructure *structure; - * GstPad *srcpad; - * - * ... /\* srcpad initialization goes here \*\/ - * - * structure = gst_structure_new ("stream-lock", - * "lock", G_TYPE_BOOLEAN, TRUE, NULL); - * - * event = gst_event_new_custom (GST_EVENT_CUSTOM_DOWNSTREAM_OOB, structure); - * gst_pad_push_event (dtmfsrc->srcpad, event); - * + * @see_also: rtpdtmfsrc, dtmfsrc, rtpmux * + * The RTP "DTMF" Muxer muxes multiple RTP streams into a valid RTP + * stream. It does exactly what it's parent (#rtpmux) does, except + * that it prevent buffers coming over a regular sink_%%d pad from going through + * for the duration of buffers that came in a priority_sink_%%d pad. */ #ifdef HAVE_CONFIG_H -- 2.7.4