docs/libs/html/gst-plugins-base-libs-gstrtsprange.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>gstrtsprange</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-rtsp.html" title="RTSP Library">
   9 <link rel="prev" href="gst-plugins-base-libs-gstrtspmessage.html" title="gstrtspmessage">
  10 <link rel="next" href="gst-plugins-base-libs-gstrtsptransport.html" title="gstrtsptransport">
  11 <meta name="generator" content="GTK-Doc V1.18 (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="gst-plugins-base-libs-gstrtspmessage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-rtsp.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-gstrtsptransport.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-gstrtsprange.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstrtsprange.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gstrtsprange"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstrtsprange.top_of_page"></a>gstrtsprange</span></h2>
  34 <p>gstrtsprange — dealing with time ranges</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gst-plugins-base-libs-gstrtsprange.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/rtsp/gstrtsrange.h&gt;
  42
  43 enum                <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPRangeUnit" title="enum GstRTSPRangeUnit">GstRTSPRangeUnit</a>;
  44 struct              <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange">GstRTSPTimeRange</a>;
  45 struct              <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTime" title="struct GstRTSPTime">GstRTSPTime</a>;
  46 enum                <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeType" title="enum GstRTSPTimeType">GstRTSPTimeType</a>;
  47 <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult"><span class="returnvalue">GstRTSPResult</span></a>       <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#gst-rtsp-range-parse" title="gst_rtsp_range_parse ()">gst_rtsp_range_parse</a>                (<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> *rangestr</code></em>,
  48                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a> **range</code></em>);
  49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#gst-rtsp-range-to-string" title="gst_rtsp_range_to_string ()">gst_rtsp_range_to_string</a>            (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a> *range</code></em>);
  50 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#gst-rtsp-range-free" title="gst_rtsp_range_free ()">gst_rtsp_range_free</a>                 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a> *range</code></em>);
  51 </pre>
  52 </div>
  53 <div class="refsect1">
  54 <a name="gst-plugins-base-libs-gstrtsprange.description"></a><h2>Description</h2>
  55 <p>
  56 Provides helper functions to deal with time ranges.
  57
  58 Last reviewed on 2007-07-25 (0.10.14)
  59 </p>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-base-libs-gstrtsprange.details"></a><h2>Details</h2>
  63 <div class="refsect2">
  64 <a name="GstRTSPRangeUnit"></a><h3>enum GstRTSPRangeUnit</h3>
  65 <pre class="programlisting">typedef enum {
  66   GST_RTSP_RANGE_SMPTE,
  67   GST_RTSP_RANGE_SMPTE_30_DROP,
  68   GST_RTSP_RANGE_SMPTE_25,
  69   GST_RTSP_RANGE_NPT,
  70   GST_RTSP_RANGE_CLOCK
  71 } GstRTSPRangeUnit;
  72 </pre>
  73 <p>
  74 Different possible time range units.
  75 </p>
  76 <div class="variablelist"><table border="0">
  77 <col align="left" valign="top">
  78 <tbody>
  79 <tr>
  80 <td><p><a name="GST-RTSP-RANGE-SMPTE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_RANGE_SMPTE</code></span></p></td>
  81 <td>SMPTE timecode
  82 </td>
  83 </tr>
  84 <tr>
  85 <td><p><a name="GST-RTSP-RANGE-SMPTE-30-DROP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_RANGE_SMPTE_30_DROP</code></span></p></td>
  86 <td>29.97 frames per second
  87 </td>
  88 </tr>
  89 <tr>
  90 <td><p><a name="GST-RTSP-RANGE-SMPTE-25:CAPS"></a><span class="term"><code class="literal">GST_RTSP_RANGE_SMPTE_25</code></span></p></td>
  91 <td>25 frames per second
  92 </td>
  93 </tr>
  94 <tr>
  95 <td><p><a name="GST-RTSP-RANGE-NPT:CAPS"></a><span class="term"><code class="literal">GST_RTSP_RANGE_NPT</code></span></p></td>
  96 <td>Normal play time
  97 </td>
  98 </tr>
  99 <tr>
 100 <td><p><a name="GST-RTSP-RANGE-CLOCK:CAPS"></a><span class="term"><code class="literal">GST_RTSP_RANGE_CLOCK</code></span></p></td>
 101 <td>Absolute time expressed as ISO 8601 timestamps
 102 </td>
 103 </tr>
 104 </tbody>
 105 </table></div>
 106 </div>
 107 <hr>
 108 <div class="refsect2">
 109 <a name="GstRTSPTimeRange"></a><h3>struct GstRTSPTimeRange</h3>
 110 <pre class="programlisting">struct GstRTSPTimeRange {
 111   GstRTSPRangeUnit unit;
 112
 113   GstRTSPTime min;
 114   GstRTSPTime max;
 115 };
 116 </pre>
 117 <p>
 118 A time range.
 119 </p>
 120 <div class="variablelist"><table border="0">
 121 <col align="left" valign="top">
 122 <tbody>
 123 <tr>
 124 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPRangeUnit" title="enum GstRTSPRangeUnit"><span class="type">GstRTSPRangeUnit</span></a> <em class="structfield"><code><a name="GstRTSPTimeRange.unit"></a>unit</code></em>;</span></p></td>
 125 <td>the time units used</td>
 126 </tr>
 127 <tr>
 128 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTime" title="struct GstRTSPTime"><span class="type">GstRTSPTime</span></a> <em class="structfield"><code><a name="GstRTSPTimeRange.min"></a>min</code></em>;</span></p></td>
 129 <td>the minimum interval</td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTime" title="struct GstRTSPTime"><span class="type">GstRTSPTime</span></a> <em class="structfield"><code><a name="GstRTSPTimeRange.max"></a>max</code></em>;</span></p></td>
 133 <td>the maximum interval</td>
 134 </tr>
 135 </tbody>
 136 </table></div>
 137 </div>
 138 <hr>
 139 <div class="refsect2">
 140 <a name="GstRTSPTime"></a><h3>struct GstRTSPTime</h3>
 141 <pre class="programlisting">struct GstRTSPTime {
 142   GstRTSPTimeType type;
 143   gdouble         seconds;
 144 };
 145 </pre>
 146 <p>
 147 A time indication.
 148 </p>
 149 <div class="variablelist"><table border="0">
 150 <col align="left" valign="top">
 151 <tbody>
 152 <tr>
 153 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeType" title="enum GstRTSPTimeType"><span class="type">GstRTSPTimeType</span></a> <em class="structfield"><code><a name="GstRTSPTime.type"></a>type</code></em>;</span></p></td>
 154 <td>the time of the time</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> <em class="structfield"><code><a name="GstRTSPTime.seconds"></a>seconds</code></em>;</span></p></td>
 158 <td>seconds when <em class="parameter"><code>type</code></em> is GST_RTSP_TIME_SECONDS</td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 </div>
 163 <hr>
 164 <div class="refsect2">
 165 <a name="GstRTSPTimeType"></a><h3>enum GstRTSPTimeType</h3>
 166 <pre class="programlisting">typedef enum {
 167   GST_RTSP_TIME_SECONDS,
 168   GST_RTSP_TIME_NOW,
 169   GST_RTSP_TIME_END
 170 } GstRTSPTimeType;
 171 </pre>
 172 <p>
 173 Possible time types.
 174 </p>
 175 <div class="variablelist"><table border="0">
 176 <col align="left" valign="top">
 177 <tbody>
 178 <tr>
 179 <td><p><a name="GST-RTSP-TIME-SECONDS:CAPS"></a><span class="term"><code class="literal">GST_RTSP_TIME_SECONDS</code></span></p></td>
 180 <td>seconds
 181 </td>
 182 </tr>
 183 <tr>
 184 <td><p><a name="GST-RTSP-TIME-NOW:CAPS"></a><span class="term"><code class="literal">GST_RTSP_TIME_NOW</code></span></p></td>
 185 <td>now
 186 </td>
 187 </tr>
 188 <tr>
 189 <td><p><a name="GST-RTSP-TIME-END:CAPS"></a><span class="term"><code class="literal">GST_RTSP_TIME_END</code></span></p></td>
 190 <td>end
 191 </td>
 192 </tr>
 193 </tbody>
 194 </table></div>
 195 </div>
 196 <hr>
 197 <div class="refsect2">
 198 <a name="gst-rtsp-range-parse"></a><h3>gst_rtsp_range_parse ()</h3>
 199 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult"><span class="returnvalue">GstRTSPResult</span></a>       gst_rtsp_range_parse                (<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> *rangestr</code></em>,
 200                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a> **range</code></em>);</pre>
 201 <p>
 202 Parse <em class="parameter"><code>rangestr</code></em> to a <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a>.
 203 </p>
 204 <div class="variablelist"><table border="0">
 205 <col align="left" valign="top">
 206 <tbody>
 207 <tr>
 208 <td><p><span class="term"><em class="parameter"><code>rangestr</code></em> :</span></p></td>
 209 <td>a range string to parse</td>
 210 </tr>
 211 <tr>
 212 <td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td>
 213 <td>location to hold the <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a> result</td>
 214 </tr>
 215 <tr>
 216 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 217 <td>
 218 <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GST-RTSP-OK:CAPS"><span class="type">GST_RTSP_OK</span></a> on success.</td>
 219 </tr>
 220 </tbody>
 221 </table></div>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="gst-rtsp-range-to-string"></a><h3>gst_rtsp_range_to_string ()</h3>
 226 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gst_rtsp_range_to_string            (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a> *range</code></em>);</pre>
 227 <p>
 228 Convert <em class="parameter"><code>range</code></em> into a string representation.
 229 </p>
 230 <div class="variablelist"><table border="0">
 231 <col align="left" valign="top">
 232 <tbody>
 233 <tr>
 234 <td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td>
 235 <td>a <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a>
 236 </td>
 237 </tr>
 238 <tr>
 239 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 240 <td>The string representation of <em class="parameter"><code>range</code></em>. <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> after usage.</td>
 241 </tr>
 242 </tbody>
 243 </table></div>
 244 <p class="since">Since 0.10.23</p>
 245 </div>
 246 <hr>
 247 <div class="refsect2">
 248 <a name="gst-rtsp-range-free"></a><h3>gst_rtsp_range_free ()</h3>
 249 <pre class="programlisting"><span class="returnvalue">void</span>                gst_rtsp_range_free                 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a> *range</code></em>);</pre>
 250 <p>
 251 Free the memory allocated by <em class="parameter"><code>range</code></em>.
 252 </p>
 253 <div class="variablelist"><table border="0">
 254 <col align="left" valign="top">
 255 <tbody><tr>
 256 <td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td>
 257 <td>a <a class="link" href="gst-plugins-base-libs-gstrtsprange.html#GstRTSPTimeRange" title="struct GstRTSPTimeRange"><span class="type">GstRTSPTimeRange</span></a>
 258 </td>
 259 </tr></tbody>
 260 </table></div>
 261 </div>
 262 </div>
 263 </div>
 264 <div class="footer">
 265 <hr>
 266           Generated by GTK-Doc V1.18</div>
 267 </body>
 268 </html>