37
31
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstrtpbasepayload.top_of_page"></a>gstrtpbasepayload</span></h2>
38
32
<p>gstrtpbasepayload — Base class for RTP payloader</p>
40
<td valign="top" align="right"></td>
34
<td class="gallery_image" valign="top" align="right"></td>
41
35
</tr></table></div>
42
<div class="refsynopsisdiv">
43
<a name="gst-plugins-base-libs-gstrtpbasepayload.synopsis"></a><h2>Synopsis</h2>
44
<a name="GstRTPBasePayload"></a><pre class="synopsis">
45
#include <gst/rtp/gstrtpbasepayload.h>
47
struct <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload-struct" title="struct GstRTPBasePayload">GstRTPBasePayload</a>;
48
struct <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayloadClass" title="struct GstRTPBasePayloadClass">GstRTPBasePayloadClass</a>;
49
#define <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GST-RTP-BASE-PAYLOAD-MTU:CAPS" title="GST_RTP_BASE_PAYLOAD_MTU()">GST_RTP_BASE_PAYLOAD_MTU</a> (payload)
50
#define <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GST-RTP-BASE-PAYLOAD-PT:CAPS" title="GST_RTP_BASE_PAYLOAD_PT()">GST_RTP_BASE_PAYLOAD_PT</a> (payload)
51
#define <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GST-RTP-BASE-PAYLOAD-SINKPAD:CAPS" title="GST_RTP_BASE_PAYLOAD_SINKPAD()">GST_RTP_BASE_PAYLOAD_SINKPAD</a> (payload)
52
#define <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GST-RTP-BASE-PAYLOAD-SRCPAD:CAPS" title="GST_RTP_BASE_PAYLOAD_SRCPAD()">GST_RTP_BASE_PAYLOAD_SRCPAD</a> (payload)
53
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#gst-rtp-base-payload-is-filled" title="gst_rtp_base_payload_is_filled ()">gst_rtp_base_payload_is_filled</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
54
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>,
55
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> duration</code></em>);
56
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#gst-rtp-base-payload-push" title="gst_rtp_base_payload_push ()">gst_rtp_base_payload_push</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
57
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);
58
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#gst-rtp-base-payload-push-list" title="gst_rtp_base_payload_push_list ()">gst_rtp_base_payload_push_list</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
59
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBufferList.html#GstBufferList"><span class="type">GstBufferList</span></a> *list</code></em>);
60
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#gst-rtp-base-payload-set-options" title="gst_rtp_base_payload_set_options ()">gst_rtp_base_payload_set_options</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
61
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *media</code></em>,
62
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dynamic</code></em>,
63
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *encoding_name</code></em>,
64
<em class="parameter"><code><span class="type">guint32</span> clock_rate</code></em>);
65
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#gst-rtp-base-payload-set-outcaps" title="gst_rtp_base_payload_set_outcaps ()">gst_rtp_base_payload_set_outcaps</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
66
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>,
67
<em class="parameter"><code>...</code></em>);
36
<div class="refsect1">
37
<a name="gst-plugins-base-libs-gstrtpbasepayload.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table width="100%" border="0">
40
<col width="150px" class="functions_return">
41
<col class="functions_name">
45
<td class="define_keyword">#define</td>
46
<td class="function_name">
47
<a class="link" href="gst-plugins-base-libs-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>
51
<td class="define_keyword">#define</td>
52
<td class="function_name">
53
<a class="link" href="gst-plugins-base-libs-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>
57
<td class="define_keyword">#define</td>
58
<td class="function_name">
59
<a class="link" href="gst-plugins-base-libs-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>
63
<td class="define_keyword">#define</td>
64
<td class="function_name">
65
<a class="link" href="gst-plugins-base-libs-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>
69
<td class="function_type">
70
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
72
<td class="function_name">
73
<a class="link" href="gst-plugins-base-libs-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>
77
<td class="function_type">
78
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
80
<td class="function_name">
81
<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#gst-rtp-base-payload-push" title="gst_rtp_base_payload_push ()">gst_rtp_base_payload_push</a> <span class="c_punctuation">()</span>
85
<td class="function_type">
86
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
88
<td class="function_name">
89
<a class="link" href="gst-plugins-base-libs-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>
93
<td class="function_type">
94
<span class="returnvalue">void</span>
96
<td class="function_name">
97
<a class="link" href="gst-plugins-base-libs-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>
101
<td class="function_type">
102
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
104
<td class="function_name">
105
<a class="link" href="gst-plugins-base-libs-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>
111
<div class="refsect1">
112
<a name="gst-plugins-base-libs-gstrtpbasepayload.properties"></a><h2>Properties</h2>
113
<div class="informaltable"><table border="0">
115
<col width="150px" class="properties_type">
116
<col width="300px" class="properties_name">
117
<col width="200px" class="properties_flags">
121
<td class="property_type"><span class="type">gint64</span></td>
122
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--max-ptime" title="The “max-ptime” property">max-ptime</a></td>
123
<td class="property_flags">Read / Write</td>
126
<td class="property_type"><span class="type">gint64</span></td>
127
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--min-ptime" title="The “min-ptime” property">min-ptime</a></td>
128
<td class="property_flags">Read / Write</td>
131
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
132
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--mtu" title="The “mtu” property">mtu</a></td>
133
<td class="property_flags">Read / Write</td>
136
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
137
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--perfect-rtptime" title="The “perfect-rtptime” property">perfect-rtptime</a></td>
138
<td class="property_flags">Read / Write</td>
141
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
142
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--pt" title="The “pt” property">pt</a></td>
143
<td class="property_flags">Read / Write</td>
146
<td class="property_type"><span class="type">gint64</span></td>
147
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--ptime-multiple" title="The “ptime-multiple” property">ptime-multiple</a></td>
148
<td class="property_flags">Read / Write</td>
151
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
152
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--seqnum" title="The “seqnum” property">seqnum</a></td>
153
<td class="property_flags">Read</td>
156
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
157
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--seqnum-offset" title="The “seqnum-offset” property">seqnum-offset</a></td>
158
<td class="property_flags">Read / Write</td>
161
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
162
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--ssrc" title="The “ssrc” property">ssrc</a></td>
163
<td class="property_flags">Read / Write</td>
166
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
167
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--timestamp" title="The “timestamp” property">timestamp</a></td>
168
<td class="property_flags">Read</td>
171
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
172
<td class="property_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--timestamp-offset" title="The “timestamp-offset” property">timestamp-offset</a></td>
173
<td class="property_flags">Read / Write</td>
178
<a name="GstRTPBasePayload"></a><div class="refsect1">
179
<a name="gst-plugins-base-libs-gstrtpbasepayload.other"></a><h2>Types and Values</h2>
180
<div class="informaltable"><table width="100%" border="0">
182
<col width="150px" class="name">
183
<col class="description">
187
<td class="datatype_keyword">struct</td>
188
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload-struct" title="struct GstRTPBasePayload">GstRTPBasePayload</a></td>
191
<td class="datatype_keyword">struct</td>
192
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayloadClass" title="struct GstRTPBasePayloadClass">GstRTPBasePayloadClass</a></td>
70
197
<div class="refsect1">
71
198
<a name="gst-plugins-base-libs-gstrtpbasepayload.object-hierarchy"></a><h2>Object Hierarchy</h2>
72
<pre class="synopsis">
73
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
74
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
75
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
76
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
77
+----GstRTPBasePayload
78
+----<a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload">GstRTPBaseAudioPayload</a>
199
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
200
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
201
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
202
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
203
<span class="lineart">╰──</span> GstRTPBasePayload
204
<span class="lineart">╰──</span> <a class="link" href="gst-plugins-base-libs-gstrtpbaseaudiopayload.html#GstRTPBaseAudioPayload">GstRTPBaseAudioPayload</a>
81
207
<div class="refsect1">
82
<a name="gst-plugins-base-libs-gstrtpbasepayload.properties"></a><h2>Properties</h2>
83
<pre class="synopsis">
84
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--max-ptime" title='The "max-ptime" property'>max-ptime</a>" <span class="type">gint64</span> : Read / Write
85
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--min-ptime" title='The "min-ptime" property'>min-ptime</a>" <span class="type">gint64</span> : Read / Write
86
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--mtu" title='The "mtu" property'>mtu</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
87
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--perfect-rtptime" title='The "perfect-rtptime" property'>perfect-rtptime</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
88
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--pt" title='The "pt" property'>pt</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
89
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--ptime-multiple" title='The "ptime-multiple" property'>ptime-multiple</a>" <span class="type">gint64</span> : Read / Write
90
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--seqnum" title='The "seqnum" property'>seqnum</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read
91
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--seqnum-offset" title='The "seqnum-offset" property'>seqnum-offset</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
92
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--ssrc" title='The "ssrc" property'>ssrc</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
93
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--timestamp" title='The "timestamp" property'>timestamp</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read
94
"<a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload--timestamp-offset" title='The "timestamp-offset" property'>timestamp-offset</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
208
<a name="gst-plugins-base-libs-gstrtpbasepayload.includes"></a><h2>Includes</h2>
209
<pre class="synopsis">#include <gst/rtp/gstrtpbasepayload.h>
97
212
<div class="refsect1">
98
213
<a name="gst-plugins-base-libs-gstrtpbasepayload.description"></a><h2>Description</h2>
100
Provides a base class for RTP payloaders
103
<div class="refsect1">
104
<a name="gst-plugins-base-libs-gstrtpbasepayload.details"></a><h2>Details</h2>
214
<p>Provides a base class for RTP payloaders</p>
216
<div class="refsect1">
217
<a name="gst-plugins-base-libs-gstrtpbasepayload.functions_details"></a><h2>Functions</h2>
218
<div class="refsect2">
219
<a name="GST-RTP-BASE-PAYLOAD-MTU:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_MTU()</h3>
220
<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_MTU(payload) (GST_RTP_BASE_PAYLOAD (payload)->mtu)
222
<p>Get access to the configured MTU of <em class="parameter"><code>payload</code></em>
224
<div class="refsect3">
225
<a name="id-1.2.9.5.10.2.5"></a><h4>Parameters</h4>
226
<div class="informaltable"><table width="100%" border="0">
228
<col width="150px" class="parameters_name">
229
<col class="parameters_description">
230
<col width="200px" class="parameters_annotations">
233
<td class="parameter_name"><p>payload</p></td>
234
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
235
<td class="parameter_annotations"> </td>
241
<div class="refsect2">
242
<a name="GST-RTP-BASE-PAYLOAD-PT:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_PT()</h3>
243
<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_PT(payload) (GST_RTP_BASE_PAYLOAD (payload)->pt)
245
<p>Get access to the configured payload type of <em class="parameter"><code>payload</code></em>
247
<div class="refsect3">
248
<a name="id-1.2.9.5.10.3.5"></a><h4>Parameters</h4>
249
<div class="informaltable"><table width="100%" border="0">
251
<col width="150px" class="parameters_name">
252
<col class="parameters_description">
253
<col width="200px" class="parameters_annotations">
256
<td class="parameter_name"><p>payload</p></td>
257
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
258
<td class="parameter_annotations"> </td>
264
<div class="refsect2">
265
<a name="GST-RTP-BASE-PAYLOAD-SINKPAD:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_SINKPAD()</h3>
266
<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_SINKPAD(payload) (GST_RTP_BASE_PAYLOAD (payload)->sinkpad)
268
<p>Get access to the sinkpad of <em class="parameter"><code>payload</code></em>
270
<div class="refsect3">
271
<a name="id-1.2.9.5.10.4.5"></a><h4>Parameters</h4>
272
<div class="informaltable"><table width="100%" border="0">
274
<col width="150px" class="parameters_name">
275
<col class="parameters_description">
276
<col width="200px" class="parameters_annotations">
279
<td class="parameter_name"><p>payload</p></td>
280
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
281
<td class="parameter_annotations"> </td>
287
<div class="refsect2">
288
<a name="GST-RTP-BASE-PAYLOAD-SRCPAD:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_SRCPAD()</h3>
289
<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_SRCPAD(payload) (GST_RTP_BASE_PAYLOAD (payload)->srcpad)
291
<p>Get access to the srcpad of <em class="parameter"><code>payload</code></em>
293
<div class="refsect3">
294
<a name="id-1.2.9.5.10.5.5"></a><h4>Parameters</h4>
295
<div class="informaltable"><table width="100%" border="0">
297
<col width="150px" class="parameters_name">
298
<col class="parameters_description">
299
<col width="200px" class="parameters_annotations">
302
<td class="parameter_name"><p>payload</p></td>
303
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
304
<td class="parameter_annotations"> </td>
310
<div class="refsect2">
311
<a name="gst-rtp-base-payload-is-filled"></a><h3>gst_rtp_base_payload_is_filled ()</h3>
312
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
313
gst_rtp_base_payload_is_filled (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
314
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>,
315
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> duration</code></em>);</pre>
316
<p>Check if the packet with <em class="parameter"><code>size</code></em>
317
and <em class="parameter"><code>duration</code></em>
318
would exceed the configured
320
<div class="refsect3">
321
<a name="id-1.2.9.5.10.6.5"></a><h4>Parameters</h4>
322
<div class="informaltable"><table width="100%" border="0">
324
<col width="150px" class="parameters_name">
325
<col class="parameters_description">
326
<col width="200px" class="parameters_annotations">
330
<td class="parameter_name"><p>payload</p></td>
331
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
332
<td class="parameter_annotations"> </td>
335
<td class="parameter_name"><p>size</p></td>
336
<td class="parameter_description"><p>the size of the packet</p></td>
337
<td class="parameter_annotations"> </td>
340
<td class="parameter_name"><p>duration</p></td>
341
<td class="parameter_description"><p>the duration of the packet</p></td>
342
<td class="parameter_annotations"> </td>
347
<div class="refsect3">
348
<a name="id-1.2.9.5.10.6.6"></a><h4>Returns</h4>
349
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the packet of <em class="parameter"><code>size</code></em>
350
and <em class="parameter"><code>duration</code></em>
352
configured MTU or max_ptime.</p>
357
<div class="refsect2">
358
<a name="gst-rtp-base-payload-push"></a><h3>gst_rtp_base_payload_push ()</h3>
359
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
360
gst_rtp_base_payload_push (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
361
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
362
<p>Push <em class="parameter"><code>buffer</code></em>
363
to the peer element of the payloader. The SSRC, payload type,
364
seqnum and timestamp of the RTP buffer will be updated first.</p>
365
<p>This function takes ownership of <em class="parameter"><code>buffer</code></em>
367
<div class="refsect3">
368
<a name="id-1.2.9.5.10.7.6"></a><h4>Parameters</h4>
369
<div class="informaltable"><table width="100%" border="0">
371
<col width="150px" class="parameters_name">
372
<col class="parameters_description">
373
<col width="200px" class="parameters_annotations">
377
<td class="parameter_name"><p>payload</p></td>
378
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
379
<td class="parameter_annotations"> </td>
382
<td class="parameter_name"><p>buffer</p></td>
383
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a></p></td>
384
<td class="parameter_annotations"> </td>
389
<div class="refsect3">
390
<a name="id-1.2.9.5.10.7.7"></a><h4>Returns</h4>
391
<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>.</p>
396
<div class="refsect2">
397
<a name="gst-rtp-base-payload-push-list"></a><h3>gst_rtp_base_payload_push_list ()</h3>
398
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
399
gst_rtp_base_payload_push_list (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
400
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBufferList.html#GstBufferList"><span class="type">GstBufferList</span></a> *list</code></em>);</pre>
401
<p>Push <em class="parameter"><code>list</code></em>
402
to the peer element of the payloader. The SSRC, payload type,
403
seqnum and timestamp of the RTP buffer will be updated first.</p>
404
<p>This function takes ownership of <em class="parameter"><code>list</code></em>
406
<div class="refsect3">
407
<a name="id-1.2.9.5.10.8.6"></a><h4>Parameters</h4>
408
<div class="informaltable"><table width="100%" border="0">
410
<col width="150px" class="parameters_name">
411
<col class="parameters_description">
412
<col width="200px" class="parameters_annotations">
416
<td class="parameter_name"><p>payload</p></td>
417
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
418
<td class="parameter_annotations"> </td>
421
<td class="parameter_name"><p>list</p></td>
422
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBufferList.html#GstBufferList"><span class="type">GstBufferList</span></a></p></td>
423
<td class="parameter_annotations"> </td>
428
<div class="refsect3">
429
<a name="id-1.2.9.5.10.8.7"></a><h4>Returns</h4>
430
<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>.</p>
435
<div class="refsect2">
436
<a name="gst-rtp-base-payload-set-options"></a><h3>gst_rtp_base_payload_set_options ()</h3>
437
<pre class="programlisting"><span class="returnvalue">void</span>
438
gst_rtp_base_payload_set_options (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
439
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *media</code></em>,
440
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dynamic</code></em>,
441
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *encoding_name</code></em>,
442
<em class="parameter"><code><span class="type">guint32</span> clock_rate</code></em>);</pre>
443
<p>Set the rtp options of the payloader. These options will be set in the caps
444
of the payloader. Subclasses must call this method before calling
445
<a class="link" href="gst-plugins-base-libs-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="gst-plugins-base-libs-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>
446
<div class="refsect3">
447
<a name="id-1.2.9.5.10.9.5"></a><h4>Parameters</h4>
448
<div class="informaltable"><table width="100%" border="0">
450
<col width="150px" class="parameters_name">
451
<col class="parameters_description">
452
<col width="200px" class="parameters_annotations">
456
<td class="parameter_name"><p>payload</p></td>
457
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
458
<td class="parameter_annotations"> </td>
461
<td class="parameter_name"><p>media</p></td>
462
<td class="parameter_description"><p>the media type (typically "audio" or "video")</p></td>
463
<td class="parameter_annotations"> </td>
466
<td class="parameter_name"><p>dynamic</p></td>
467
<td class="parameter_description"><p>if the payload type is dynamic</p></td>
468
<td class="parameter_annotations"> </td>
471
<td class="parameter_name"><p>encoding_name</p></td>
472
<td class="parameter_description"><p>the encoding name</p></td>
473
<td class="parameter_annotations"> </td>
476
<td class="parameter_name"><p>clock_rate</p></td>
477
<td class="parameter_description"><p>the clock rate of the media</p></td>
478
<td class="parameter_annotations"> </td>
485
<div class="refsect2">
486
<a name="gst-rtp-base-payload-set-outcaps"></a><h3>gst_rtp_base_payload_set_outcaps ()</h3>
487
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
488
gst_rtp_base_payload_set_outcaps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
489
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>,
490
<em class="parameter"><code>...</code></em>);</pre>
491
<p>Configure the output caps with the optional parameters.</p>
492
<p>Variable arguments should be in the form field name, field type
493
(as a GType), value(s). The last variable argument should be NULL.</p>
494
<div class="refsect3">
495
<a name="id-1.2.9.5.10.10.6"></a><h4>Parameters</h4>
496
<div class="informaltable"><table width="100%" border="0">
498
<col width="150px" class="parameters_name">
499
<col class="parameters_description">
500
<col width="200px" class="parameters_annotations">
504
<td class="parameter_name"><p>payload</p></td>
505
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a></p></td>
506
<td class="parameter_annotations"> </td>
509
<td class="parameter_name"><p>fieldname</p></td>
510
<td class="parameter_description"><p>the first field name or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
511
<td class="parameter_annotations"> </td>
514
<td class="parameter_name"><p>...</p></td>
515
<td class="parameter_description"><p>field values</p></td>
516
<td class="parameter_annotations"> </td>
521
<div class="refsect3">
522
<a name="id-1.2.9.5.10.10.7"></a><h4>Returns</h4>
523
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the caps could be set.</p>
528
<div class="refsect1">
529
<a name="gst-plugins-base-libs-gstrtpbasepayload.other_details"></a><h2>Types and Values</h2>
105
530
<div class="refsect2">
106
531
<a name="GstRTPBasePayload-struct"></a><h3>struct GstRTPBasePayload</h3>
107
532
<pre class="programlisting">struct GstRTPBasePayload;</pre>
127
552
gboolean (*query) (GstRTPBasePayload *payload, GstPad *pad, GstQuery * query);
131
Base class for audio RTP payloader.
133
<div class="variablelist"><table border="0" class="variablelist">
135
<col align="left" valign="top">
140
<td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#GstElementClass"><span class="type">GstElementClass</span></a> <em class="structfield"><code><a name="GstRTPBasePayloadClass.parent-class"></a>parent_class</code></em>;</span></p></td>
141
<td>the parent class</td>
144
<td><p><span class="term"><em class="structfield"><code><a name="GstRTPBasePayloadClass.get-caps"></a>get_caps</code></em> ()</span></p></td>
145
<td>get desired caps</td>
148
<td><p><span class="term"><em class="structfield"><code><a name="GstRTPBasePayloadClass.set-caps"></a>set_caps</code></em> ()</span></p></td>
149
<td>configure the payloader</td>
152
<td><p><span class="term"><em class="structfield"><code><a name="GstRTPBasePayloadClass.handle-buffer"></a>handle_buffer</code></em> ()</span></p></td>
153
<td>process data</td>
156
<td><p><span class="term"><em class="structfield"><code><a name="GstRTPBasePayloadClass.sink-event"></a>sink_event</code></em> ()</span></p></td>
157
<td>custom event handling on the sinkpad</td>
160
<td><p><span class="term"><em class="structfield"><code><a name="GstRTPBasePayloadClass.src-event"></a>src_event</code></em> ()</span></p></td>
161
<td>custom event handling on the srcpad</td>
164
<td><p><span class="term"><em class="structfield"><code><a name="GstRTPBasePayloadClass.query"></a>query</code></em> ()</span></p></td>
165
<td>custom query handling</td>
171
<div class="refsect2">
172
<a name="GST-RTP-BASE-PAYLOAD-MTU:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_MTU()</h3>
173
<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_MTU(payload) (GST_RTP_BASE_PAYLOAD (payload)->mtu)
176
Get access to the configured MTU of <em class="parameter"><code>payload</code></em>.
178
<div class="variablelist"><table border="0" class="variablelist">
180
<col align="left" valign="top">
184
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
185
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
191
<div class="refsect2">
192
<a name="GST-RTP-BASE-PAYLOAD-PT:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_PT()</h3>
193
<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_PT(payload) (GST_RTP_BASE_PAYLOAD (payload)->pt)
196
Get access to the configured payload type of <em class="parameter"><code>payload</code></em>.
198
<div class="variablelist"><table border="0" class="variablelist">
200
<col align="left" valign="top">
204
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
205
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
211
<div class="refsect2">
212
<a name="GST-RTP-BASE-PAYLOAD-SINKPAD:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_SINKPAD()</h3>
213
<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_SINKPAD(payload) (GST_RTP_BASE_PAYLOAD (payload)->sinkpad)
216
Get access to the sinkpad of <em class="parameter"><code>payload</code></em>.
218
<div class="variablelist"><table border="0" class="variablelist">
220
<col align="left" valign="top">
224
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
225
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
231
<div class="refsect2">
232
<a name="GST-RTP-BASE-PAYLOAD-SRCPAD:CAPS"></a><h3>GST_RTP_BASE_PAYLOAD_SRCPAD()</h3>
233
<pre class="programlisting">#define GST_RTP_BASE_PAYLOAD_SRCPAD(payload) (GST_RTP_BASE_PAYLOAD (payload)->srcpad)
236
Get access to the srcpad of <em class="parameter"><code>payload</code></em>.
238
<div class="variablelist"><table border="0" class="variablelist">
240
<col align="left" valign="top">
244
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
245
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
251
<div class="refsect2">
252
<a name="gst-rtp-base-payload-is-filled"></a><h3>gst_rtp_base_payload_is_filled ()</h3>
253
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_rtp_base_payload_is_filled (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
254
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>,
255
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> duration</code></em>);</pre>
257
Check if the packet with <em class="parameter"><code>size</code></em> and <em class="parameter"><code>duration</code></em> would exceed the configured
260
<div class="variablelist"><table border="0" class="variablelist">
262
<col align="left" valign="top">
267
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
268
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
272
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
273
<td>the size of the packet</td>
276
<td><p><span class="term"><em class="parameter"><code>duration</code></em> :</span></p></td>
277
<td>the duration of the packet</td>
280
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
282
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the packet of <em class="parameter"><code>size</code></em> and <em class="parameter"><code>duration</code></em> would exceed the
283
configured MTU or max_ptime.</td>
289
<div class="refsect2">
290
<a name="gst-rtp-base-payload-push"></a><h3>gst_rtp_base_payload_push ()</h3>
291
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> gst_rtp_base_payload_push (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
292
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
294
Push <em class="parameter"><code>buffer</code></em> to the peer element of the payloader. The SSRC, payload type,
295
seqnum and timestamp of the RTP buffer will be updated first.
298
This function takes ownership of <em class="parameter"><code>buffer</code></em>.
300
<div class="variablelist"><table border="0" class="variablelist">
302
<col align="left" valign="top">
307
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
308
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
312
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
313
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
317
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
318
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>.</td>
324
<div class="refsect2">
325
<a name="gst-rtp-base-payload-push-list"></a><h3>gst_rtp_base_payload_push_list ()</h3>
326
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> gst_rtp_base_payload_push_list (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
327
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBufferList.html#GstBufferList"><span class="type">GstBufferList</span></a> *list</code></em>);</pre>
329
Push <em class="parameter"><code>list</code></em> to the peer element of the payloader. The SSRC, payload type,
330
seqnum and timestamp of the RTP buffer will be updated first.
333
This function takes ownership of <em class="parameter"><code>list</code></em>.
335
<div class="variablelist"><table border="0" class="variablelist">
337
<col align="left" valign="top">
342
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
343
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
347
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
348
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBufferList.html#GstBufferList"><span class="type">GstBufferList</span></a>
352
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
353
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>.</td>
359
<div class="refsect2">
360
<a name="gst-rtp-base-payload-set-options"></a><h3>gst_rtp_base_payload_set_options ()</h3>
361
<pre class="programlisting"><span class="returnvalue">void</span> gst_rtp_base_payload_set_options (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
362
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *media</code></em>,
363
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dynamic</code></em>,
364
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *encoding_name</code></em>,
365
<em class="parameter"><code><span class="type">guint32</span> clock_rate</code></em>);</pre>
367
Set the rtp options of the payloader. These options will be set in the caps
368
of the payloader. Subclasses must call this method before calling
369
<a class="link" href="gst-plugins-base-libs-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="gst-plugins-base-libs-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>.
371
<div class="variablelist"><table border="0" class="variablelist">
373
<col align="left" valign="top">
378
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
379
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
383
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
384
<td>the media type (typically "audio" or "video")</td>
387
<td><p><span class="term"><em class="parameter"><code>dynamic</code></em> :</span></p></td>
388
<td>if the payload type is dynamic</td>
391
<td><p><span class="term"><em class="parameter"><code>encoding_name</code></em> :</span></p></td>
392
<td>the encoding name</td>
395
<td><p><span class="term"><em class="parameter"><code>clock_rate</code></em> :</span></p></td>
396
<td>the clock rate of the media</td>
402
<div class="refsect2">
403
<a name="gst-rtp-base-payload-set-outcaps"></a><h3>gst_rtp_base_payload_set_outcaps ()</h3>
404
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_rtp_base_payload_set_outcaps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a> *payload</code></em>,
405
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>,
406
<em class="parameter"><code>...</code></em>);</pre>
408
Configure the output caps with the optional parameters.
411
Variable arguments should be in the form field name, field type
412
(as a GType), value(s). The last variable argument should be NULL.
414
<div class="variablelist"><table border="0" class="variablelist">
416
<col align="left" valign="top">
421
<td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
422
<td>a <a class="link" href="gst-plugins-base-libs-gstrtpbasepayload.html#GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>
426
<td><p><span class="term"><em class="parameter"><code>fieldname</code></em> :</span></p></td>
427
<td>the first field name or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
431
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
432
<td>field values</td>
435
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
437
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the caps could be set.</td>
555
<p>Base class for audio RTP payloader.</p>
556
<div class="refsect3">
557
<a name="id-1.2.9.5.11.3.5"></a><h4>Members</h4>
558
<div class="informaltable"><table width="100%" border="0">
560
<col width="300px" class="struct_members_name">
561
<col class="struct_members_description">
562
<col width="200px" class="struct_members_annotations">
566
<td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#GstElementClass"><span class="type">GstElementClass</span></a> <em class="structfield"><code><a name="GstRTPBasePayloadClass.parent-class"></a>parent_class</code></em>;</p></td>
567
<td class="struct_member_description"><p>the parent class</p></td>
568
<td class="struct_member_annotations"> </td>
571
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.get-caps"></a>get_caps</code></em> ()</p></td>
572
<td class="struct_member_description"><p>get desired caps</p></td>
573
<td class="struct_member_annotations"> </td>
576
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.set-caps"></a>set_caps</code></em> ()</p></td>
577
<td class="struct_member_description"><p>configure the payloader</p></td>
578
<td class="struct_member_annotations"> </td>
581
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.handle-buffer"></a>handle_buffer</code></em> ()</p></td>
582
<td class="struct_member_description"><p>process data</p></td>
583
<td class="struct_member_annotations"> </td>
586
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.sink-event"></a>sink_event</code></em> ()</p></td>
587
<td class="struct_member_description"><p>custom event handling on the sinkpad</p></td>
588
<td class="struct_member_annotations"> </td>
591
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.src-event"></a>src_event</code></em> ()</p></td>
592
<td class="struct_member_description"><p>custom event handling on the srcpad</p></td>
593
<td class="struct_member_annotations"> </td>
596
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTPBasePayloadClass.query"></a>query</code></em> ()</p></td>
597
<td class="struct_member_description"><p>custom query handling</p></td>
598
<td class="struct_member_annotations"> </td>
443
605
<div class="refsect1">
444
606
<a name="gst-plugins-base-libs-gstrtpbasepayload.property-details"></a><h2>Property Details</h2>
445
607
<div class="refsect2">
446
<a name="GstRTPBasePayload--max-ptime"></a><h3>The <code class="literal">"max-ptime"</code> property</h3>
447
<pre class="programlisting"> "max-ptime" <span class="type">gint64</span> : Read / Write</pre>
608
<a name="GstRTPBasePayload--max-ptime"></a><h3>The <code class="literal">“max-ptime”</code> property</h3>
609
<pre class="programlisting"> “max-ptime” <span class="type">gint64</span></pre>
448
610
<p>Maximum duration of the packet data in ns (-1 = unlimited up to MTU).</p>
611
<p>Flags: Read / Write</p>
449
612
<p>Allowed values: >= -1</p>
450
613
<p>Default value: -1</p>
453
616
<div class="refsect2">
454
<a name="GstRTPBasePayload--min-ptime"></a><h3>The <code class="literal">"min-ptime"</code> property</h3>
455
<pre class="programlisting"> "min-ptime" <span class="type">gint64</span> : Read / Write</pre>
617
<a name="GstRTPBasePayload--min-ptime"></a><h3>The <code class="literal">“min-ptime”</code> property</h3>
618
<pre class="programlisting"> “min-ptime” <span class="type">gint64</span></pre>
456
619
<p>Minimum duration of the packet data in ns (can't go above MTU).</p>
620
<p>Flags: Read / Write</p>
457
621
<p>Allowed values: >= 0</p>
458
622
<p>Default value: 0</p>
461
625
<div class="refsect2">
462
<a name="GstRTPBasePayload--mtu"></a><h3>The <code class="literal">"mtu"</code> property</h3>
463
<pre class="programlisting"> "mtu" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
626
<a name="GstRTPBasePayload--mtu"></a><h3>The <code class="literal">“mtu”</code> property</h3>
627
<pre class="programlisting"> “mtu” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
464
628
<p>Maximum size of one packet.</p>
629
<p>Flags: Read / Write</p>
465
630
<p>Allowed values: >= 28</p>
466
631
<p>Default value: 1400</p>
469
634
<div class="refsect2">
470
<a name="GstRTPBasePayload--perfect-rtptime"></a><h3>The <code class="literal">"perfect-rtptime"</code> property</h3>
471
<pre class="programlisting"> "perfect-rtptime" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
635
<a name="GstRTPBasePayload--perfect-rtptime"></a><h3>The <code class="literal">“perfect-rtptime”</code> property</h3>
636
<pre class="programlisting"> “perfect-rtptime” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
472
637
<p>Generate perfect RTP timestamps when possible.</p>
638
<p>Flags: Read / Write</p>
473
639
<p>Default value: TRUE</p>
476
642
<div class="refsect2">
477
<a name="GstRTPBasePayload--pt"></a><h3>The <code class="literal">"pt"</code> property</h3>
478
<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>
643
<a name="GstRTPBasePayload--pt"></a><h3>The <code class="literal">“pt”</code> property</h3>
644
<pre class="programlisting"> “pt” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
479
645
<p>The payload type of the packets.</p>
646
<p>Flags: Read / Write</p>
480
647
<p>Allowed values: <= 128</p>
481
648
<p>Default value: 96</p>
484
651
<div class="refsect2">
485
<a name="GstRTPBasePayload--ptime-multiple"></a><h3>The <code class="literal">"ptime-multiple"</code> property</h3>
486
<pre class="programlisting"> "ptime-multiple" <span class="type">gint64</span> : Read / Write</pre>
652
<a name="GstRTPBasePayload--ptime-multiple"></a><h3>The <code class="literal">“ptime-multiple”</code> property</h3>
653
<pre class="programlisting"> “ptime-multiple” <span class="type">gint64</span></pre>
487
654
<p>Force buffers to be multiples of this duration in ns (0 disables).</p>
655
<p>Flags: Read / Write</p>
488
656
<p>Allowed values: >= 0</p>
489
657
<p>Default value: 0</p>
492
660
<div class="refsect2">
493
<a name="GstRTPBasePayload--seqnum"></a><h3>The <code class="literal">"seqnum"</code> property</h3>
494
<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>
661
<a name="GstRTPBasePayload--seqnum"></a><h3>The <code class="literal">“seqnum”</code> property</h3>
662
<pre class="programlisting"> “seqnum” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
495
663
<p>The RTP sequence number of the last processed packet.</p>
496
665
<p>Allowed values: <= 65535</p>
497
666
<p>Default value: 0</p>
500
669
<div class="refsect2">
501
<a name="GstRTPBasePayload--seqnum-offset"></a><h3>The <code class="literal">"seqnum-offset"</code> property</h3>
502
<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>
670
<a name="GstRTPBasePayload--seqnum-offset"></a><h3>The <code class="literal">“seqnum-offset”</code> property</h3>
671
<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></pre>
503
672
<p>Offset to add to all outgoing seqnum (-1 = random).</p>
673
<p>Flags: Read / Write</p>
504
674
<p>Allowed values: [-1,65535]</p>
505
675
<p>Default value: -1</p>
508
678
<div class="refsect2">
509
<a name="GstRTPBasePayload--ssrc"></a><h3>The <code class="literal">"ssrc"</code> property</h3>
510
<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>
679
<a name="GstRTPBasePayload--ssrc"></a><h3>The <code class="literal">“ssrc”</code> property</h3>
680
<pre class="programlisting"> “ssrc” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
511
681
<p>The SSRC of the packets (default == random).</p>
682
<p>Flags: Read / Write</p>
512
683
<p>Default value: 4294967295</p>
515
686
<div class="refsect2">
516
<a name="GstRTPBasePayload--timestamp"></a><h3>The <code class="literal">"timestamp"</code> property</h3>
517
<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>
687
<a name="GstRTPBasePayload--timestamp"></a><h3>The <code class="literal">“timestamp”</code> property</h3>
688
<pre class="programlisting"> “timestamp” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
518
689
<p>The RTP timestamp of the last processed packet.</p>
519
691
<p>Default value: 0</p>
522
694
<div class="refsect2">
523
<a name="GstRTPBasePayload--timestamp-offset"></a><h3>The <code class="literal">"timestamp-offset"</code> property</h3>
524
<pre class="programlisting"> "timestamp-offset" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
695
<a name="GstRTPBasePayload--timestamp-offset"></a><h3>The <code class="literal">“timestamp-offset”</code> property</h3>
696
<pre class="programlisting"> “timestamp-offset” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
525
697
<p>Offset to add to all outgoing timestamps (default = random).</p>
698
<p>Flags: Read / Write</p>
526
699
<p>Default value: 4294967295</p>
530
703
<div class="footer">
532
Generated by GTK-Doc V1.19</div>
705
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'