summaryrefslogtreecommitdiffstats
path: root/gst/rtpmux
diff options
context:
space:
mode:
authorzeeshan.ali@nokia.com <zeeshan.ali@nokia.com>2007-03-22 12:14:53 +0000
committerEdward Hervey <bilboed@bilboed.com>2009-02-21 17:48:52 +0100
commitc9496c729486add58e918a130216205bf136072f (patch)
tree5c53c70ecef320f2f5f49ac504abf468845a937a /gst/rtpmux
parentc1bb36b5a3fa4ddea301e2d862f858ebc856467c (diff)
downloadgst-plugins-bad-c9496c729486add58e918a130216205bf136072f.tar.gz
gst-plugins-bad-c9496c729486add58e918a130216205bf136072f.tar.bz2
gst-plugins-bad-c9496c729486add58e918a130216205bf136072f.zip
[MOVED FROM GST-P-FARSIGHT] Some more doc fixing
20070322121453-65035-12d602272217b51bd97df4e5790024c399622dd3.gz
Diffstat (limited to 'gst/rtpmux')
-rw-r--r--gst/rtpmux/gstrtpdtmfmux.c16
1 files changed, 7 insertions, 9 deletions
diff --git a/gst/rtpmux/gstrtpdtmfmux.c b/gst/rtpmux/gstrtpdtmfmux.c
index 28ff6be9..93b99663 100644
--- a/gst/rtpmux/gstrtpdtmfmux.c
+++ b/gst/rtpmux/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>
*/