• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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>GstRTPBasePayload: GStreamer Base Plugins 1.0 Library Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
8<link rel="up" href="gstreamer-rtp.html" title="RTP Library">
9<link rel="prev" href="GstRTPBaseDepayload.html" title="GstRTPBaseDepayload">
10<link rel="next" href="gst-plugins-base-libs-GstRTPBuffer.html" title="GstRTPBuffer">
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">|</span18                  <a href="#GstRTPBasePayload.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#GstRTPBasePayload.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#GstRTPBasePayload.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="gstreamer-rtp.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24<td><a accesskey="p" href="GstRTPBaseDepayload.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-base-libs-GstRTPBuffer.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="GstRTPBasePayload"></a><div class="titlepage"></div>
29<div class="refnamediv"><table width="100%"><tr>
30<td valign="top">
31<h2><span class="refentrytitle"><a name="GstRTPBasePayload.top_of_page"></a>GstRTPBasePayload</span></h2>
32<p>GstRTPBasePayload — Base class for RTP payloader</p>
33</td>
34<td class="gallery_image" valign="top" align="right"></td>
35</tr></table></div>
36<div class="refsect1">
37<a name="GstRTPBasePayload.functions"></a><h2>Functions</h2>
38<div class="informaltable"><table class="informaltable" width="100%" border="0">
39<colgroup>
40<col width="150px" class="functions_return">
41<col class="functions_name">
42</colgroup>
43<tbody>
44<tr>
45<td class="define_keyword">#define</td>
46<td class="function_name">
47<a class="link" href="GstRTPBasePayload.html#GST-RTP-BASE-PAYLOAD-MTU:CAPS" title="GST_RTP_BASE_PAYLOAD_MTU()">GST_RTP_BASE_PAYLOAD_MTU</a><span class="c_punctuation">()</span>
48</td>
49</tr>
50<tr>
51<td class="define_keyword">#define</td>
52<td class="function_name">
53<a class="link" href="GstRTPBasePayload.html#GST-RTP-BASE-PAYLOAD-PT:CAPS" title="GST_RTP_BASE_PAYLOAD_PT()">GST_RTP_BASE_PAYLOAD_PT</a><span class="c_punctuation">()</span>
54</td>
55</tr>
56<tr>
57<td class="define_keyword">#define</td>
58<td class="function_name">
59<a class="link" href="GstRTPBasePayload.html#GST-RTP-BASE-PAYLOAD-SINKPAD:CAPS" title="GST_RTP_BASE_PAYLOAD_SINKPAD()">GST_RTP_BASE_PAYLOAD_SINKPAD</a><span class="c_punctuation">()</span>
60</td>
61</tr>
62<tr>
63<td class="define_keyword">#define</td>
64<td class="function_name">
65<a class="link" href="GstRTPBasePayload.html#GST-RTP-BASE-PAYLOAD-SRCPAD:CAPS" title="GST_RTP_BASE_PAYLOAD_SRCPAD()">GST_RTP_BASE_PAYLOAD_SRCPAD</a><span class="c_punctuation">()</span>
66</td>
67</tr>
68<tr>
69<td class="function_type">
70<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
71</td>
72<td class="function_name">
73<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-is-filled" title="gst_rtp_base_payload_is_filled ()">gst_rtp_base_payload_is_filled</a> <span class="c_punctuation">()</span>
74</td>
75</tr>
76<tr>
77<td class="function_type">
78<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
79</td>
80<td class="function_name">
81<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-push" title="gst_rtp_base_payload_push ()">gst_rtp_base_payload_push</a> <span class="c_punctuation">()</span>
82</td>
83</tr>
84<tr>
85<td class="function_type">
86<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
87</td>
88<td class="function_name">
89<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-push-list" title="gst_rtp_base_payload_push_list ()">gst_rtp_base_payload_push_list</a> <span class="c_punctuation">()</span>
90</td>
91</tr>
92<tr>
93<td class="function_type">
94<span class="returnvalue">void</span>
95</td>
96<td class="function_name">
97<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-set-options" title="gst_rtp_base_payload_set_options ()">gst_rtp_base_payload_set_options</a> <span class="c_punctuation">()</span>
98</td>
99</tr>
100<tr>
101<td class="function_type">
102<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
103</td>
104<td class="function_name">
105<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-set-outcaps" title="gst_rtp_base_payload_set_outcaps ()">gst_rtp_base_payload_set_outcaps</a> <span class="c_punctuation">()</span>
106</td>
107</tr>
108<tr>
109<td class="function_type">
110<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> *
111</td>
112<td class="function_name">
113<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-allocate-output-buffer" title="gst_rtp_base_payload_allocate_output_buffer ()">gst_rtp_base_payload_allocate_output_buffer</a> <span class="c_punctuation">()</span>
114</td>
115</tr>
116<tr>
117<td class="function_type">
118<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
119</td>
120<td class="function_name">
121<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-get-source-count" title="gst_rtp_base_payload_get_source_count ()">gst_rtp_base_payload_get_source_count</a> <span class="c_punctuation">()</span>
122</td>
123</tr>
124<tr>
125<td class="function_type">
126<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
127</td>
128<td class="function_name">
129<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-is-source-info-enabled" title="gst_rtp_base_payload_is_source_info_enabled ()">gst_rtp_base_payload_is_source_info_enabled</a> <span class="c_punctuation">()</span>
130</td>
131</tr>
132<tr>
133<td class="function_type">
134<span class="returnvalue">void</span>
135</td>
136<td class="function_name">
137<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-set-source-info-enabled" title="gst_rtp_base_payload_set_source_info_enabled ()">gst_rtp_base_payload_set_source_info_enabled</a> <span class="c_punctuation">()</span>
138</td>
139</tr>
140</tbody>
141</table></div>
142</div>
143<div class="refsect1">
144<a name="GstRTPBasePayload.properties"></a><h2>Properties</h2>
145<div class="informaltable"><table class="informaltable" border="0">
146<colgroup>
147<col width="150px" class="properties_type">
148<col width="300px" class="properties_name">
149<col width="200px" class="properties_flags">
150</colgroup>
151<tbody>
152<tr>
153<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
154<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--max-ptime" title="The “max-ptime” property">max-ptime</a></td>
155<td class="property_flags">Read / Write</td>
156</tr>
157<tr>
158<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
159<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--min-ptime" title="The “min-ptime” property">min-ptime</a></td>
160<td class="property_flags">Read / Write</td>
161</tr>
162<tr>
163<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
164<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--mtu" title="The “mtu” property">mtu</a></td>
165<td class="property_flags">Read / Write</td>
166</tr>
167<tr>
168<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
169<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--onvif-no-rate-control" title="The “onvif-no-rate-control” property">onvif-no-rate-control</a></td>
170<td class="property_flags">Read / Write</td>
171</tr>
172<tr>
173<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
174<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--perfect-rtptime" title="The “perfect-rtptime” property">perfect-rtptime</a></td>
175<td class="property_flags">Read / Write</td>
176</tr>
177<tr>
178<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
179<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--pt" title="The “pt” property">pt</a></td>
180<td class="property_flags">Read / Write</td>
181</tr>
182<tr>
183<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
184<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--ptime-multiple" title="The “ptime-multiple” property">ptime-multiple</a></td>
185<td class="property_flags">Read / Write</td>
186</tr>
187<tr>
188<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
189<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--seqnum" title="The “seqnum” property">seqnum</a></td>
190<td class="property_flags">Read</td>
191</tr>
192<tr>
193<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
194<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--seqnum-offset" title="The “seqnum-offset” property">seqnum-offset</a></td>
195<td class="property_flags">Read / Write</td>
196</tr>
197<tr>
198<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
199<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--source-info" title="The “source-info” property">source-info</a></td>
200<td class="property_flags">Read / Write</td>
201</tr>
202<tr>
203<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
204<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--ssrc" title="The “ssrc” property">ssrc</a></td>
205<td class="property_flags">Read / Write</td>
206</tr>
207<tr>
208<td class="property_type">
209<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *</td>
210<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--stats" title="The “stats” property">stats</a></td>
211<td class="property_flags">Read</td>
212</tr>
213<tr>
214<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
215<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--timestamp" title="The “timestamp” property">timestamp</a></td>
216<td class="property_flags">Read</td>
217</tr>
218<tr>
219<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
220<td class="property_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--timestamp-offset" title="The “timestamp-offset” property">timestamp-offset</a></td>
221<td class="property_flags">Read / Write</td>
222</tr>
223</tbody>
224</table></div>
225</div>
226<div class="refsect1">
227<a name="GstRTPBasePayload.other"></a><h2>Types and Values</h2>
228<div class="informaltable"><table class="informaltable" width="100%" border="0">
229<colgroup>
230<col width="150px" class="name">
231<col class="description">
232</colgroup>
233<tbody>
234<tr>
235<td class="datatype_keyword">struct</td>
236<td class="function_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload-struct" title="struct GstRTPBasePayload">GstRTPBasePayload</a></td>
237</tr>
238<tr>
239<td class="datatype_keyword">struct</td>
240<td class="function_name"><a class="link" href="GstRTPBasePayload.html#GstRTPBasePayloadClass" title="struct GstRTPBasePayloadClass">GstRTPBasePayloadClass</a></td>
241</tr>
242</tbody>
243</table></div>
244</div>
245<div class="refsect1">
246<a name="GstRTPBasePayload.object-hierarchy"></a><h2>Object Hierarchy</h2>
247<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
248    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
249        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
250            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
251                <span class="lineart">╰──</span> GstRTPBasePayload
252                    <span class="lineart">╰──</span> <a class="link" href="GstRTPBaseAudioPayload.html" title="GstRTPBaseAudioPayload">GstRTPBaseAudioPayload</a>
253</pre>
254</div>
255<div class="refsect1">
256<a name="GstRTPBasePayload.includes"></a><h2>Includes</h2>
257<pre class="synopsis">#include &lt;gst/rtp/rtp.h&gt;
258</pre>
259</div>
260<div class="refsect1">
261<a name="GstRTPBasePayload.description"></a><h2>Description</h2>
262<p>Provides a base class for RTP payloaders</p>
263</div>
264<div class="refsect1">
265<a name="GstRTPBasePayload.functions_details"></a><h2>Functions</h2>
266<div class="refsect2">
267<a name="GST-RTP-BASE-PAYLOAD-MTU:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_MTU()</h3>
268<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_MTU(payload) (GST_RTP_BASE_PAYLOAD (payload)-&gt;mtu)
269</pre>
270<p>Get access to the configured MTU of <em class="parameter"><code>payload</code></em>
271.</p>
272<div class="refsect3">
273<a name="GST-RTP-BASE-PAYLOAD-MTU.parameters"></a><h4>Parameters</h4>
274<div class="informaltable"><table class="informaltable" width="100%" border="0">
275<colgroup>
276<col width="150px" class="parameters_name">
277<col class="parameters_description">
278<col width="200px" class="parameters_annotations">
279</colgroup>
280<tbody><tr>
281<td class="parameter_name"><p>payload</p></td>
282<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
283<td class="parameter_annotations"> </td>
284</tr></tbody>
285</table></div>
286</div>
287</div>
288<hr>
289<div class="refsect2">
290<a name="GST-RTP-BASE-PAYLOAD-PT:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_PT()</h3>
291<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_PT(payload)  (GST_RTP_BASE_PAYLOAD (payload)-&gt;pt)
292</pre>
293<p>Get access to the configured payload type of <em class="parameter"><code>payload</code></em>
294.</p>
295<div class="refsect3">
296<a name="GST-RTP-BASE-PAYLOAD-PT.parameters"></a><h4>Parameters</h4>
297<div class="informaltable"><table class="informaltable" width="100%" border="0">
298<colgroup>
299<col width="150px" class="parameters_name">
300<col class="parameters_description">
301<col width="200px" class="parameters_annotations">
302</colgroup>
303<tbody><tr>
304<td class="parameter_name"><p>payload</p></td>
305<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
306<td class="parameter_annotations"> </td>
307</tr></tbody>
308</table></div>
309</div>
310</div>
311<hr>
312<div class="refsect2">
313<a name="GST-RTP-BASE-PAYLOAD-SINKPAD:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_SINKPAD()</h3>
314<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_SINKPAD(payload) (GST_RTP_BASE_PAYLOAD (payload)-&gt;sinkpad)
315</pre>
316<p>Get access to the sinkpad of <em class="parameter"><code>payload</code></em>
317.</p>
318<div class="refsect3">
319<a name="GST-RTP-BASE-PAYLOAD-SINKPAD.parameters"></a><h4>Parameters</h4>
320<div class="informaltable"><table class="informaltable" width="100%" border="0">
321<colgroup>
322<col width="150px" class="parameters_name">
323<col class="parameters_description">
324<col width="200px" class="parameters_annotations">
325</colgroup>
326<tbody><tr>
327<td class="parameter_name"><p>payload</p></td>
328<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
329<td class="parameter_annotations"> </td>
330</tr></tbody>
331</table></div>
332</div>
333</div>
334<hr>
335<div class="refsect2">
336<a name="GST-RTP-BASE-PAYLOAD-SRCPAD:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_SRCPAD()</h3>
337<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_SRCPAD(payload)  (GST_RTP_BASE_PAYLOAD (payload)-&gt;srcpad)
338</pre>
339<p>Get access to the srcpad of <em class="parameter"><code>payload</code></em>
340.</p>
341<div class="refsect3">
342<a name="GST-RTP-BASE-PAYLOAD-SRCPAD.parameters"></a><h4>Parameters</h4>
343<div class="informaltable"><table class="informaltable" width="100%" border="0">
344<colgroup>
345<col width="150px" class="parameters_name">
346<col class="parameters_description">
347<col width="200px" class="parameters_annotations">
348</colgroup>
349<tbody><tr>
350<td class="parameter_name"><p>payload</p></td>
351<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
352<td class="parameter_annotations"> </td>
353</tr></tbody>
354</table></div>
355</div>
356</div>
357<hr>
358<div class="refsect2">
359<a name="gst-rtp-base-payload-is-filled"></a><h3>gst_rtp_base_payload_is_filled ()</h3>
360<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
361gst_rtp_base_payload_is_filled (<em class="parameter"><code><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
362                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>,
363                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> duration</code></em>);</pre>
364<p>Check if the packet with <em class="parameter"><code>size</code></em>
365 and <em class="parameter"><code>duration</code></em>
366 would exceed the configured
367maximum size.</p>
368<div class="refsect3">
369<a name="gst-rtp-base-payload-is-filled.parameters"></a><h4>Parameters</h4>
370<div class="informaltable"><table class="informaltable" width="100%" border="0">
371<colgroup>
372<col width="150px" class="parameters_name">
373<col class="parameters_description">
374<col width="200px" class="parameters_annotations">
375</colgroup>
376<tbody>
377<tr>
378<td class="parameter_name"><p>payload</p></td>
379<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
380<td class="parameter_annotations"> </td>
381</tr>
382<tr>
383<td class="parameter_name"><p>size</p></td>
384<td class="parameter_description"><p>the size of the packet</p></td>
385<td class="parameter_annotations"> </td>
386</tr>
387<tr>
388<td class="parameter_name"><p>duration</p></td>
389<td class="parameter_description"><p>the duration of the packet</p></td>
390<td class="parameter_annotations"> </td>
391</tr>
392</tbody>
393</table></div>
394</div>
395<div class="refsect3">
396<a name="gst-rtp-base-payload-is-filled.returns"></a><h4>Returns</h4>
397<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the packet of <em class="parameter"><code>size</code></em>
398and <em class="parameter"><code>duration</code></em>
399would exceed the
400configured MTU or max_ptime.</p>
401</div>
402</div>
403<hr>
404<div class="refsect2">
405<a name="gst-rtp-base-payload-push"></a><h3>gst_rtp_base_payload_push ()</h3>
406<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
407gst_rtp_base_payload_push (<em class="parameter"><code><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
408                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
409<p>Push <em class="parameter"><code>buffer</code></em>
410 to the peer element of the payloader. The SSRC, payload type,
411seqnum and timestamp of the RTP buffer will be updated first.</p>
412<p>This function takes ownership of <em class="parameter"><code>buffer</code></em>
413.</p>
414<div class="refsect3">
415<a name="gst-rtp-base-payload-push.parameters"></a><h4>Parameters</h4>
416<div class="informaltable"><table class="informaltable" width="100%" border="0">
417<colgroup>
418<col width="150px" class="parameters_name">
419<col class="parameters_description">
420<col width="200px" class="parameters_annotations">
421</colgroup>
422<tbody>
423<tr>
424<td class="parameter_name"><p>payload</p></td>
425<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
426<td class="parameter_annotations"> </td>
427</tr>
428<tr>
429<td class="parameter_name"><p>buffer</p></td>
430<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a></p></td>
431<td class="parameter_annotations"> </td>
432</tr>
433</tbody>
434</table></div>
435</div>
436<div class="refsect3">
437<a name="gst-rtp-base-payload-push.returns"></a><h4>Returns</h4>
438<p> a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>.</p>
439</div>
440</div>
441<hr>
442<div class="refsect2">
443<a name="gst-rtp-base-payload-push-list"></a><h3>gst_rtp_base_payload_push_list ()</h3>
444<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
445gst_rtp_base_payload_push_list (<em class="parameter"><code><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
446                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBufferList.html#GstBufferList-struct"><span class="type">GstBufferList</span></a> *list</code></em>);</pre>
447<p>Push <em class="parameter"><code>list</code></em>
448 to the peer element of the payloader. The SSRC, payload type,
449seqnum and timestamp of the RTP buffer will be updated first.</p>
450<p>This function takes ownership of <em class="parameter"><code>list</code></em>
451.</p>
452<div class="refsect3">
453<a name="gst-rtp-base-payload-push-list.parameters"></a><h4>Parameters</h4>
454<div class="informaltable"><table class="informaltable" width="100%" border="0">
455<colgroup>
456<col width="150px" class="parameters_name">
457<col class="parameters_description">
458<col width="200px" class="parameters_annotations">
459</colgroup>
460<tbody>
461<tr>
462<td class="parameter_name"><p>payload</p></td>
463<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
464<td class="parameter_annotations"> </td>
465</tr>
466<tr>
467<td class="parameter_name"><p>list</p></td>
468<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBufferList.html#GstBufferList-struct"><span class="type">GstBufferList</span></a></p></td>
469<td class="parameter_annotations"> </td>
470</tr>
471</tbody>
472</table></div>
473</div>
474<div class="refsect3">
475<a name="gst-rtp-base-payload-push-list.returns"></a><h4>Returns</h4>
476<p> a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>.</p>
477</div>
478</div>
479<hr>
480<div class="refsect2">
481<a name="gst-rtp-base-payload-set-options"></a><h3>gst_rtp_base_payload_set_options ()</h3>
482<pre class="programlisting"><span class="returnvalue">void</span>
483gst_rtp_base_payload_set_options (<em class="parameter"><code><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
484                                  <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *media</code></em>,
485                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dynamic</code></em>,
486                                  <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *encoding_name</code></em>,
487                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> clock_rate</code></em>);</pre>
488<p>Set the rtp options of the payloader. These options will be set in the caps
489of the payloader. Subclasses must call this method before calling
490<a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-push" title="gst_rtp_base_payload_push ()"><code class="function">gst_rtp_base_payload_push()</code></a> or <a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-set-outcaps" title="gst_rtp_base_payload_set_outcaps ()"><code class="function">gst_rtp_base_payload_set_outcaps()</code></a>.</p>
491<div class="refsect3">
492<a name="gst-rtp-base-payload-set-options.parameters"></a><h4>Parameters</h4>
493<div class="informaltable"><table class="informaltable" width="100%" border="0">
494<colgroup>
495<col width="150px" class="parameters_name">
496<col class="parameters_description">
497<col width="200px" class="parameters_annotations">
498</colgroup>
499<tbody>
500<tr>
501<td class="parameter_name"><p>payload</p></td>
502<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
503<td class="parameter_annotations"> </td>
504</tr>
505<tr>
506<td class="parameter_name"><p>media</p></td>
507<td class="parameter_description"><p>the media type (typically "audio" or "video")</p></td>
508<td class="parameter_annotations"> </td>
509</tr>
510<tr>
511<td class="parameter_name"><p>dynamic</p></td>
512<td class="parameter_description"><p>if the payload type is dynamic</p></td>
513<td class="parameter_annotations"> </td>
514</tr>
515<tr>
516<td class="parameter_name"><p>encoding_name</p></td>
517<td class="parameter_description"><p>the encoding name</p></td>
518<td class="parameter_annotations"> </td>
519</tr>
520<tr>
521<td class="parameter_name"><p>clock_rate</p></td>
522<td class="parameter_description"><p>the clock rate of the media</p></td>
523<td class="parameter_annotations"> </td>
524</tr>
525</tbody>
526</table></div>
527</div>
528</div>
529<hr>
530<div class="refsect2">
531<a name="gst-rtp-base-payload-set-outcaps"></a><h3>gst_rtp_base_payload_set_outcaps ()</h3>
532<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
533gst_rtp_base_payload_set_outcaps (<em class="parameter"><code><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
534                                  <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>,
535                                  <em class="parameter"><code>...</code></em>);</pre>
536<p>Configure the output caps with the optional parameters.</p>
537<p>Variable arguments should be in the form field name, field type
538(as a GType), value(s).  The last variable argument should be NULL.</p>
539<div class="refsect3">
540<a name="gst-rtp-base-payload-set-outcaps.parameters"></a><h4>Parameters</h4>
541<div class="informaltable"><table class="informaltable" width="100%" border="0">
542<colgroup>
543<col width="150px" class="parameters_name">
544<col class="parameters_description">
545<col width="200px" class="parameters_annotations">
546</colgroup>
547<tbody>
548<tr>
549<td class="parameter_name"><p>payload</p></td>
550<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
551<td class="parameter_annotations"> </td>
552</tr>
553<tr>
554<td class="parameter_name"><p>fieldname</p></td>
555<td class="parameter_description"><p>the first field name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
556<td class="parameter_annotations"> </td>
557</tr>
558<tr>
559<td class="parameter_name"><p>...</p></td>
560<td class="parameter_description"><p>field values</p></td>
561<td class="parameter_annotations"> </td>
562</tr>
563</tbody>
564</table></div>
565</div>
566<div class="refsect3">
567<a name="gst-rtp-base-payload-set-outcaps.returns"></a><h4>Returns</h4>
568<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the caps could be set.</p>
569</div>
570</div>
571<hr>
572<div class="refsect2">
573<a name="gst-rtp-base-payload-allocate-output-buffer"></a><h3>gst_rtp_base_payload_allocate_output_buffer ()</h3>
574<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> *
575gst_rtp_base_payload_allocate_output_buffer
576                               (<em class="parameter"><code><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
577                                <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>,
578                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> pad_len</code></em>,
579                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> csrc_count</code></em>);</pre>
580<p>Allocate a new <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> with enough data to hold an RTP packet with
581minimum <em class="parameter"><code>csrc_count</code></em>
582 CSRCs, a payload length of <em class="parameter"><code>payload_len</code></em>
583 and padding of
584<em class="parameter"><code>pad_len</code></em>
585. If <em class="parameter"><code>payload</code></em>
586 has <a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--source-info" title="The “source-info” property"><span class="type">“source-info”</span></a> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> additional
587CSRCs may be allocated and filled with RTP source information.</p>
588<div class="refsect3">
589<a name="gst-rtp-base-payload-allocate-output-buffer.parameters"></a><h4>Parameters</h4>
590<div class="informaltable"><table class="informaltable" width="100%" border="0">
591<colgroup>
592<col width="150px" class="parameters_name">
593<col class="parameters_description">
594<col width="200px" class="parameters_annotations">
595</colgroup>
596<tbody>
597<tr>
598<td class="parameter_name"><p>payload</p></td>
599<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
600<td class="parameter_annotations"> </td>
601</tr>
602<tr>
603<td class="parameter_name"><p>payload_len</p></td>
604<td class="parameter_description"><p>the length of the payload</p></td>
605<td class="parameter_annotations"> </td>
606</tr>
607<tr>
608<td class="parameter_name"><p>pad_len</p></td>
609<td class="parameter_description"><p>the amount of padding</p></td>
610<td class="parameter_annotations"> </td>
611</tr>
612<tr>
613<td class="parameter_name"><p>csrc_count</p></td>
614<td class="parameter_description"><p>the minimum number of CSRC entries</p></td>
615<td class="parameter_annotations"> </td>
616</tr>
617</tbody>
618</table></div>
619</div>
620<div class="refsect3">
621<a name="gst-rtp-base-payload-allocate-output-buffer.returns"></a><h4>Returns</h4>
622<p> A newly allocated buffer that can hold an RTP packet with given
623parameters.</p>
624</div>
625<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p>
626</div>
627<hr>
628<div class="refsect2">
629<a name="gst-rtp-base-payload-get-source-count"></a><h3>gst_rtp_base_payload_get_source_count ()</h3>
630<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
631gst_rtp_base_payload_get_source_count (<em class="parameter"><code><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
632                                       <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
633<p>Count the total number of RTP sources found in the meta of <em class="parameter"><code>buffer</code></em>
634, which
635will be automically added by <a class="link" href="GstRTPBasePayload.html#gst-rtp-base-payload-allocate-output-buffer" title="gst_rtp_base_payload_allocate_output_buffer ()"><code class="function">gst_rtp_base_payload_allocate_output_buffer()</code></a>.
636If <a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--source-info" title="The “source-info” property"><span class="type">“source-info”</span></a> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> the count will be 0.</p>
637<div class="refsect3">
638<a name="gst-rtp-base-payload-get-source-count.parameters"></a><h4>Parameters</h4>
639<div class="informaltable"><table class="informaltable" width="100%" border="0">
640<colgroup>
641<col width="150px" class="parameters_name">
642<col class="parameters_description">
643<col width="200px" class="parameters_annotations">
644</colgroup>
645<tbody>
646<tr>
647<td class="parameter_name"><p>payload</p></td>
648<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
649<td class="parameter_annotations"> </td>
650</tr>
651<tr>
652<td class="parameter_name"><p>buffer</p></td>
653<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a>, typically the buffer to payload. </p></td>
654<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
655</tr>
656</tbody>
657</table></div>
658</div>
659<div class="refsect3">
660<a name="gst-rtp-base-payload-get-source-count.returns"></a><h4>Returns</h4>
661<p> The number of sources.</p>
662</div>
663<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p>
664</div>
665<hr>
666<div class="refsect2">
667<a name="gst-rtp-base-payload-is-source-info-enabled"></a><h3>gst_rtp_base_payload_is_source_info_enabled ()</h3>
668<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
669gst_rtp_base_payload_is_source_info_enabled
670                               (<em class="parameter"><code><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>);</pre>
671<p>Queries whether the payloader will add contributing sources (CSRCs) to the
672RTP header from <a class="link" href="gst-plugins-base-libs-GstMeta-for-RTP.html#GstRTPSourceMeta" title="struct GstRTPSourceMeta"><span class="type">GstRTPSourceMeta</span></a>.</p>
673<div class="refsect3">
674<a name="gst-rtp-base-payload-is-source-info-enabled.parameters"></a><h4>Parameters</h4>
675<div class="informaltable"><table class="informaltable" width="100%" border="0">
676<colgroup>
677<col width="150px" class="parameters_name">
678<col class="parameters_description">
679<col width="200px" class="parameters_annotations">
680</colgroup>
681<tbody><tr>
682<td class="parameter_name"><p>payload</p></td>
683<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
684<td class="parameter_annotations"> </td>
685</tr></tbody>
686</table></div>
687</div>
688<div class="refsect3">
689<a name="gst-rtp-base-payload-is-source-info-enabled.returns"></a><h4>Returns</h4>
690<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if source-info is enabled.</p>
691</div>
692<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p>
693</div>
694<hr>
695<div class="refsect2">
696<a name="gst-rtp-base-payload-set-source-info-enabled"></a><h3>gst_rtp_base_payload_set_source_info_enabled ()</h3>
697<pre class="programlisting"><span class="returnvalue">void</span>
698gst_rtp_base_payload_set_source_info_enabled
699                               (<em class="parameter"><code><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
700                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);</pre>
701<p>Enable or disable adding contributing sources to RTP packets from
702<a class="link" href="gst-plugins-base-libs-GstMeta-for-RTP.html#GstRTPSourceMeta" title="struct GstRTPSourceMeta"><span class="type">GstRTPSourceMeta</span></a>.</p>
703<div class="refsect3">
704<a name="gst-rtp-base-payload-set-source-info-enabled.parameters"></a><h4>Parameters</h4>
705<div class="informaltable"><table class="informaltable" width="100%" border="0">
706<colgroup>
707<col width="150px" class="parameters_name">
708<col class="parameters_description">
709<col width="200px" class="parameters_annotations">
710</colgroup>
711<tbody>
712<tr>
713<td class="parameter_name"><p>payload</p></td>
714<td class="parameter_description"><p>a <a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
715<td class="parameter_annotations"> </td>
716</tr>
717<tr>
718<td class="parameter_name"><p>enable</p></td>
719<td class="parameter_description"><p>whether to add contributing sources to RTP packets</p></td>
720<td class="parameter_annotations"> </td>
721</tr>
722</tbody>
723</table></div>
724</div>
725<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p>
726</div>
727</div>
728<div class="refsect1">
729<a name="GstRTPBasePayload.other_details"></a><h2>Types and Values</h2>
730<div class="refsect2">
731<a name="GstRTPBasePayload-struct"></a><h3>struct GstRTPBasePayload</h3>
732<pre class="programlisting">struct GstRTPBasePayload;</pre>
733</div>
734<hr>
735<div class="refsect2">
736<a name="GstRTPBasePayloadClass"></a><h3>struct GstRTPBasePayloadClass</h3>
737<pre class="programlisting">struct GstRTPBasePayloadClass {
738  GstElementClass parent_class;
739
740  /* query accepted caps */
741  GstCaps *     (*get_caps)             (GstRTPBasePayload *payload, GstPad * pad, GstCaps * filter);
742  /* receive caps on the sink pad, configure the payloader. */
743  gboolean      (*set_caps)             (GstRTPBasePayload *payload, GstCaps *caps);
744
745  /* handle a buffer, perform 0 or more gst_rtp_base_payload_push() on
746   * the RTP buffers. This function takes ownership of the buffer. */
747  GstFlowReturn (*handle_buffer)        (GstRTPBasePayload *payload,
748                                         GstBuffer *buffer);
749  /* handle events and queries */
750  gboolean      (*sink_event)           (GstRTPBasePayload *payload, GstEvent * event);
751  gboolean      (*src_event)            (GstRTPBasePayload *payload, GstEvent * event);
752  gboolean      (*query)                (GstRTPBasePayload *payload, GstPad *pad, GstQuery * query);
753};
754</pre>
755<p>Base class for audio RTP payloader.</p>
756<div class="refsect3">
757<a name="GstRTPBasePayloadClass.members"></a><h4>Members</h4>
758<div class="informaltable"><table class="informaltable" width="100%" border="0">
759<colgroup>
760<col width="300px" class="struct_members_name">
761<col class="struct_members_description">
762<col width="200px" class="struct_members_annotations">
763</colgroup>
764<tbody>
765<tr>
766<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.get-caps"></a>get_caps</code></em> ()</p></td>
767<td class="struct_member_description"><p>get desired caps</p></td>
768<td class="struct_member_annotations"> </td>
769</tr>
770<tr>
771<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.set-caps"></a>set_caps</code></em> ()</p></td>
772<td class="struct_member_description"><p>configure the payloader</p></td>
773<td class="struct_member_annotations"> </td>
774</tr>
775<tr>
776<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.handle-buffer"></a>handle_buffer</code></em> ()</p></td>
777<td class="struct_member_description"><p>process data</p></td>
778<td class="struct_member_annotations"> </td>
779</tr>
780<tr>
781<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.sink-event"></a>sink_event</code></em> ()</p></td>
782<td class="struct_member_description"><p>custom event handling on the sinkpad</p></td>
783<td class="struct_member_annotations"> </td>
784</tr>
785<tr>
786<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.src-event"></a>src_event</code></em> ()</p></td>
787<td class="struct_member_description"><p>custom event handling on the srcpad</p></td>
788<td class="struct_member_annotations"> </td>
789</tr>
790<tr>
791<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.query"></a>query</code></em> ()</p></td>
792<td class="struct_member_description"><p>custom query handling</p></td>
793<td class="struct_member_annotations"> </td>
794</tr>
795</tbody>
796</table></div>
797</div>
798</div>
799</div>
800<div class="refsect1">
801<a name="GstRTPBasePayload.property-details"></a><h2>Property Details</h2>
802<div class="refsect2">
803<a name="GstRTPBasePayload--max-ptime"></a><h3>The <code class="literal">“max-ptime”</code> property</h3>
804<pre class="programlisting">  “max-ptime”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
805<p>Maximum duration of the packet data in ns (-1 = unlimited up to MTU).</p>
806<p>Flags: Read / Write</p>
807<p>Allowed values: &gt;= -1</p>
808<p>Default value: -1</p>
809</div>
810<hr>
811<div class="refsect2">
812<a name="GstRTPBasePayload--min-ptime"></a><h3>The <code class="literal">“min-ptime”</code> property</h3>
813<pre class="programlisting">  “min-ptime”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
814<p>Minimum duration of the packet data in ns (can't go above MTU)</p>
815<p>Flags: Read / Write</p>
816<p>Allowed values: &gt;= 0</p>
817<p>Default value: 0</p>
818</div>
819<hr>
820<div class="refsect2">
821<a name="GstRTPBasePayload--mtu"></a><h3>The <code class="literal">“mtu”</code> property</h3>
822<pre class="programlisting">  “mtu”                      <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
823<p>Maximum size of one packet.</p>
824<p>Flags: Read / Write</p>
825<p>Allowed values: &gt;= 28</p>
826<p>Default value: 1400</p>
827</div>
828<hr>
829<div class="refsect2">
830<a name="GstRTPBasePayload--onvif-no-rate-control"></a><h3>The <code class="literal">“onvif-no-rate-control”</code> property</h3>
831<pre class="programlisting">  “onvif-no-rate-control”    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
832<p>Make the payloader timestamp packets according to the Rate-Control=no
833behaviour specified in the ONVIF replay spec.</p>
834<p>Flags: Read / Write</p>
835<p>Default value: FALSE</p>
836<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p>
837</div>
838<hr>
839<div class="refsect2">
840<a name="GstRTPBasePayload--perfect-rtptime"></a><h3>The <code class="literal">“perfect-rtptime”</code> property</h3>
841<pre class="programlisting">  “perfect-rtptime”          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
842<p>Try to use the offset fields to generate perfect RTP timestamps. When this
843option is disabled, RTP timestamps are generated from GST_BUFFER_PTS of
844each payloaded buffer. The PTSes of buffers may not necessarily increment
845with the amount of data in each input buffer, consider e.g. the case where
846the buffer arrives from a network which means that the PTS is unrelated to
847the amount of data. Because the RTP timestamps are generated from
848GST_BUFFER_PTS this can result in RTP timestamps that also don't increment
849with the amount of data in the payloaded packet. To circumvent this it is
850possible to set the perfect rtptime option enabled. When this option is
851enabled the payloader will increment the RTP timestamps based on
852GST_BUFFER_OFFSET which relates to the amount of data in each packet
853rather than the GST_BUFFER_PTS of each buffer and therefore the RTP
854timestamps will more closely correlate with the amount of data in each
855buffer. Currently GstRTPBasePayload is limited to handling perfect RTP
856timestamps for audio streams.</p>
857<p>Flags: Read / Write</p>
858<p>Default value: TRUE</p>
859</div>
860<hr>
861<div class="refsect2">
862<a name="GstRTPBasePayload--pt"></a><h3>The <code class="literal">“pt”</code> property</h3>
863<pre class="programlisting">  “pt”                       <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
864<p>The payload type of the packets.</p>
865<p>Flags: Read / Write</p>
866<p>Allowed values: &lt;= 127</p>
867<p>Default value: 96</p>
868</div>
869<hr>
870<div class="refsect2">
871<a name="GstRTPBasePayload--ptime-multiple"></a><h3>The <code class="literal">“ptime-multiple”</code> property</h3>
872<pre class="programlisting">  “ptime-multiple”           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
873<p>Force buffers to be multiples of this duration in ns (0 disables)</p>
874<p>Flags: Read / Write</p>
875<p>Allowed values: &gt;= 0</p>
876<p>Default value: 0</p>
877</div>
878<hr>
879<div class="refsect2">
880<a name="GstRTPBasePayload--seqnum"></a><h3>The <code class="literal">“seqnum”</code> property</h3>
881<pre class="programlisting">  “seqnum”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
882<p>The RTP sequence number of the last processed packet.</p>
883<p>Flags: Read</p>
884<p>Allowed values: &lt;= 65535</p>
885<p>Default value: 0</p>
886</div>
887<hr>
888<div class="refsect2">
889<a name="GstRTPBasePayload--seqnum-offset"></a><h3>The <code class="literal">“seqnum-offset”</code> property</h3>
890<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>
891<p>Offset to add to all outgoing seqnum (-1 = random).</p>
892<p>Flags: Read / Write</p>
893<p>Allowed values: [-1,65535]</p>
894<p>Default value: -1</p>
895</div>
896<hr>
897<div class="refsect2">
898<a name="GstRTPBasePayload--source-info"></a><h3>The <code class="literal">“source-info”</code> property</h3>
899<pre class="programlisting">  “source-info”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
900<p>Enable writing the CSRC field in allocated RTP header based on RTP source
901information found in the input buffer's <a class="link" href="gst-plugins-base-libs-GstMeta-for-RTP.html#GstRTPSourceMeta" title="struct GstRTPSourceMeta"><span class="type">GstRTPSourceMeta</span></a>.</p>
902<p>Flags: Read / Write</p>
903<p>Default value: FALSE</p>
904<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p>
905</div>
906<hr>
907<div class="refsect2">
908<a name="GstRTPBasePayload--ssrc"></a><h3>The <code class="literal">“ssrc”</code> property</h3>
909<pre class="programlisting">  “ssrc”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
910<p>The SSRC of the packets (default == random).</p>
911<p>Flags: Read / Write</p>
912<p>Default value: 4294967295</p>
913</div>
914<hr>
915<div class="refsect2">
916<a name="GstRTPBasePayload--stats"></a><h3>The <code class="literal">“stats”</code> property</h3>
917<pre class="programlisting">  “stats”                    <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *</pre>
918<p>Various payloader statistics retrieved atomically (and are therefore
919synchroized with each other), these can be used e.g. to generate an
920RTP-Info header. This property return a GstStructure named
921application/x-rtp-payload-stats containing the following fields relating to
922the last processed buffer and current state of the stream being payloaded:</p>
923<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
924<li class="listitem"><p><code class="literal">clock-rate</code> :<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-UINT:CAPS"><span class="type">G_TYPE_UINT</span></a>, clock-rate of the stream</p></li>
925<li class="listitem"><p><code class="literal">running-time</code> :<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-UINT64:CAPS"><span class="type">G_TYPE_UINT64</span></a>, running time</p></li>
926<li class="listitem"><p><code class="literal">seqnum</code> :<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-UINT:CAPS"><span class="type">G_TYPE_UINT</span></a>, sequence number, same as <a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--seqnum" title="The “seqnum” property"><span class="type">“seqnum”</span></a></p></li>
927<li class="listitem"><p><code class="literal">timestamp</code> :<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-UINT:CAPS"><span class="type">G_TYPE_UINT</span></a>, RTP timestamp, same as <a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--timestamp" title="The “timestamp” property"><span class="type">“timestamp”</span></a></p></li>
928<li class="listitem"><p><code class="literal">ssrc</code> :<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-UINT:CAPS"><span class="type">G_TYPE_UINT</span></a>, The SSRC in use</p></li>
929<li class="listitem"><p><code class="literal">pt</code> :<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-UINT:CAPS"><span class="type">G_TYPE_UINT</span></a>, The Payload type in use, same as <a class="link" href="GstRTPBasePayload.html#GstRTPBasePayload--pt" title="The “pt” property"><span class="type">“pt”</span></a></p></li>
930<li class="listitem"><p><code class="literal">seqnum-offset</code> :<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-UINT:CAPS"><span class="type">G_TYPE_UINT</span></a>, The current offset added to the seqnum</p></li>
931<li class="listitem"><p><code class="literal">timestamp-offset</code> :<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-UINT:CAPS"><span class="type">G_TYPE_UINT</span></a>, The current offset added to the timestamp</p></li>
932</ul></div>
933<p>Flags: Read</p>
934</div>
935<hr>
936<div class="refsect2">
937<a name="GstRTPBasePayload--timestamp"></a><h3>The <code class="literal">“timestamp”</code> property</h3>
938<pre class="programlisting">  “timestamp”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
939<p>The RTP timestamp of the last processed packet.</p>
940<p>Flags: Read</p>
941<p>Default value: 0</p>
942</div>
943<hr>
944<div class="refsect2">
945<a name="GstRTPBasePayload--timestamp-offset"></a><h3>The <code class="literal">“timestamp-offset”</code> property</h3>
946<pre class="programlisting">  “timestamp-offset”         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
947<p>Offset to add to all outgoing timestamps (default = random).</p>
948<p>Flags: Read / Write</p>
949<p>Default value: 4294967295</p>
950</div>
951</div>
952</div>
953<div class="footer">
954<hr>Generated by GTK-Doc V1.28</div>
955</body>
956</html>