~ubuntu-branches/ubuntu/quantal/gst-plugins-bad0.10/quantal-proposed

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-bad-plugins-rtpdtmfsrc.html

  • Committer: Bazaar Package Importer
  • Author(s): Ken VanDine
  • Date: 2011-07-19 14:32:43 UTC
  • mfrom: (18.4.21 sid)
  • Revision ID: james.westby@ubuntu.com-20110719143243-p7pnkh45akfp0ihk
Tags: 0.10.22-2ubuntu1
* Rebased on debian unstable, remaining changes:
  - debian/gstreamer-plugins-bad.install
    * don't include dtmf, liveadder, rtpmux, autoconvert and shm, we include 
      them in -good

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9
9
<link rel="prev" href="gst-plugins-bad-plugins-rtpdtmfdepay.html" title="rtpdtmfdepay">
10
10
<link rel="next" href="gst-plugins-bad-plugins-rtpdtmfmux.html" title="rtpdtmfmux">
11
 
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
30
30
                  <a href="#gst-plugins-bad-plugins-rtpdtmfsrc.properties" class="shortcut">Properties</a>
31
31
</td></tr>
32
32
</table>
33
 
<div class="refentry" title="rtpdtmfsrc">
 
33
<div class="refentry">
34
34
<a name="gst-plugins-bad-plugins-rtpdtmfsrc"></a><div class="titlepage"></div>
35
35
<div class="refnamediv"><table width="100%"><tr>
36
36
<td valign="top">
39
39
</td>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
42
 
<div class="refsynopsisdiv" title="Synopsis">
 
42
<div class="refsynopsisdiv">
43
43
<a name="gst-plugins-bad-plugins-rtpdtmfsrc.synopsis"></a><h2>Synopsis</h2>
44
 
<a name="GstRTPDTMFSrc"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-bad-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc-struct" title="GstRTPDTMFSrc">GstRTPDTMFSrc</a>;
 
44
<a name="GstRTPDTMFSrc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-bad-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc-struct" title="struct GstRTPDTMFSrc">GstRTPDTMFSrc</a>;
45
45
</pre>
46
46
</div>
47
 
<div class="refsect1" title="Object Hierarchy">
 
47
<div class="refsect1">
48
48
<a name="gst-plugins-bad-plugins-rtpdtmfsrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
49
49
<pre class="synopsis">
50
50
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
54
54
                     +----GstRTPDTMFSrc
55
55
</pre>
56
56
</div>
57
 
<div class="refsect1" title="Properties">
 
57
<div class="refsect1">
58
58
<a name="gst-plugins-bad-plugins-rtpdtmfsrc.properties"></a><h2>Properties</h2>
59
59
<pre class="synopsis">
60
60
  "<a class="link" href="gst-plugins-bad-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--clock-rate" title='The "clock-rate" property'>clock-rate</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
68
68
  "<a class="link" href="gst-plugins-bad-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc--timestamp-offset" title='The "timestamp-offset" property'>timestamp-offset</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
69
69
</pre>
70
70
</div>
71
 
<div class="refsect1" title="Description">
 
71
<div class="refsect1">
72
72
<a name="gst-plugins-bad-plugins-rtpdtmfsrc.description"></a><h2>Description</h2>
73
73
<p>
74
74
The RTPDTMFSrc element generates RTP DTMF (RFC 2833) event packets on request
157
157
</pre>
158
158
<p>
159
159
</p>
160
 
</div>
161
 
<div class="refsect1" title="Details">
 
160
<div class="refsynopsisdiv">
 
161
<h2>Synopsis</h2>
 
162
<div class="refsect2">
 
163
<a name="idp16517856"></a><h3>Element Information</h3>
 
164
<div class="variablelist"><table border="0">
 
165
<col align="left" valign="top">
 
166
<tbody>
 
167
<tr>
 
168
<td><p><span class="term">plugin</span></p></td>
 
