1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>rtpdtmfsrc: GStreamer Good Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-good Elements"> 9<link rel="prev" href="gst-plugins-good-plugins-rtpdtmfmux.html" title="rtpdtmfmux"> 10<link rel="next" href="gst-plugins-good-plugins-rtpdvdepay.html" title="rtpdvdepay"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-good-plugins-rtpdtmfsrc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-rtpdtmfsrc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-rtpdtmfsrc.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-good-plugins-rtpdtmfmux.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-good-plugins-rtpdvdepay.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-good-plugins-rtpdtmfsrc"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-rtpdtmfsrc.top_of_page"></a>rtpdtmfsrc</span></h2> 32<p>rtpdtmfsrc</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-good-plugins-rtpdtmfsrc.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--clock-rate" title="The “clock-rate” property">clock-rate</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--packet-redundancy" title="The “packet-redundancy” property">packet-redundancy</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--pt" title="The “pt” property">pt</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60<tr> 61<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 62<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--seqnum" title="The “seqnum” property">seqnum</a></td> 63<td class="property_flags">Read</td> 64</tr> 65<tr> 66<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 67<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--seqnum-offset" title="The “seqnum-offset” property">seqnum-offset</a></td> 68<td class="property_flags">Read / Write</td> 69</tr> 70<tr> 71<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 72<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--ssrc" title="The “ssrc” property">ssrc</a></td> 73<td class="property_flags">Read / Write</td> 74</tr> 75<tr> 76<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 77<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--timestamp" title="The “timestamp” property">timestamp</a></td> 78<td class="property_flags">Read</td> 79</tr> 80<tr> 81<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 82<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--timestamp-offset" title="The “timestamp-offset” property">timestamp-offset</a></td> 83<td class="property_flags">Read / Write</td> 84</tr> 85</tbody> 86</table></div> 87</div> 88<a name="GstRTPDTMFSrc"></a><div class="refsect1"> 89<a name="gst-plugins-good-plugins-rtpdtmfsrc.other"></a><h2>Types and Values</h2> 90<div class="informaltable"><table class="informaltable" width="100%" border="0"> 91<colgroup> 92<col width="150px" class="name"> 93<col class="description"> 94</colgroup> 95<tbody><tr> 96<td class="datatype_keyword">struct</td> 97<td class="function_name"><a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc-struct" title="struct GstRTPDTMFSrc">GstRTPDTMFSrc</a></td> 98</tr></tbody> 99</table></div> 100</div> 101<div class="refsect1"> 102<a name="gst-plugins-good-plugins-rtpdtmfsrc.object-hierarchy"></a><h2>Object Hierarchy</h2> 103<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 104 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 105 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 106 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 107 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSrc.html#GstBaseSrc-struct">GstBaseSrc</a> 108 <span class="lineart">╰──</span> GstRTPDTMFSrc 109</pre> 110</div> 111<div class="refsect1"> 112<a name="gst-plugins-good-plugins-rtpdtmfsrc.description"></a><h2>Description</h2> 113<p>The RTPDTMFSrc element generates RTP DTMF (RFC 2833) event packets on request 114from application. The application communicates the beginning and end of a 115DTMF event using custom upstream gstreamer events. To report a DTMF event, an 116application must send an event of type GST_EVENT_CUSTOM_UPSTREAM, having a 117structure of name "dtmf-event" with fields set according to the following 118table:</p> 119<div class="informaltable"><table class="informaltable" border="1"> 120<colgroup> 121<col class="Name"> 122<col class="Type"> 123<col class="Possible values"> 124<col class="Purpose"> 125</colgroup> 126<thead><tr> 127<th>Name</th> 128<th>GType</th> 129<th>Possible values</th> 130<th>Purpose</th> 131</tr></thead> 132<tbody> 133<tr> 134<td>type</td> 135<td>G_TYPE_INT</td> 136<td>0-1</td> 137<td>The application uses this field to specify which of the two methods 138specified in RFC 2833 to use. The value should be 0 for tones and 1 for 139named events. Tones are specified by their frequencies and events are specied 140by their number. This element can only take events as input. Do not confuse 141with "method" which specified the output. 142</td> 143</tr> 144<tr> 145<td>number</td> 146<td>G_TYPE_INT</td> 147<td>0-15</td> 148<td>The event number.</td> 149</tr> 150<tr> 151<td>volume</td> 152<td>G_TYPE_INT</td> 153<td>0-36</td> 154<td>This field describes the power level of the tone, expressed in dBm0 155after dropping the sign. Power levels range from 0 to -63 dBm0. The range of 156valid DTMF is from 0 to -36 dBm0. Can be omitted if start is set to FALSE. 157</td> 158</tr> 159<tr> 160<td>start</td> 161<td>G_TYPE_BOOLEAN</td> 162<td>True or False</td> 163<td>Whether the event is starting or ending.</td> 164</tr> 165<tr> 166<td>method</td> 167<td>G_TYPE_INT</td> 168<td>1</td> 169<td>The method used for sending event, this element will react if this 170field is absent or 1. 171</td> 172</tr> 173</tbody> 174</table></div> 175<p>For example, the following code informs the pipeline (and in turn, the 176RTPDTMFSrc element inside the pipeline) about the start of an RTP DTMF named 177event '1' of volume -25 dBm0:</p> 178<pre class="programlisting"> 179structure = gst_structure_new ("dtmf-event", 180 "type", G_TYPE_INT, 1, 181 "number", G_TYPE_INT, 1, 182 "volume", G_TYPE_INT, 25, 183 "start", G_TYPE_BOOLEAN, TRUE, NULL); 184 185event = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, structure); 186gst_element_send_event (pipeline, event); 187</pre> 188<p>When a DTMF tone actually starts or stop, a "dtmf-event-processed" 189element <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a> with the same fields as the "dtmf-event" 190<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> that was used to request the event. Also, if any event 191has not been processed when the element goes from the PAUSED to the 192READY state, then a "dtmf-event-dropped" message is posted on the 193<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBus.html#GstBus-struct"><span class="type">GstBus</span></a> in the order that they were received.</p> 194<div class="refsynopsisdiv"> 195<h2>Synopsis</h2> 196<div class="refsect2"> 197<a name="id-1.2.144.7.7.1"></a><h3>Element Information</h3> 198<div class="variablelist"><table border="0" class="variablelist"> 199<colgroup> 200<col align="left" valign="top"> 201<col> 202</colgroup> 203<tbody> 204<tr> 205<td><p><span class="term">plugin</span></p></td> 206<td> 207 <a class="link" href="gst-plugins-good-plugins-plugin-dtmf.html#plugin-dtmf">dtmf</a> 208 </td> 209</tr> 210<tr> 211<td><p><span class="term">author</span></p></td> 212<td>Zeeshan Ali <zeeshan.ali@nokia.com></td> 213</tr> 214<tr> 215<td><p><span class="term">class</span></p></td> 216<td>Source/Network</td> 217</tr> 218</tbody> 219</table></div> 220</div> 221<hr> 222<div class="refsect2"> 223<a name="id-1.2.144.7.7.2"></a><h3>Element Pads</h3> 224<div class="variablelist"><table border="0" class="variablelist"> 225<colgroup> 226<col align="left" valign="top"> 227<col> 228</colgroup> 229<tbody> 230<tr> 231<td><p><span class="term">name</span></p></td> 232<td>src</td> 233</tr> 234<tr> 235<td><p><span class="term">direction</span></p></td> 236<td>source</td> 237</tr> 238<tr> 239<td><p><span class="term">presence</span></p></td> 240<td>always</td> 241</tr> 242<tr> 243<td><p><span class="term">details</span></p></td> 244<td>application/x-rtp, media=(string)audio, payload=(int)[ 96, 127 ], clock-rate=(int)[ 0, 2147483647 ], encoding-name=(string)TELEPHONE-EVENT</td> 245</tr> 246</tbody> 247</table></div> 248</div> 249</div> 250</div> 251<div class="refsect1"> 252<a name="gst-plugins-good-plugins-rtpdtmfsrc.functions_details"></a><h2>Functions</h2> 253<p></p> 254</div> 255<div class="refsect1"> 256<a name="gst-plugins-good-plugins-rtpdtmfsrc.other_details"></a><h2>Types and Values</h2> 257<div class="refsect2"> 258<a name="GstRTPDTMFSrc-struct"></a><h3>struct GstRTPDTMFSrc</h3> 259<pre class="programlisting">struct GstRTPDTMFSrc;</pre> 260<p>The opaque <a class="link" href="gst-plugins-good-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc"><span class="type">GstRTPDTMFSrc</span></a> data structure.</p> 261<div class="refsect3"> 262<a name="GstRTPDTMFSrc.members"></a><h4>Members</h4> 263<div class="informaltable"><table class="informaltable" width="100%" border="0"> 264<colgroup> 265<col width="300px" class="struct_members_name"> 266<col class="struct_members_description"> 267<col width="200px" class="struct_members_annotations"> 268</colgroup> 269<tbody></tbody> 270</table></div> 271</div> 272</div> 273</div> 274<div class="refsect1"> 275<a name="gst-plugins-good-plugins-rtpdtmfsrc.property-details"></a><h2>Property Details</h2> 276<div class="refsect2"> 277<a name="GstRTPDTMFSrc--clock-rate"></a><h3>The <code class="literal">“clock-rate”</code> property</h3> 278<pre class="programlisting"> “clock-rate” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 279<p>The clock-rate at which to generate the dtmf packets.</p> 280<p>Flags: Read / Write</p> 281<p>Default value: 8000</p> 282</div> 283<hr> 284<div class="refsect2"> 285<a name="GstRTPDTMFSrc--packet-redundancy"></a><h3>The <code class="literal">“packet-redundancy”</code> property</h3> 286<pre class="programlisting"> “packet-redundancy” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 287<p>Number of packets to send to indicate start and stop dtmf events.</p> 288<p>Flags: Read / Write</p> 289<p>Allowed values: [1,5]</p> 290<p>Default value: 1</p> 291</div> 292<hr> 293<div class="refsect2"> 294<a name="GstRTPDTMFSrc--pt"></a><h3>The <code class="literal">“pt”</code> property</h3> 295<pre class="programlisting"> “pt” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 296<p>The payload type of the packets.</p> 297<p>Flags: Read / Write</p> 298<p>Allowed values: <= 128</p> 299<p>Default value: 96</p> 300</div> 301<hr> 302<div class="refsect2"> 303<a name="GstRTPDTMFSrc--seqnum"></a><h3>The <code class="literal">“seqnum”</code> property</h3> 304<pre class="programlisting"> “seqnum” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 305<p>The RTP sequence number of the last processed packet.</p> 306<p>Flags: Read</p> 307<p>Default value: 0</p> 308</div> 309<hr> 310<div class="refsect2"> 311<a name="GstRTPDTMFSrc--seqnum-offset"></a><h3>The <code class="literal">“seqnum-offset”</code> property</h3> 312<pre class="programlisting"> “seqnum-offset” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 313<p>Offset to add to all outgoing seqnum (-1 = random).</p> 314<p>Flags: Read / Write</p> 315<p>Allowed values: >= G_MAXULONG</p> 316<p>Default value: -1</p> 317</div> 318<hr> 319<div class="refsect2"> 320<a name="GstRTPDTMFSrc--ssrc"></a><h3>The <code class="literal">“ssrc”</code> property</h3> 321<pre class="programlisting"> “ssrc” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 322<p>The SSRC of the packets (-1 == random).</p> 323<p>Flags: Read / Write</p> 324<p>Default value: 4294967295</p> 325</div> 326<hr> 327<div class="refsect2"> 328<a name="GstRTPDTMFSrc--timestamp"></a><h3>The <code class="literal">“timestamp”</code> property</h3> 329<pre class="programlisting"> “timestamp” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 330<p>The RTP timestamp of the last processed packet.</p> 331<p>Flags: Read</p> 332<p>Default value: 0</p> 333</div> 334<hr> 335<div class="refsect2"> 336<a name="GstRTPDTMFSrc--timestamp-offset"></a><h3>The <code class="literal">“timestamp-offset”</code> property</h3> 337<pre class="programlisting"> “timestamp-offset” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 338<p>Offset to add to all outgoing timestamps (-1 = random).</p> 339<p>Flags: Read / Write</p> 340<p>Allowed values: >= G_MAXULONG</p> 341<p>Default value: -1</p> 342</div> 343</div> 344<div class="refsect1"> 345<a name="gst-plugins-good-plugins-rtpdtmfsrc.see-also"></a><h2>See Also</h2> 346<p>dtmfsrc, rtpdtmfdepay, rtpdtmfmux</p> 347</div> 348</div> 349<div class="footer"> 350<hr>Generated by GTK-Doc V1.28</div> 351</body> 352</html>
