1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>gstbasertppayload</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
8 <link rel="up" href="gstreamer-rtp.html" title="RTP Library">
9 <link rel="prev" href="gst-plugins-base-libs-gstbasertpdepayload.html" title="gstbasertpdepayload">
10 <link rel="next" href="gst-plugins-base-libs-gstrtpbuffer.html" title="gstrtpbuffer">
11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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="2">
17 <td><a accesskey="p" href="gst-plugins-base-libs-gstbasertpdepayload.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gstreamer-rtp.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-base-libs-gstrtpbuffer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gstbasertppayload.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-libs-gstbasertppayload.description" class="shortcut">Description</a>
28 <a href="#gst-plugins-base-libs-gstbasertppayload.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gst-plugins-base-libs-gstbasertppayload.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="gst-plugins-base-libs-gstbasertppayload"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstbasertppayload.top_of_page"></a>gstbasertppayload</span></h2>
38 <p>gstbasertppayload — Base class for RTP payloader</p>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-base-libs-gstbasertppayload.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstBaseRTPPayload"></a><pre class="synopsis">
45 #include <gst/rtp/gstbasertppayload.h>
47 struct <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload-struct" title="struct GstBaseRTPPayload">GstBaseRTPPayload</a>;
48 struct <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayloadClass" title="struct GstBaseRTPPayloadClass">GstBaseRTPPayloadClass</a>;
49 #define <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GST-BASE-RTP-PAYLOAD-MTU:CAPS" title="GST_BASE_RTP_PAYLOAD_MTU()">GST_BASE_RTP_PAYLOAD_MTU</a> (payload)
50 #define <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GST-BASE-RTP-PAYLOAD-PT:CAPS" title="GST_BASE_RTP_PAYLOAD_PT()">GST_BASE_RTP_PAYLOAD_PT</a> (payload)
51 #define <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GST-BASE-RTP-PAYLOAD-SINKPAD:CAPS" title="GST_BASE_RTP_PAYLOAD_SINKPAD()">GST_BASE_RTP_PAYLOAD_SINKPAD</a> (payload)
52 #define <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GST-BASE-RTP-PAYLOAD-SRCPAD:CAPS" title="GST_BASE_RTP_PAYLOAD_SRCPAD()">GST_BASE_RTP_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-gstbasertppayload.html#gst-basertppayload-is-filled" title="gst_basertppayload_is_filled ()">gst_basertppayload_is_filled</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</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-gstbasertppayload.html#gst-basertppayload-push" title="gst_basertppayload_push ()">gst_basertppayload_push</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</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-gstbasertppayload.html#gst-basertppayload-push-list" title="gst_basertppayload_push_list ()">gst_basertppayload_push_list</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</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-gstbasertppayload.html#gst-basertppayload-set-options" title="gst_basertppayload_set_options ()">gst_basertppayload_set_options</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</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><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> 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-gstbasertppayload.html#gst-basertppayload-set-outcaps" title="gst_basertppayload_set_outcaps ()">gst_basertppayload_set_outcaps</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</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>);
70 <div class="refsect1">
71 <a name="gst-plugins-base-libs-gstbasertppayload.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://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
75 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
76 +----GstBaseRTPPayload
77 +----<a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload">GstBaseRTPAudioPayload</a>
80 <div class="refsect1">
81 <a name="gst-plugins-base-libs-gstbasertppayload.properties"></a><h2>Properties</h2>
82 <pre class="synopsis">
83 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--max-ptime" title='The "max-ptime" property'>max-ptime</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write
84 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--min-ptime" title='The "min-ptime" property'>min-ptime</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write
85 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--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
86 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--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
87 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--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
88 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--ptime-multiple" title='The "ptime-multiple" property'>ptime-multiple</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write
89 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--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
90 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--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
91 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--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
92 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--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
93 "<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload--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
96 <div class="refsect1">
97 <a name="gst-plugins-base-libs-gstbasertppayload.description"></a><h2>Description</h2>
100 <div class="refsect2">
101 <a name="idp17358176"></a><p>
102 Provides a base class for RTP payloaders
108 <div class="refsect1">
109 <a name="gst-plugins-base-libs-gstbasertppayload.details"></a><h2>Details</h2>
110 <div class="refsect2">
111 <a name="GstBaseRTPPayload-struct"></a><h3>struct GstBaseRTPPayload</h3>
112 <pre class="programlisting">struct GstBaseRTPPayload;</pre>
115 <div class="refsect2">
116 <a name="GstBaseRTPPayloadClass"></a><h3>struct GstBaseRTPPayloadClass</h3>
117 <pre class="programlisting">struct GstBaseRTPPayloadClass {
118 GstElementClass parent_class;
120 /* receive caps on the sink pad, configure the payloader. */
121 gboolean (*set_caps) (GstBaseRTPPayload *payload, GstCaps *caps);
122 /* handle a buffer, perform 0 or more gst_basertppayload_push() on
123 * the RTP buffers. This function takes ownership of the buffer. */
124 GstFlowReturn (*handle_buffer) (GstBaseRTPPayload *payload,
126 gboolean (*handle_event) (GstPad * pad, GstEvent * event);
127 GstCaps * (*get_caps) (GstBaseRTPPayload *payload, GstPad * pad);
132 <div class="refsect2">
133 <a name="GST-BASE-RTP-PAYLOAD-MTU:CAPS"></a><h3>GST_BASE_RTP_PAYLOAD_MTU()</h3>
134 <pre class="programlisting">#define GST_BASE_RTP_PAYLOAD_MTU(payload) (GST_BASE_RTP_PAYLOAD (payload)->mtu)
137 Get access to the configured MTU of <em class="parameter"><code>payload</code></em>.
139 <div class="variablelist"><table border="0">
140 <col align="left" valign="top">
142 <td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
143 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
149 <div class="refsect2">
150 <a name="GST-BASE-RTP-PAYLOAD-PT:CAPS"></a><h3>GST_BASE_RTP_PAYLOAD_PT()</h3>
151 <pre class="programlisting">#define GST_BASE_RTP_PAYLOAD_PT(payload) (GST_BASE_RTP_PAYLOAD (payload)->pt)
154 Get access to the configured payload type of <em class="parameter"><code>payload</code></em>.
156 <div class="variablelist"><table border="0">
157 <col align="left" valign="top">
159 <td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
160 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
166 <div class="refsect2">
167 <a name="GST-BASE-RTP-PAYLOAD-SINKPAD:CAPS"></a><h3>GST_BASE_RTP_PAYLOAD_SINKPAD()</h3>
168 <pre class="programlisting">#define GST_BASE_RTP_PAYLOAD_SINKPAD(payload) (GST_BASE_RTP_PAYLOAD (payload)->sinkpad)
171 Get access to the sinkpad of <em class="parameter"><code>payload</code></em>.
173 <div class="variablelist"><table border="0">
174 <col align="left" valign="top">
176 <td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
177 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
183 <div class="refsect2">
184 <a name="GST-BASE-RTP-PAYLOAD-SRCPAD:CAPS"></a><h3>GST_BASE_RTP_PAYLOAD_SRCPAD()</h3>
185 <pre class="programlisting">#define GST_BASE_RTP_PAYLOAD_SRCPAD(payload) (GST_BASE_RTP_PAYLOAD (payload)->srcpad)
188 Get access to the srcpad of <em class="parameter"><code>payload</code></em>.
190 <div class="variablelist"><table border="0">
191 <col align="left" valign="top">
193 <td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
194 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
200 <div class="refsect2">
201 <a name="gst-basertppayload-is-filled"></a><h3>gst_basertppayload_is_filled ()</h3>
202 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_basertppayload_is_filled (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a> *payload</code></em>,
203 <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>,
204 <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>
206 Check if the packet with <em class="parameter"><code>size</code></em> and <em class="parameter"><code>duration</code></em> would exceed the configured
209 <div class="variablelist"><table border="0">
210 <col align="left" valign="top">
213 <td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
214 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
218 <td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
219 <td>the size of the packet</td>
222 <td><p><span class="term"><em class="parameter"><code>duration</code></em> :</span></p></td>
223 <td>the duration of the packet</td>
226 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
228 <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
229 configured MTU or max_ptime.</td>
235 <div class="refsect2">
236 <a name="gst-basertppayload-push"></a><h3>gst_basertppayload_push ()</h3>
237 <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_basertppayload_push (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a> *payload</code></em>,
238 <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>
240 Push <em class="parameter"><code>buffer</code></em> to the peer element of the payloader. The SSRC, payload type,
241 seqnum and timestamp of the RTP buffer will be updated first.
244 This function takes ownership of <em class="parameter"><code>buffer</code></em>.
246 <div class="variablelist"><table border="0">
247 <col align="left" valign="top">
250 <td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
251 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
255 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
256 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
260 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
261 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>.</td>
267 <div class="refsect2">
268 <a name="gst-basertppayload-push-list"></a><h3>gst_basertppayload_push_list ()</h3>
269 <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_basertppayload_push_list (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a> *payload</code></em>,
270 <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>
272 Push <em class="parameter"><code>list</code></em> to the peer element of the payloader. The SSRC, payload type,
273 seqnum and timestamp of the RTP buffer will be updated first.
276 This function takes ownership of <em class="parameter"><code>list</code></em>.
278 <div class="variablelist"><table border="0">
279 <col align="left" valign="top">
282 <td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
283 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
287 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
288 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBufferList.html#GstBufferList"><span class="type">GstBufferList</span></a>
292 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
293 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>.</td>
297 <p class="since">Since 0.10.24</p>
300 <div class="refsect2">
301 <a name="gst-basertppayload-set-options"></a><h3>gst_basertppayload_set_options ()</h3>
302 <pre class="programlisting"><span class="returnvalue">void</span> gst_basertppayload_set_options (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a> *payload</code></em>,
303 <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>,
304 <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>,
305 <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>,
306 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> clock_rate</code></em>);</pre>
308 Set the rtp options of the payloader. These options will be set in the caps
309 of the payloader. Subclasses must call this method before calling
310 <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#gst-basertppayload-push" title="gst_basertppayload_push ()"><code class="function">gst_basertppayload_push()</code></a> or <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#gst-basertppayload-set-outcaps" title="gst_basertppayload_set_outcaps ()"><code class="function">gst_basertppayload_set_outcaps()</code></a>.
312 <div class="variablelist"><table border="0">
313 <col align="left" valign="top">
316 <td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
317 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
321 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
322 <td>the media type (typically "audio" or "video")</td>
325 <td><p><span class="term"><em class="parameter"><code>dynamic</code></em> :</span></p></td>
326 <td>if the payload type is dynamic</td>
329 <td><p><span class="term"><em class="parameter"><code>encoding_name</code></em> :</span></p></td>
330 <td>the encoding name</td>
333 <td><p><span class="term"><em class="parameter"><code>clock_rate</code></em> :</span></p></td>
334 <td>the clock rate of the media</td>
340 <div class="refsect2">
341 <a name="gst-basertppayload-set-outcaps"></a><h3>gst_basertppayload_set_outcaps ()</h3>
342 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_basertppayload_set_outcaps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a> *payload</code></em>,
343 <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>,
344 <em class="parameter"><code>...</code></em>);</pre>
346 Configure the output caps with the optional parameters.
349 Variable arguments should be in the form field name, field type
350 (as a GType), value(s). The last variable argument should be NULL.
352 <div class="variablelist"><table border="0">
353 <col align="left" valign="top">
356 <td><p><span class="term"><em class="parameter"><code>payload</code></em> :</span></p></td>
357 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
361 <td><p><span class="term"><em class="parameter"><code>fieldname</code></em> :</span></p></td>
362 <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>
366 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
367 <td>field values</td>
370 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
372 <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>
378 <div class="refsect1">
379 <a name="gst-plugins-base-libs-gstbasertppayload.property-details"></a><h2>Property Details</h2>
380 <div class="refsect2">
381 <a name="GstBaseRTPPayload--max-ptime"></a><h3>The <code class="literal">"max-ptime"</code> property</h3>
382 <pre class="programlisting"> "max-ptime" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write</pre>
383 <p>Maximum duration of the packet data in ns (-1 = unlimited up to MTU).</p>
384 <p>Allowed values: >= -1</p>
385 <p>Default value: -1</p>
388 <div class="refsect2">
389 <a name="GstBaseRTPPayload--min-ptime"></a><h3>The <code class="literal">"min-ptime"</code> property</h3>
390 <pre class="programlisting"> "min-ptime" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write</pre>
391 <p>Minimum duration of the packet data in ns (can't go above MTU).</p>
392 <p>Allowed values: >= 0</p>
393 <p>Default value: 0</p>
396 <div class="refsect2">
397 <a name="GstBaseRTPPayload--mtu"></a><h3>The <code class="literal">"mtu"</code> property</h3>
398 <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>
399 <p>Maximum size of one packet.</p>
400 <p>Allowed values: >= 28</p>
401 <p>Default value: 1400</p>
404 <div class="refsect2">
405 <a name="GstBaseRTPPayload--perfect-rtptime"></a><h3>The <code class="literal">"perfect-rtptime"</code> property</h3>
406 <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>
407 <p>Generate perfect RTP timestamps when possible.</p>
408 <p>Default value: TRUE</p>
411 <div class="refsect2">
412 <a name="GstBaseRTPPayload--pt"></a><h3>The <code class="literal">"pt"</code> property</h3>
413 <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>
414 <p>The payload type of the packets.</p>
415 <p>Allowed values: <= 128</p>
416 <p>Default value: 96</p>
419 <div class="refsect2">
420 <a name="GstBaseRTPPayload--ptime-multiple"></a><h3>The <code class="literal">"ptime-multiple"</code> property</h3>
421 <pre class="programlisting"> "ptime-multiple" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write</pre>
422 <p>Force buffers to be multiples of this duration in ns (0 disables).</p>
423 <p>Allowed values: >= 0</p>
424 <p>Default value: 0</p>
427 <div class="refsect2">
428 <a name="GstBaseRTPPayload--seqnum"></a><h3>The <code class="literal">"seqnum"</code> property</h3>
429 <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>
430 <p>The RTP sequence number of the last processed packet.</p>
431 <p>Allowed values: <= 65535</p>
432 <p>Default value: 0</p>
435 <div class="refsect2">
436 <a name="GstBaseRTPPayload--seqnum-offset"></a><h3>The <code class="literal">"seqnum-offset"</code> property</h3>
437 <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>
438 <p>Offset to add to all outgoing seqnum (-1 = random).</p>
439 <p>Allowed values: [G_MAXULONG,65535]</p>
440 <p>Default value: -1</p>
443 <div class="refsect2">
444 <a name="GstBaseRTPPayload--ssrc"></a><h3>The <code class="literal">"ssrc"</code> property</h3>
445 <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>
446 <p>The SSRC of the packets (default == random).</p>
447 <p>Default value: 4294967295</p>
450 <div class="refsect2">
451 <a name="GstBaseRTPPayload--timestamp"></a><h3>The <code class="literal">"timestamp"</code> property</h3>
452 <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>
453 <p>The RTP timestamp of the last processed packet.</p>
454 <p>Default value: 0</p>
457 <div class="refsect2">
458 <a name="GstBaseRTPPayload--timestamp-offset"></a><h3>The <code class="literal">"timestamp-offset"</code> property</h3>
459 <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>
460 <p>Offset to add to all outgoing timestamps (default = random).</p>
461 <p>Default value: 4294967295</p>
467 Generated by GTK-Doc V1.17</div>