169
<td>
 
170
            <a class="link" href="gst-plugins-bad-plugins-plugin-dtmf.html#plugin-dtmf">dtmf</a>
 
171
          </td>
 
172
</tr>
 
173
<tr>
 
174
<td><p><span class="term">author</span></p></td>
 
175
<td>Zeeshan Ali &lt;zeeshan.ali@nokia.com&gt;</td>
 
176
</tr>
 
177
<tr>
 
178
<td><p><span class="term">class</span></p></td>
 
179
<td>Source/Network</td>
 
180
</tr>
 
181
</tbody>
 
182
</table></div>
 
183
</div>
 
184
<hr>
 
185
<div class="refsect2">
 
186
<a name="idp16623712"></a><h3>Element Pads</h3>
 
187
<div class="variablelist"><table border="0">
 
188
<col align="left" valign="top">
 
189
<tbody>
 
190
<tr>
 
191
<td><p><span class="term">name</span></p></td>
 
192
<td>src</td>
 
193
</tr>
 
194
<tr>
 
195
<td><p><span class="term">direction</span></p></td>
 
196
<td>source</td>
 
197
</tr>
 
198
<tr>
 
199
<td><p><span class="term">presence</span></p></td>
 
200
<td>always</td>
 
201
</tr>
 
202
<tr>
 
203
<td><p><span class="term">details</span></p></td>
 
204
<td>application/x-rtp, media=(string)audio, payload=(int)[ 96, 127 ], clock-rate=(int)[ 0, 2147483647 ], ssrc=(int)[ 0, 2147483647 ], encoding-name=(string)TELEPHONE-EVENT</td>
 
205
</tr>
 
206
</tbody>
 
207
</table></div>
 
208
</div>
 
209
</div>
 
210
<p>
 
211
</p>
 
212
</div>
 
213
<div class="refsect1">
162
214
<a name="gst-plugins-bad-plugins-rtpdtmfsrc.details"></a><h2>Details</h2>
163
 
<div class="refsect2" title="GstRTPDTMFSrc">
164
 
<a name="GstRTPDTMFSrc-struct"></a><h3>GstRTPDTMFSrc</h3>
165
 
<pre class="programlisting">typedef struct _GstRTPDTMFSrc GstRTPDTMFSrc;</pre>
 
215
<div class="refsect2">
 
216
<a name="GstRTPDTMFSrc-struct"></a><h3>struct GstRTPDTMFSrc</h3>
 
217
<pre class="programlisting">struct GstRTPDTMFSrc;</pre>
166
218
<p>
167
219
The opaque <a class="link" href="gst-plugins-bad-plugins-rtpdtmfsrc.html#GstRTPDTMFSrc"><span class="type">GstRTPDTMFSrc</span></a> data structure.
168
220
</p>
172
224
</table></div>
173
225
</div>
174
226
</div>
175
 
<div class="refsect1" title="Property Details">
 
227
<div class="refsect1">
176
228
<a name="gst-plugins-bad-plugins-rtpdtmfsrc.property-details"></a><h2>Property Details</h2>
177
 
<div class="refsect2" title='The "clock-rate" property'>
 
229
<div class="refsect2">
178
230
<a name="GstRTPDTMFSrc--clock-rate"></a><h3>The <code class="literal">"clock-rate"</code> property</h3>
179
231
<pre class="programlisting">  "clock-rate"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
180
232
<p>The clock-rate at which to generate the dtmf packets.</p>
181
233
<p>Default value: 8000</p>
182
234
</div>
183
235
<hr>
184
 
<div class="refsect2" title='The "interval" property'>
 
236
<div class="refsect2">
185
237
<a name="GstRTPDTMFSrc--interval"></a><h3>The <code class="literal">"interval"</code> property</h3>
186
238
<pre class="programlisting">  "interval"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
187
239
<p>Interval in ms between two rtp packets.</p>
189
241
<p>Default value: 50</p>
190
242
</div>
191
243
<hr>
192
 
