<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>rtpdtmfmux</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="prev" href="gst-plugins-bad-plugins-rtpdtmfsrc.html" title="rtpdtmfsrc">
<link rel="next" href="gst-plugins-bad-plugins-rtpmux.html" title="rtpmux">
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="chapter" href="ch02.html" title="gst-plugins-bad Plugins">
<link rel="chapter" href="ch03.html" title="gst-plugins-bad Classes">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gst-plugins-bad-plugins-rtpdtmfsrc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Bad Plugins 0.10 Plugins Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-bad-plugins-rtpmux.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-bad-plugins-rtpdtmfmux.synopsis" class="shortcut">Top</a>
|
<a href="#gst-plugins-bad-plugins-rtpdtmfmux.description" class="shortcut">Description</a>
|
<a href="#gst-plugins-bad-plugins-rtpdtmfmux.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#gst-plugins-bad-plugins-rtpdtmfmux.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="rtpdtmfmux">
<a name="gst-plugins-bad-plugins-rtpdtmfmux"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-rtpdtmfmux.top_of_page"></a>rtpdtmfmux</span></h2>
<p>rtpdtmfmux — mixes RTP DTMF streams into other RTP streams</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gst-plugins-bad-plugins-rtpdtmfmux.synopsis"></a><h2>Synopsis</h2>
<a name="GstRTPDTMFMux"></a><pre class="synopsis"> <a class="link" href="gst-plugins-bad-plugins-rtpdtmfmux.html#GstRTPDTMFMux-struct" title="GstRTPDTMFMux">GstRTPDTMFMux</a>;
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="gst-plugins-bad-plugins-rtpdtmfmux.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html">GstObject</a>
+----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html">GstElement</a>
+----<a class="link" href="gst-plugins-bad-plugins-rtpmux.html#GstRTPMux">GstRTPMux</a>
+----GstRTPDTMFMux
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="gst-plugins-bad-plugins-rtpdtmfmux.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="gst-plugins-bad-plugins-rtpdtmfmux.html#GstRTPDTMFMux-locking" title='The "locking" signal'>locking</a>" : Run Last
"<a class="link" href="gst-plugins-bad-plugins-rtpdtmfmux.html#GstRTPDTMFMux-unlocked" title='The "unlocked" signal'>unlocked</a>" : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gst-plugins-bad-plugins-rtpdtmfmux.description"></a><h2>Description</h2>
<p>
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, 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.
</p>
<p>
For example, the following code in an upstream peer element
requests the acquisition of the stream lock:
</p>
<p>
</p>
<pre class="programlisting">
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);
</pre>
</div>
<div class="refsect1" title="Details">
<a name="gst-plugins-bad-plugins-rtpdtmfmux.details"></a><h2>Details</h2>
<div class="refsect2" title="GstRTPDTMFMux">
<a name="GstRTPDTMFMux-struct"></a><h3>GstRTPDTMFMux</h3>
<pre class="programlisting">typedef struct _GstRTPDTMFMux GstRTPDTMFMux;</pre>
<p>
The opaque <a class="link" href="gst-plugins-bad-plugins-rtpdtmfmux.html#GstRTPDTMFMux"><span class="type">GstRTPDTMFMux</span></a> structure.</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="gst-plugins-bad-plugins-rtpdtmfmux.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "locking" signal'>
<a name="GstRTPDTMFMux-locking"></a><h3>The <code class="literal">"locking"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gst-plugins-bad-plugins-rtpdtmfmux.html#GstRTPDTMFMux"><span class="type">GstRTPDTMFMux</span></a> *gstrtpdtmfmux,
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html"><span class="type">GstPad</span></a> *arg1,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gstrtpdtmfmux</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "unlocked" signal'>
<a name="GstRTPDTMFMux-unlocked"></a><h3>The <code class="literal">"unlocked"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gst-plugins-bad-plugins-rtpdtmfmux.html#GstRTPDTMFMux"><span class="type">GstRTPDTMFMux</span></a> *gstrtpdtmfmux,
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html"><span class="type">GstPad</span></a> *arg1,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gstrtpdtmfmux</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="gst-plugins-bad-plugins-rtpdtmfmux.see-also"></a><h2>See Also</h2>
rtpdtmfsrc, dtmfsrc
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.13</div>
</body>
</html>
