mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-10 16:45:55 +00:00
Code Issues 1 Projects Releases Wiki Activity

rtpmux: Some more doc fixing

Browse source 
20070322121453-65035-12d602272217b51bd97df4e5790024c399622dd3.gz
This commit is contained in:
zeeshan.ali@nokia.com 2007-03-22 12:14:53 +00:00 committed by Tim-Philipp Müller
parent 0de7fb6f37
commit 21e6e951f6
1 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
gst/rtpmanager/gstrtpdtmfmux.c
View file

@ -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>
*/