<div class="refsect2" title='The "packet-redundancy" property'>
 
244
<div class="refsect2">
193
245
<a name="GstRTPDTMFSrc--packet-redundancy"></a><h3>The <code class="literal">"packet-redundancy"</code> property</h3>
194
246
<pre class="programlisting">  "packet-redundancy"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
195
247
<p>Number of packets to send to indicate start and stop dtmf events.</p>
197
249
<p>Default value: 1</p>
198
250
</div>
199
251
<hr>
200
 
<div class="refsect2" title='The "pt" property'>
 
252
<div class="refsect2">
201
253
<a name="GstRTPDTMFSrc--pt"></a><h3>The <code class="literal">"pt"</code> property</h3>
202
254
<pre class="programlisting">  "pt"                       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
203
255
<p>The payload type of the packets.</p>
205
257
<p>Default value: 96</p>
206
258
</div>
207
259
<hr>
208
 
<div class="refsect2" title='The "seqnum" property'>
 
260
<div class="refsect2">
209
261
<a name="GstRTPDTMFSrc--seqnum"></a><h3>The <code class="literal">"seqnum"</code> property</h3>
210
262
<pre class="programlisting">  "seqnum"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
211
263
<p>The RTP sequence number of the last processed packet.</p>
212
264
<p>Default value: 0</p>
213
265
</div>
214
266
<hr>
215
 
<div class="refsect2" title='The "seqnum-offset" property'>
 
267
<div class="refsect2">
216
268
<a name="GstRTPDTMFSrc--seqnum-offset"></a><h3>The <code class="literal">"seqnum-offset"</code> property</h3>
217
269
<pre class="programlisting">  "seqnum-offset"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
218
270
<p>Offset to add to all outgoing seqnum (-1 = random).</p>
220
272
<p>Default value: -1</p>
221
273
</div>
222
274
<hr>
223
 
<div class="refsect2" title='The "ssrc" property'>
 
275
<div class="refsect2">
224
276
<a name="GstRTPDTMFSrc--ssrc"></a><h3>The <code class="literal">"ssrc"</code> property</h3>
225
277
<pre class="programlisting">  "ssrc"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
226
278
<p>The SSRC of the packets (-1 == random).</p>
227
279
<p>Default value: 4294967295</p>
228
280
</div>
229
281
<hr>
230
 
<div class="refsect2" title='The "timestamp" property'>
 
282
<div class="refsect2">
231
283
<a name="GstRTPDTMFSrc--timestamp"></a><h3>The <code class="literal">"timestamp"</code> property</h3>
232
284
<pre class="programlisting">  "timestamp"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
233
285
<p>The RTP timestamp of the last processed packet.</p>
234
286
<p>Default value: 0</p>
235
287
</div>
236
288
<hr>
237
 
<div class="refsect2" title='The "timestamp-offset" property'>
 
289
<div class="refsect2">
238
290
<a name="GstRTPDTMFSrc--timestamp-offset"></a><h3>The <code class="literal">"timestamp-offset"</code> property</h3>
239
291
<pre class="programlisting">  "timestamp-offset"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
240
292
<p>Offset to add to all outgoing timestamps (-1 = random).</p>
242
294
<p>Default value: -1</p>
243
295
</div>
244
296
</div>
245
 
<div class="refsect1" title="See Also">
 
297
<div class="refsect1">
246
298
<a name="gst-plugins-bad-plugins-rtpdtmfsrc.see-also"></a><h2>See Also</h2>
247
299
dtmfsrc, rtpdtmfdepay, rtpdtmfmux
248
300
</div>
249
301
</div>
250
302
<div class="footer">
251
303
<hr>
252
 
          Generated by GTK-Doc V1.15</div>
 
304
          Generated by GTK-Doc V1.17</div>
253
305
</body>
254
306
</html>
 
 
b'\\ No newline at end of file'