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>GstRtphdrext: GStreamer Base Plugins 1.0 Library Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual"> 8<link rel="up" href="gstreamer-rtp.html" title="RTP Library"> 9<link rel="prev" href="gst-plugins-base-libs-GstRTPPayloadInfo.html" title="GstRTPPayloadInfo"> 10<link rel="next" href="gst-plugins-base-libs-GstRTPdefs.html" title="GstRTPdefs"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-base-libs-GstRtphdrext.description" class="shortcut">Description</a></span> 19</td> 20<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 21<td><a accesskey="u" href="gstreamer-rtp.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 22<td><a accesskey="p" href="gst-plugins-base-libs-GstRTPPayloadInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 23<td><a accesskey="n" href="gst-plugins-base-libs-GstRTPdefs.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 24</tr></table> 25<div class="refentry"> 26<a name="gst-plugins-base-libs-GstRtphdrext"></a><div class="titlepage"></div> 27<div class="refnamediv"><table width="100%"><tr> 28<td valign="top"> 29<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-GstRtphdrext.top_of_page"></a>GstRtphdrext</span></h2> 30<p>GstRtphdrext — Helper methods for dealing with RTP header extensions</p> 31</td> 32<td class="gallery_image" valign="top" align="right"></td> 33</tr></table></div> 34<div class="refsect1"> 35<a name="gst-plugins-base-libs-GstRtphdrext.functions"></a><h2>Functions</h2> 36<div class="informaltable"><table class="informaltable" width="100%" border="0"> 37<colgroup> 38<col width="150px" class="functions_return"> 39<col class="functions_name"> 40</colgroup> 41<tbody> 42<tr> 43<td class="function_type"> 44<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 45</td> 46<td class="function_name"> 47<a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#gst-rtp-hdrext-get-ntp-56" title="gst_rtp_hdrext_get_ntp_56 ()">gst_rtp_hdrext_get_ntp_56</a> <span class="c_punctuation">()</span> 48</td> 49</tr> 50<tr> 51<td class="function_type"> 52<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 53</td> 54<td class="function_name"> 55<a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#gst-rtp-hdrext-get-ntp-64" title="gst_rtp_hdrext_get_ntp_64 ()">gst_rtp_hdrext_get_ntp_64</a> <span class="c_punctuation">()</span> 56</td> 57</tr> 58<tr> 59<td class="function_type"> 60<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 61</td> 62<td class="function_name"> 63<a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#gst-rtp-hdrext-set-ntp-56" title="gst_rtp_hdrext_set_ntp_56 ()">gst_rtp_hdrext_set_ntp_56</a> <span class="c_punctuation">()</span> 64</td> 65</tr> 66<tr> 67<td class="function_type"> 68<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 69</td> 70<td class="function_name"> 71<a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#gst-rtp-hdrext-set-ntp-64" title="gst_rtp_hdrext_set_ntp_64 ()">gst_rtp_hdrext_set_ntp_64</a> <span class="c_punctuation">()</span> 72</td> 73</tr> 74</tbody> 75</table></div> 76</div> 77<div class="refsect1"> 78<a name="gst-plugins-base-libs-GstRtphdrext.other"></a><h2>Types and Values</h2> 79<div class="informaltable"><table class="informaltable" width="100%" border="0"> 80<colgroup> 81<col width="150px" class="name"> 82<col class="description"> 83</colgroup> 84<tbody> 85<tr> 86<td class="define_keyword">#define</td> 87<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-BASE:CAPS" title="GST_RTP_HDREXT_BASE">GST_RTP_HDREXT_BASE</a></td> 88</tr> 89<tr> 90<td class="define_keyword">#define</td> 91<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-56:CAPS" title="GST_RTP_HDREXT_NTP_56">GST_RTP_HDREXT_NTP_56</a></td> 92</tr> 93<tr> 94<td class="define_keyword">#define</td> 95<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-56-SIZE:CAPS" title="GST_RTP_HDREXT_NTP_56_SIZE">GST_RTP_HDREXT_NTP_56_SIZE</a></td> 96</tr> 97<tr> 98<td class="define_keyword">#define</td> 99<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-64:CAPS" title="GST_RTP_HDREXT_NTP_64">GST_RTP_HDREXT_NTP_64</a></td> 100</tr> 101<tr> 102<td class="define_keyword">#define</td> 103<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-64-SIZE:CAPS" title="GST_RTP_HDREXT_NTP_64_SIZE">GST_RTP_HDREXT_NTP_64_SIZE</a></td> 104</tr> 105</tbody> 106</table></div> 107</div> 108<div class="refsect1"> 109<a name="gst-plugins-base-libs-GstRtphdrext.includes"></a><h2>Includes</h2> 110<pre class="synopsis">#include <gst/rtp/rtp.h> 111</pre> 112</div> 113<div class="refsect1"> 114<a name="gst-plugins-base-libs-GstRtphdrext.description"></a><h2>Description</h2> 115</div> 116<div class="refsect1"> 117<a name="gst-plugins-base-libs-GstRtphdrext.functions_details"></a><h2>Functions</h2> 118<div class="refsect2"> 119<a name="gst-rtp-hdrext-get-ntp-56"></a><h3>gst_rtp_hdrext_get_ntp_56 ()</h3> 120<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 121gst_rtp_hdrext_get_ntp_56 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>, 122 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>, 123 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *ntptime</code></em>);</pre> 124<p>Reads the NTP time from the <em class="parameter"><code>size</code></em> 125 NTP-56 extension bytes in <em class="parameter"><code>data</code></em> 126 and store the 127result in <em class="parameter"><code>ntptime</code></em> 128.</p> 129<div class="refsect3"> 130<a name="gst-rtp-hdrext-get-ntp-56.parameters"></a><h4>Parameters</h4> 131<div class="informaltable"><table class="informaltable" width="100%" border="0"> 132<colgroup> 133<col width="150px" class="parameters_name"> 134<col class="parameters_description"> 135<col width="200px" class="parameters_annotations"> 136</colgroup> 137<tbody> 138<tr> 139<td class="parameter_name"><p>data</p></td> 140<td class="parameter_description"><p>the data to read from. </p></td> 141<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> 142</tr> 143<tr> 144<td class="parameter_name"><p>size</p></td> 145<td class="parameter_description"><p>the size of <em class="parameter"><code>data</code></em> 146</p></td> 147<td class="parameter_annotations"> </td> 148</tr> 149<tr> 150<td class="parameter_name"><p>ntptime</p></td> 151<td class="parameter_description"><p>the result NTP time. </p></td> 152<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 153</tr> 154</tbody> 155</table></div> 156</div> 157<div class="refsect3"> 158<a name="gst-rtp-hdrext-get-ntp-56.returns"></a><h4>Returns</h4> 159<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p> 160</div> 161</div> 162<hr> 163<div class="refsect2"> 164<a name="gst-rtp-hdrext-get-ntp-64"></a><h3>gst_rtp_hdrext_get_ntp_64 ()</h3> 165<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 166gst_rtp_hdrext_get_ntp_64 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>, 167 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>, 168 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *ntptime</code></em>);</pre> 169<p>Reads the NTP time from the <em class="parameter"><code>size</code></em> 170 NTP-64 extension bytes in <em class="parameter"><code>data</code></em> 171 and store the 172result in <em class="parameter"><code>ntptime</code></em> 173.</p> 174<div class="refsect3"> 175<a name="gst-rtp-hdrext-get-ntp-64.parameters"></a><h4>Parameters</h4> 176<div class="informaltable"><table class="informaltable" width="100%" border="0"> 177<colgroup> 178<col width="150px" class="parameters_name"> 179<col class="parameters_description"> 180<col width="200px" class="parameters_annotations"> 181</colgroup> 182<tbody> 183<tr> 184<td class="parameter_name"><p>data</p></td> 185<td class="parameter_description"><p>the data to read from. </p></td> 186<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> 187</tr> 188<tr> 189<td class="parameter_name"><p>size</p></td> 190<td class="parameter_description"><p>the size of <em class="parameter"><code>data</code></em> 191</p></td> 192<td class="parameter_annotations"> </td> 193</tr> 194<tr> 195<td class="parameter_name"><p>ntptime</p></td> 196<td class="parameter_description"><p>the result NTP time. </p></td> 197<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 198</tr> 199</tbody> 200</table></div> 201</div> 202<div class="refsect3"> 203<a name="gst-rtp-hdrext-get-ntp-64.returns"></a><h4>Returns</h4> 204<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p> 205</div> 206</div> 207<hr> 208<div class="refsect2"> 209<a name="gst-rtp-hdrext-set-ntp-56"></a><h3>gst_rtp_hdrext_set_ntp_56 ()</h3> 210<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 211gst_rtp_hdrext_set_ntp_56 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>, 212 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>, 213 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> ntptime</code></em>);</pre> 214<p>Writes the NTP time in <em class="parameter"><code>ntptime</code></em> 215 to the format required for the NTP-56 header 216extension. <em class="parameter"><code>data</code></em> 217 must hold at least <a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-56-SIZE:CAPS" title="GST_RTP_HDREXT_NTP_56_SIZE"><span class="type">GST_RTP_HDREXT_NTP_56_SIZE</span></a> bytes.</p> 218<div class="refsect3"> 219<a name="gst-rtp-hdrext-set-ntp-56.parameters"></a><h4>Parameters</h4> 220<div class="informaltable"><table class="informaltable" width="100%" border="0"> 221<colgroup> 222<col width="150px" class="parameters_name"> 223<col class="parameters_description"> 224<col width="200px" class="parameters_annotations"> 225</colgroup> 226<tbody> 227<tr> 228<td class="parameter_name"><p>data</p></td> 229<td class="parameter_description"><p>the data to write to</p></td> 230<td class="parameter_annotations"> </td> 231</tr> 232<tr> 233<td class="parameter_name"><p>size</p></td> 234<td class="parameter_description"><p>the size of <em class="parameter"><code>data</code></em> 235</p></td> 236<td class="parameter_annotations"> </td> 237</tr> 238<tr> 239<td class="parameter_name"><p>ntptime</p></td> 240<td class="parameter_description"><p>the NTP time</p></td> 241<td class="parameter_annotations"> </td> 242</tr> 243</tbody> 244</table></div> 245</div> 246<div class="refsect3"> 247<a name="gst-rtp-hdrext-set-ntp-56.returns"></a><h4>Returns</h4> 248<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p> 249</div> 250</div> 251<hr> 252<div class="refsect2"> 253<a name="gst-rtp-hdrext-set-ntp-64"></a><h3>gst_rtp_hdrext_set_ntp_64 ()</h3> 254<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 255gst_rtp_hdrext_set_ntp_64 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>, 256 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>, 257 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> ntptime</code></em>);</pre> 258<p>Writes the NTP time in <em class="parameter"><code>ntptime</code></em> 259 to the format required for the NTP-64 header 260extension. <em class="parameter"><code>data</code></em> 261 must hold at least <a class="link" href="gst-plugins-base-libs-GstRtphdrext.html#GST-RTP-HDREXT-NTP-64-SIZE:CAPS" title="GST_RTP_HDREXT_NTP_64_SIZE"><span class="type">GST_RTP_HDREXT_NTP_64_SIZE</span></a> bytes.</p> 262<div class="refsect3"> 263<a name="gst-rtp-hdrext-set-ntp-64.parameters"></a><h4>Parameters</h4> 264<div class="informaltable"><table class="informaltable" width="100%" border="0"> 265<colgroup> 266<col width="150px" class="parameters_name"> 267<col class="parameters_description"> 268<col width="200px" class="parameters_annotations"> 269</colgroup> 270<tbody> 271<tr> 272<td class="parameter_name"><p>data</p></td> 273<td class="parameter_description"><p>the data to write to</p></td> 274<td class="parameter_annotations"> </td> 275</tr> 276<tr> 277<td class="parameter_name"><p>size</p></td> 278<td class="parameter_description"><p>the size of <em class="parameter"><code>data</code></em> 279</p></td> 280<td class="parameter_annotations"> </td> 281</tr> 282<tr> 283<td class="parameter_name"><p>ntptime</p></td> 284<td class="parameter_description"><p>the NTP time</p></td> 285<td class="parameter_annotations"> </td> 286</tr> 287</tbody> 288</table></div> 289</div> 290<div class="refsect3"> 291<a name="gst-rtp-hdrext-set-ntp-64.returns"></a><h4>Returns</h4> 292<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p> 293</div> 294</div> 295</div> 296<div class="refsect1"> 297<a name="gst-plugins-base-libs-GstRtphdrext.other_details"></a><h2>Types and Values</h2> 298<div class="refsect2"> 299<a name="GST-RTP-HDREXT-BASE:CAPS"></a><h3>GST_RTP_HDREXT_BASE</h3> 300<pre class="programlisting">#define GST_RTP_HDREXT_BASE "urn:ietf:params:rtp-hdrext:" 301</pre> 302</div> 303<hr> 304<div class="refsect2"> 305<a name="GST-RTP-HDREXT-NTP-56:CAPS"></a><h3>GST_RTP_HDREXT_NTP_56</h3> 306<pre class="programlisting">#define GST_RTP_HDREXT_NTP_56 "ntp-56" 307</pre> 308</div> 309<hr> 310<div class="refsect2"> 311<a name="GST-RTP-HDREXT-NTP-56-SIZE:CAPS"></a><h3>GST_RTP_HDREXT_NTP_56_SIZE</h3> 312<pre class="programlisting">#define GST_RTP_HDREXT_NTP_56_SIZE 7 313</pre> 314</div> 315<hr> 316<div class="refsect2"> 317<a name="GST-RTP-HDREXT-NTP-64:CAPS"></a><h3>GST_RTP_HDREXT_NTP_64</h3> 318<pre class="programlisting">#define GST_RTP_HDREXT_NTP_64 "ntp-64" 319</pre> 320</div> 321<hr> 322<div class="refsect2"> 323<a name="GST-RTP-HDREXT-NTP-64-SIZE:CAPS"></a><h3>GST_RTP_HDREXT_NTP_64_SIZE</h3> 324<pre class="programlisting">#define GST_RTP_HDREXT_NTP_64_SIZE 8 325</pre> 326</div> 327</div> 328<div class="refsect1"> 329<a name="gst-plugins-base-libs-GstRtphdrext.see-also"></a><h2>See Also</h2> 330<p><a class="link" href="GstRTPBasePayload.html" title="GstRTPBasePayload"><span class="type">GstRTPBasePayload</span></a>, <a class="link" href="GstRTPBaseDepayload.html" title="GstRTPBaseDepayload"><span class="type">GstRTPBaseDepayload</span></a>, gstrtpbuffer</p> 331</div> 332</div> 333<div class="footer"> 334<hr>Generated by GTK-Doc V1.28</div> 335</body> 336</html>
