summaryrefslogtreecommitdiff
path: root/gst/rtpmanager/gstrtpdtmfmux.c
diff options
context:
space:
mode:
authorzeeshan.ali@nokia.com <zeeshan.ali@nokia.com>2007-03-22 12:14:53 +0000
committerTim-Philipp Müller <tim@centricular.net>2012-12-16 16:29:32 +0000
commit21e6e951f60dcbe5bb0eba9aa4ee06d603393450 (patch)
treedbcef9da1eb09abd71f818685557812b709f8522 /gst/rtpmanager/gstrtpdtmfmux.c
parent0de7fb6f37e051687b6a44884069eaca1a355b18 (diff)
rtpmux: Some more doc fixing
Diffstat (limited to 'gst/rtpmanager/gstrtpdtmfmux.c')
-rw-r--r--gst/rtpmanager/gstrtpdtmfmux.c16
1 files changed, 7 insertions, 9 deletions
diff --git a/gst/rtpmanager/gstrtpdtmfmux.c b/gst/rtpmanager/gstrtpdtmfmux.c
index 9d0da4ed4..642424c5c 100644
--- a/gst/rtpmanager/gstrtpdtmfmux.c
+++ b/gst/rtpmanager/gstrtpdtmfmux.c
@@ -26,24 +26,23 @@
/**
* SECTION:element-rtpdtmfmux
* @short_description: mixes RTP DTMF streams into other RTP streams
- *
* <refsect2>
* <para>
* The RTPDTMFMuxer mixes/muxes RTP DTMF stream(s) into other RTP
* streams. It does exactly what it's parent (RTPMuxer) 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 for details). The peer upstream element requests the
- * requisition and release of a stream lock beginning using custom
- * downstream gstreamer events. To request the requesition of the
- * lock, the peer element must send an event of type
+ * 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
- * requisition of the lock, otherwise it is for release of the lock.
+ * acquisition of the lock, otherwise it is for release of the lock.
* </para>
* <para>For example, the following code in an upstream peer element
- * requests the requisition of the stream lock:
+ * requests the acquisition of the stream lock:
* </para>
* <para>
* <programlisting>
@@ -60,7 +59,6 @@
* gst_pad_push_event (dtmfsrc->srcpad, event);
* </programlisting>
* </para>
- *
* </refsect2>
*/