15b6dc241432f6e5931a55563412b629ecbbaf15
[framework/multimedia/gst-plugins-base0.10.git] / docs / libs / html / gst-plugins-base-libs-gstbasertpaudiopayload.html
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>gstbasertpaudiopayload</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="gstreamer-rtp.html" title="RTP Library">
10 <link rel="next" href="gst-plugins-base-libs-gstbasertpdepayload.html" title="gstbasertpdepayload">
11 <meta name="generator" content="GTK-Doc V1.17 (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="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="gstreamer-rtp.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-gstbasertpdepayload.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gstbasertpaudiopayload.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-libs-gstbasertpaudiopayload.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-base-libs-gstbasertpaudiopayload.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-base-libs-gstbasertpaudiopayload.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-base-libs-gstbasertpaudiopayload"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstbasertpaudiopayload.top_of_page"></a>gstbasertpaudiopayload</span></h2>
38 <p>gstbasertpaudiopayload — Base class for audio RTP payloader</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-base-libs-gstbasertpaudiopayload.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstBaseRTPAudioPayload"></a><pre class="synopsis">
45 #include &lt;gst/rtp/gstbasertpaudiopayload.h&gt;
46
47 struct              <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload-struct" title="struct GstBaseRTPAudioPayload">GstBaseRTPAudioPayload</a>;
48 struct              <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayloadClass" title="struct GstBaseRTPAudioPayloadClass">GstBaseRTPAudioPayloadClass</a>;
49 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-set-frame-based" title="gst_base_rtp_audio_payload_set_frame_based ()">gst_base_rtp_audio_payload_set_frame_based</a>
50                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>);
51 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-set-frame-options" title="gst_base_rtp_audio_payload_set_frame_options ()">gst_base_rtp_audio_payload_set_frame_options</a>
52                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>,
53                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_duration</code></em>,
54                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_size</code></em>);
55 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-set-sample-based" title="gst_base_rtp_audio_payload_set_sample_based ()">gst_base_rtp_audio_payload_set_sample_based</a>
56                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>);
57 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-set-sample-options" title="gst_base_rtp_audio_payload_set_sample_options ()">gst_base_rtp_audio_payload_set_sample_options</a>
58                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>,
59                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sample_size</code></em>);
60 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstAdapter.html"><span class="returnvalue">GstAdapter</span></a> *        <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-get-adapter" title="gst_base_rtp_audio_payload_get_adapter ()">gst_base_rtp_audio_payload_get_adapter</a>
61                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>);
62 <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-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-push" title="gst_base_rtp_audio_payload_push ()">gst_base_rtp_audio_payload_push</a>     (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *baseaudiopayload</code></em>,
63                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *data</code></em>,
64                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> payload_len</code></em>,
65                                                          <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> timestamp</code></em>);
66 <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-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-flush" title="gst_base_rtp_audio_payload_flush ()">gst_base_rtp_audio_payload_flush</a>    (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *baseaudiopayload</code></em>,
67                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> payload_len</code></em>,
68                                                          <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> timestamp</code></em>);
69 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-set-samplebits-options" title="gst_base_rtp_audio_payload_set_samplebits_options ()">gst_base_rtp_audio_payload_set_samplebits_options</a>
70                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>,
71                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sample_size</code></em>);
72 </pre>
73 </div>
74 <div class="refsect1">
75 <a name="gst-plugins-base-libs-gstbasertpaudiopayload.object-hierarchy"></a><h2>Object Hierarchy</h2>
76 <pre class="synopsis">
77   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
78    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
79          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
80                +----<a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload">GstBaseRTPPayload</a>
81                      +----GstBaseRTPAudioPayload
82 </pre>
83 </div>
84 <div class="refsect1">
85 <a name="gst-plugins-base-libs-gstbasertpaudiopayload.properties"></a><h2>Properties</h2>
86 <pre class="synopsis">
87   "<a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload--buffer-list" title='The "buffer-list" property'>buffer-list</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
88 </pre>
89 </div>
90 <div class="refsect1">
91 <a name="gst-plugins-base-libs-gstbasertpaudiopayload.description"></a><h2>Description</h2>
92 <p>
93 </p>
94 <div class="refsect2">
95 <a name="idp16015920"></a><h3>Usage</h3>
96 <p>
97 Provides a base class for audio RTP payloaders for frame or sample based
98 audio codecs (constant bitrate)
99 </p>
100 <p>
101 This class derives from GstBaseRTPPayload. It can be used for payloading
102 audio codecs. It will only work with constant bitrate codecs. It supports
103 both frame based and sample based codecs. It takes care of packing up the
104 audio data into RTP packets and filling up the headers accordingly. The
105 payloading is done based on the maximum MTU (mtu) and the maximum time per
106 packet (max-ptime). The general idea is to divide large data buffers into
107 smaller RTP packets. The RTP packet size is the minimum of either the MTU,
108 max-ptime (if set) or available data. The RTP packet size is always larger or
109 equal to min-ptime (if set). If min-ptime is not set, any residual data is
110 sent in a last RTP packet. In the case of frame based codecs, the resulting
111 RTP packets always contain full frames.
112 </p>
113 <p>
114 To use this base class, your child element needs to call either
115 <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-set-frame-based" title="gst_base_rtp_audio_payload_set_frame_based ()"><code class="function">gst_base_rtp_audio_payload_set_frame_based()</code></a> or
116 <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-set-sample-based" title="gst_base_rtp_audio_payload_set_sample_based ()"><code class="function">gst_base_rtp_audio_payload_set_sample_based()</code></a>. This is usually done in the
117 element's <code class="function">_init()</code> function. Then, the child element must call either
118 <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-set-frame-options" title="gst_base_rtp_audio_payload_set_frame_options ()"><code class="function">gst_base_rtp_audio_payload_set_frame_options()</code></a>,
119 <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#gst-base-rtp-audio-payload-set-sample-options" title="gst_base_rtp_audio_payload_set_sample_options ()"><code class="function">gst_base_rtp_audio_payload_set_sample_options()</code></a> or
120 gst_base_rtp_audio_payload_set_samplebits_options. Since
121 GstBaseRTPAudioPayload derives from GstBaseRTPPayload, the child element
122 must set any variables or call/override any functions required by that base
123 class. The child element does not need to override any other functions
124 specific to GstBaseRTPAudioPayload.
125 </p>
126 </div>
127 <p>
128 </p>
129 </div>
130 <div class="refsect1">
131 <a name="gst-plugins-base-libs-gstbasertpaudiopayload.details"></a><h2>Details</h2>
132 <div class="refsect2">
133 <a name="GstBaseRTPAudioPayload-struct"></a><h3>struct GstBaseRTPAudioPayload</h3>
134 <pre class="programlisting">struct GstBaseRTPAudioPayload;</pre>
135 </div>
136 <hr>
137 <div class="refsect2">
138 <a name="GstBaseRTPAudioPayloadClass"></a><h3>struct GstBaseRTPAudioPayloadClass</h3>
139 <pre class="programlisting">struct GstBaseRTPAudioPayloadClass {
140   GstBaseRTPPayloadClass parent_class;
141
142   gpointer _gst_reserved[GST_PADDING];
143 };
144 </pre>
145 </div>
146 <hr>
147 <div class="refsect2">
148 <a name="gst-base-rtp-audio-payload-set-frame-based"></a><h3>gst_base_rtp_audio_payload_set_frame_based ()</h3>
149 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_rtp_audio_payload_set_frame_based
150                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>);</pre>
151 <p>
152 Tells <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> that the child element is for a frame based
153 audio codec
154 </p>
155 <div class="variablelist"><table border="0">
156 <col align="left" valign="top">
157 <tbody><tr>
158 <td><p><span class="term"><em class="parameter"><code>basertpaudiopayload</code></em> :</span></p></td>
159 <td>a pointer to the element.</td>
160 </tr></tbody>
161 </table></div>
162 </div>
163 <hr>
164 <div class="refsect2">
165 <a name="gst-base-rtp-audio-payload-set-frame-options"></a><h3>gst_base_rtp_audio_payload_set_frame_options ()</h3>
166 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_rtp_audio_payload_set_frame_options
167                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>,
168                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_duration</code></em>,
169                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_size</code></em>);</pre>
170 <p>
171 Sets the options for frame based audio codecs.
172 </p>
173 <div class="variablelist"><table border="0">
174 <col align="left" valign="top">
175 <tbody>
176 <tr>
177 <td><p><span class="term"><em class="parameter"><code>basertpaudiopayload</code></em> :</span></p></td>
178 <td>a pointer to the element.</td>
179 </tr>
180 <tr>
181 <td><p><span class="term"><em class="parameter"><code>frame_duration</code></em> :</span></p></td>
182 <td>The duraction of an audio frame in milliseconds.</td>
183 </tr>
184 <tr>
185 <td><p><span class="term"><em class="parameter"><code>frame_size</code></em> :</span></p></td>
186 <td>The size of an audio frame in bytes.</td>
187 </tr>
188 </tbody>
189 </table></div>
190 </div>
191 <hr>
192 <div class="refsect2">
193 <a name="gst-base-rtp-audio-payload-set-sample-based"></a><h3>gst_base_rtp_audio_payload_set_sample_based ()</h3>
194 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_rtp_audio_payload_set_sample_based
195                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>);</pre>
196 <p>
197 Tells <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> that the child element is for a sample based
198 audio codec
199 </p>
200 <div class="variablelist"><table border="0">
201 <col align="left" valign="top">
202 <tbody><tr>
203 <td><p><span class="term"><em class="parameter"><code>basertpaudiopayload</code></em> :</span></p></td>
204 <td>a pointer to the element.</td>
205 </tr></tbody>
206 </table></div>
207 </div>
208 <hr>
209 <div class="refsect2">
210 <a name="gst-base-rtp-audio-payload-set-sample-options"></a><h3>gst_base_rtp_audio_payload_set_sample_options ()</h3>
211 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_rtp_audio_payload_set_sample_options
212                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>,
213                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sample_size</code></em>);</pre>
214 <p>
215 Sets the options for sample based audio codecs.
216 </p>
217 <div class="variablelist"><table border="0">
218 <col align="left" valign="top">
219 <tbody>
220 <tr>
221 <td><p><span class="term"><em class="parameter"><code>basertpaudiopayload</code></em> :</span></p></td>
222 <td>a pointer to the element.</td>
223 </tr>
224 <tr>
225 <td><p><span class="term"><em class="parameter"><code>sample_size</code></em> :</span></p></td>
226 <td>Size per sample in bytes.</td>
227 </tr>
228 </tbody>
229 </table></div>
230 </div>
231 <hr>
232 <div class="refsect2">
233 <a name="gst-base-rtp-audio-payload-get-adapter"></a><h3>gst_base_rtp_audio_payload_get_adapter ()</h3>
234 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstAdapter.html"><span class="returnvalue">GstAdapter</span></a> *        gst_base_rtp_audio_payload_get_adapter
235                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>);</pre>
236 <p>
237 Gets the internal adapter used by the depayloader.
238 </p>
239 <div class="variablelist"><table border="0">
240 <col align="left" valign="top">
241 <tbody>
242 <tr>
243 <td><p><span class="term"><em class="parameter"><code>basertpaudiopayload</code></em> :</span></p></td>
244 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a>
245 </td>
246 </tr>
247 <tr>
248 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
249 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstAdapter.html"><span class="type">GstAdapter</span></a>.</td>
250 </tr>
251 </tbody>
252 </table></div>
253 <p class="since">Since 0.10.13</p>
254 </div>
255 <hr>
256 <div class="refsect2">
257 <a name="gst-base-rtp-audio-payload-push"></a><h3>gst_base_rtp_audio_payload_push ()</h3>
258 <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_base_rtp_audio_payload_push     (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *baseaudiopayload</code></em>,
259                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *data</code></em>,
260                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> payload_len</code></em>,
261                                                          <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> timestamp</code></em>);</pre>
262 <p>
263 Create an RTP buffer and store <em class="parameter"><code>payload_len</code></em> bytes of <em class="parameter"><code>data</code></em> as the
264 payload. Set the timestamp on the new buffer to <em class="parameter"><code>timestamp</code></em> before pushing
265 the buffer downstream.
266 </p>
267 <div class="variablelist"><table border="0">
268 <col align="left" valign="top">
269 <tbody>
270 <tr>
271 <td><p><span class="term"><em class="parameter"><code>baseaudiopayload</code></em> :</span></p></td>
272 <td>a <a class="link" href="gst-plugins-base-libs-gstbasertppayload.html#GstBaseRTPPayload"><span class="type">GstBaseRTPPayload</span></a>
273 </td>
274 </tr>
275 <tr>
276 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
277 <td>data to set as payload</td>
278 </tr>
279 <tr>
280 <td><p><span class="term"><em class="parameter"><code>payload_len</code></em> :</span></p></td>
281 <td>length of payload</td>
282 </tr>
283 <tr>
284 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
285 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
286 </td>
287 </tr>
288 <tr>
289 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
290 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>
291 </td>
292 </tr>
293 </tbody>
294 </table></div>
295 <p class="since">Since 0.10.13</p>
296 </div>
297 <hr>
298 <div class="refsect2">
299 <a name="gst-base-rtp-audio-payload-flush"></a><h3>gst_base_rtp_audio_payload_flush ()</h3>
300 <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_base_rtp_audio_payload_flush    (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *baseaudiopayload</code></em>,
301                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> payload_len</code></em>,
302                                                          <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> timestamp</code></em>);</pre>
303 <p>
304 Create an RTP buffer and store <em class="parameter"><code>payload_len</code></em> bytes of the adapter as the
305 payload. Set the timestamp on the new buffer to <em class="parameter"><code>timestamp</code></em> before pushing
306 the buffer downstream.
307 </p>
308 <p>
309 If <em class="parameter"><code>payload_len</code></em> is -1, all pending bytes will be flushed. If <em class="parameter"><code>timestamp</code></em> is
310 -1, the timestamp will be calculated automatically.
311 </p>
312 <div class="variablelist"><table border="0">
313 <col align="left" valign="top">
314 <tbody>
315 <tr>
316 <td><p><span class="term"><em class="parameter"><code>baseaudiopayload</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>
318 </td>
319 </tr>
320 <tr>
321 <td><p><span class="term"><em class="parameter"><code>payload_len</code></em> :</span></p></td>
322 <td>length of payload</td>
323 </tr>
324 <tr>
325 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
326 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
327 </td>
328 </tr>
329 <tr>
330 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
331 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a>
332 </td>
333 </tr>
334 </tbody>
335 </table></div>
336 <p class="since">Since 0.10.25</p>
337 </div>
338 <hr>
339 <div class="refsect2">
340 <a name="gst-base-rtp-audio-payload-set-samplebits-options"></a><h3>gst_base_rtp_audio_payload_set_samplebits_options ()</h3>
341 <pre class="programlisting"><span class="returnvalue">void</span>                gst_base_rtp_audio_payload_set_samplebits_options
342                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstbasertpaudiopayload.html#GstBaseRTPAudioPayload"><span class="type">GstBaseRTPAudioPayload</span></a> *basertpaudiopayload</code></em>,
343                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sample_size</code></em>);</pre>
344 <p>
345 Sets the options for sample based audio codecs.
346 </p>
347 <div class="variablelist"><table border="0">
348 <col align="left" valign="top">
349 <tbody>
350 <tr>
351 <td><p><span class="term"><em class="parameter"><code>basertpaudiopayload</code></em> :</span></p></td>
352 <td>a pointer to the element.</td>
353 </tr>
354 <tr>
355 <td><p><span class="term"><em class="parameter"><code>sample_size</code></em> :</span></p></td>
356 <td>Size per sample in bits.</td>
357 </tr>
358 </tbody>
359 </table></div>
360 <p class="since">Since 0.10.18</p>
361 </div>
362 </div>
363 <div class="refsect1">
364 <a name="gst-plugins-base-libs-gstbasertpaudiopayload.property-details"></a><h2>Property Details</h2>
365 <div class="refsect2">
366 <a name="GstBaseRTPAudioPayload--buffer-list"></a><h3>The <code class="literal">"buffer-list"</code> property</h3>
367 <pre class="programlisting">  "buffer-list"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
368 <p>Use Buffer Lists.</p>
369 <p>Default value: FALSE</p>
370 </div>
371 </div>
372 </div>
373 <div class="footer">
374 <hr>
375           Generated by GTK-Doc V1.17</div>
376 </body>
377 </html>