This file is indexed.

/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-gstrtpbaseaudiopayload.html is in gstreamer1.0-plugins-base-doc 1.2.3-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gstrtpbaseaudiopayload</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
<link rel="up" href="gstreamer-rtp.html" title="RTP Library">
<link rel="prev" href="gstreamer-rtp.html" title="RTP Library">
<link rel="next" href="gst-plugins-base-libs-gstrtpbasedepayload.html" title="gstrtpbasedepayload">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="gstreamer-rtp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gstreamer-rtp.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 Base Plugins 1.0 Library Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-base-libs-gstrtpbasedepayload.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-base-libs-gstrtpbaseaudiopayload.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gst-plugins-base-libs-gstrtpbaseaudiopayload.description" class="shortcut">Description</a>
                   | 
                  <a href="#gst-plugins-base-libs-gstrtpbaseaudiopayload.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#gst-plugins-base-libs-gstrtpbaseaudiopayload.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-base-libs-gstrtpbaseaudiopayload"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstrtpbaseaudiopayload.top_of_page"></a>gstrtpbaseaudiopayload</span></h2>
<p>gstrtpbaseaudiopayload — Base class for audio RTP payloader</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-base-libs-gstrtpbaseaudiopayload.synopsis"></a><h2>Synopsis</h2>
<a name="GstRTPBaseAudioPayload"></a><pre class="synopsis">
#include &lt;gst/rtp/gstrtpbaseaudiopayload.h&gt;

struct              <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload-struct" title="struct GstRTPBaseAudioPayload">GstRTPBaseAudioPayload</a>;
struct              <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayloadClass" title="struct GstRTPBaseAudioPayloadClass">GstRTPBaseAudioPayloadClass</a>;
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-set-frame-based" title="gst_rtp_base_audio_payload_set_frame_based ()">gst_rtp_base_audio_payload_set_frame_based</a>
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-set-frame-options" title="gst_rtp_base_audio_payload_set_frame_options ()">gst_rtp_base_audio_payload_set_frame_options</a>
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_duration</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_size</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-set-sample-based" title="gst_rtp_base_audio_payload_set_sample_based ()">gst_rtp_base_audio_payload_set_sample_based</a>
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-set-sample-options" title="gst_rtp_base_audio_payload_set_sample_options ()">gst_rtp_base_audio_payload_set_sample_options</a>
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sample_size</code></em>);
<a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstAdapter.html"><span class="returnvalue">GstAdapter</span></a> *        <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-get-adapter" title="gst_rtp_base_audio_payload_get_adapter ()">gst_rtp_base_audio_payload_get_adapter</a>
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>);
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>       <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-push" title="gst_rtp_base_audio_payload_push ()">gst_rtp_base_audio_payload_push</a>     (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *baseaudiopayload</code></em>,
                                                         <em class="parameter"><code>const <span class="type">guint8</span> *data</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> payload_len</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>);
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>       <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-flush" title="gst_rtp_base_audio_payload_flush ()">gst_rtp_base_audio_payload_flush</a>    (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *baseaudiopayload</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> payload_len</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-set-samplebits-options" title="gst_rtp_base_audio_payload_set_samplebits_options ()">gst_rtp_base_audio_payload_set_samplebits_options</a>
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sample_size</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstrtpbaseaudiopayload.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/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html">GstObject</a>
               +----<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html">GstElement</a>
                     +----<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload">GstRTPBasePayload</a>
                           +----GstRTPBaseAudioPayload
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstrtpbaseaudiopayload.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload--buffer-list" title='The "buffer-list" property'>buffer-list</a>"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstrtpbaseaudiopayload.description"></a><h2>Description</h2>
<p>
Provides a base class for audio RTP payloaders for frame or sample based
audio codecs (constant bitrate)
</p>
<p>
This class derives from GstRTPBasePayload. It can be used for payloading
audio codecs. It will only work with constant bitrate codecs. It supports
both frame based and sample based codecs. It takes care of packing up the
audio data into RTP packets and filling up the headers accordingly. The
payloading is done based on the maximum MTU (mtu) and the maximum time per
packet (max-ptime). The general idea is to divide large data buffers into
smaller RTP packets. The RTP packet size is the minimum of either the MTU,
max-ptime (if set) or available data. The RTP packet size is always larger or
equal to min-ptime (if set). If min-ptime is not set, any residual data is
sent in a last RTP packet. In the case of frame based codecs, the resulting
RTP packets always contain full frames.
</p>
<p>
</p>
<div class="refsect2">
<a name="id-1.2.9.3.6.4.1"></a><h3>Usage</h3>
<p>
To use this base class, your child element needs to call either
<a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-set-frame-based" title="gst_rtp_base_audio_payload_set_frame_based ()"><code class="function">gst_rtp_base_audio_payload_set_frame_based()</code></a> or
<a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-set-sample-based" title="gst_rtp_base_audio_payload_set_sample_based ()"><code class="function">gst_rtp_base_audio_payload_set_sample_based()</code></a>. This is usually done in the
element's <code class="function">_init()</code> function. Then, the child element must call either
<a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-set-frame-options" title="gst_rtp_base_audio_payload_set_frame_options ()"><code class="function">gst_rtp_base_audio_payload_set_frame_options()</code></a>,
<a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#gst-rtp-base-audio-payload-set-sample-options" title="gst_rtp_base_audio_payload_set_sample_options ()"><code class="function">gst_rtp_base_audio_payload_set_sample_options()</code></a> or
gst_rtp_base_audio_payload_set_samplebits_options. Since
GstRTPBaseAudioPayload derives from GstRTPBasePayload, the child element
must set any variables or call/override any functions required by that base
class. The child element does not need to override any other functions
specific to GstRTPBaseAudioPayload.
</p>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstrtpbaseaudiopayload.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstRTPBaseAudioPayload-struct"></a><h3>struct GstRTPBaseAudioPayload</h3>
<pre class="programlisting">struct GstRTPBaseAudioPayload;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GstRTPBaseAudioPayloadClass"></a><h3>struct GstRTPBaseAudioPayloadClass</h3>
<pre class="programlisting">struct GstRTPBaseAudioPayloadClass {
  GstRTPBasePayloadClass parent_class;
};
</pre>
<p>
Base class for audio RTP payloader.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayloadClass" title="struct GstRTPBasePayloadClass"><span class="type">GstRTPBasePayloadClass</span></a> <em class="structfield"><code><a name="GstRTPBaseAudioPayloadClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td>the parent class</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-base-audio-payload-set-frame-based"></a><h3>gst_rtp_base_audio_payload_set_frame_based ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gst_rtp_base_audio_payload_set_frame_based
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>);</pre>
<p>
Tells <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> that the child element is for a frame based
audio codec
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>rtpbaseaudiopayload</code></em> :</span></p></td>
<td>a pointer to the element.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-base-audio-payload-set-frame-options"></a><h3>gst_rtp_base_audio_payload_set_frame_options ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gst_rtp_base_audio_payload_set_frame_options
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_duration</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_size</code></em>);</pre>
<p>
Sets the options for frame based audio codecs.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rtpbaseaudiopayload</code></em> :</span></p></td>
<td>a pointer to the element.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>frame_duration</code></em> :</span></p></td>
<td>The duraction of an audio frame in milliseconds.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>frame_size</code></em> :</span></p></td>
<td>The size of an audio frame in bytes.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-base-audio-payload-set-sample-based"></a><h3>gst_rtp_base_audio_payload_set_sample_based ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gst_rtp_base_audio_payload_set_sample_based
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>);</pre>
<p>
Tells <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> that the child element is for a sample based
audio codec
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>rtpbaseaudiopayload</code></em> :</span></p></td>
<td>a pointer to the element.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-base-audio-payload-set-sample-options"></a><h3>gst_rtp_base_audio_payload_set_sample_options ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gst_rtp_base_audio_payload_set_sample_options
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sample_size</code></em>);</pre>
<p>
Sets the options for sample based audio codecs.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rtpbaseaudiopayload</code></em> :</span></p></td>
<td>a pointer to the element.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample_size</code></em> :</span></p></td>
<td>Size per sample in bytes.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-base-audio-payload-get-adapter"></a><h3>gst_rtp_base_audio_payload_get_adapter ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstAdapter.html"><span class="returnvalue">GstAdapter</span></a> *        gst_rtp_base_audio_payload_get_adapter
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>);</pre>
<p>
Gets the internal adapter used by the depayloader.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rtpbaseaudiopayload</code></em> :</span></p></td>
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstAdapter.html"><span class="type">GstAdapter</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-base-audio-payload-push"></a><h3>gst_rtp_base_audio_payload_push ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>       gst_rtp_base_audio_payload_push     (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *baseaudiopayload</code></em>,
                                                         <em class="parameter"><code>const <span class="type">guint8</span> *data</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> payload_len</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>);</pre>
<p>
Create an RTP buffer and store <em class="parameter"><code>payload_len</code></em> bytes of <em class="parameter"><code>data</code></em> as the
payload. Set the timestamp on the new buffer to <em class="parameter"><code>timestamp</code></em> before pushing
the buffer downstream.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>baseaudiopayload</code></em> :</span></p></td>
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>data to set as payload</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>payload_len</code></em> :</span></p></td>
<td>length of payload</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-base-audio-payload-flush"></a><h3>gst_rtp_base_audio_payload_flush ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>       gst_rtp_base_audio_payload_flush    (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *baseaudiopayload</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> payload_len</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>);</pre>
<p>
Create an RTP buffer and store <em class="parameter"><code>payload_len</code></em> bytes of the adapter as the
payload. Set the timestamp on the new buffer to <em class="parameter"><code>timestamp</code></em> before pushing
the buffer downstream.
</p>
<p>
If <em class="parameter"><code>payload_len</code></em> is -1, all pending bytes will be flushed. If <em class="parameter"><code>timestamp</code></em> is
-1, the timestamp will be calculated automatically.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>baseaudiopayload</code></em> :</span></p></td>
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>payload_len</code></em> :</span></p></td>
<td>length of payload</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtp-base-audio-payload-set-samplebits-options"></a><h3>gst_rtp_base_audio_payload_set_samplebits_options ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gst_rtp_base_audio_payload_set_samplebits_options
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload"><span class="type">GstRTPBaseAudioPayload</span></a> *rtpbaseaudiopayload</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sample_size</code></em>);</pre>
<p>
Sets the options for sample based audio codecs.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rtpbaseaudiopayload</code></em> :</span></p></td>
<td>a pointer to the element.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample_size</code></em> :</span></p></td>
<td>Size per sample in bits.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstrtpbaseaudiopayload.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstRTPBaseAudioPayload--buffer-list"></a><h3>The <code class="literal">"buffer-list"</code> property</h3>
<pre class="programlisting">  "buffer-list"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
<p>Use Buffer Lists.</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>