docs/libs/html/gst-plugins-base-libs-gstrtspdefs.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>gstrtspdefs</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-gstrtspconnection.html" title="gstrtspconnection">
  10 <link rel="next" href="gst-plugins-base-libs-gstrtspextension.html" title="gstrtspextension">
  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-gstrtspconnection.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-gstrtspextension.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-gstrtspdefs.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstrtspdefs.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gstrtspdefs"></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-gstrtspdefs.top_of_page"></a>gstrtspdefs</span></h2>
  34 <p>gstrtspdefs — common RTSP defines</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-gstrtspdefs.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/rtsp/gstrtspdefs.h&gt;
  42
  43 #define             <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GST-RTSP-CHECK:CAPS" title="GST_RTSP_CHECK()">GST_RTSP_CHECK</a>                      (stmt,
  44                                                          label)
  45 #define             <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GST-RTSP-AUTH-MAX:CAPS" title="GST_RTSP_AUTH_MAX">GST_RTSP_AUTH_MAX</a>
  46 enum                <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPEvent" title="enum GstRTSPEvent">GstRTSPEvent</a>;
  47 enum                <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult">GstRTSPResult</a>;
  48 enum                <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPFamily" title="enum GstRTSPFamily">GstRTSPFamily</a>;
  49 enum                <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPState" title="enum GstRTSPState">GstRTSPState</a>;
  50 enum                <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPVersion" title="enum GstRTSPVersion">GstRTSPVersion</a>;
  51 enum                <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod">GstRTSPMethod</a>;
  52 enum                <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPAuthMethod" title="enum GstRTSPAuthMethod">GstRTSPAuthMethod</a>;
  53 enum                <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField">GstRTSPHeaderField</a>;
  54 enum                <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPStatusCode" title="enum GstRTSPStatusCode">GstRTSPStatusCode</a>;
  55 <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-gstrtspdefs.html#gst-rtsp-strresult" title="gst_rtsp_strresult ()">gst_rtsp_strresult</a>                  (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult"><span class="type">GstRTSPResult</span></a> result</code></em>);
  56 const <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-gstrtspdefs.html#gst-rtsp-method-as-text" title="gst_rtsp_method_as_text ()">gst_rtsp_method_as_text</a>             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a> method</code></em>);
  57 const <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-gstrtspdefs.html#gst-rtsp-version-as-text" title="gst_rtsp_version_as_text ()">gst_rtsp_version_as_text</a>            (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPVersion" title="enum GstRTSPVersion"><span class="type">GstRTSPVersion</span></a> version</code></em>);
  58 const <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-gstrtspdefs.html#gst-rtsp-header-as-text" title="gst_rtsp_header_as_text ()">gst_rtsp_header_as_text</a>             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a> field</code></em>);
  59 <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-gstrtspdefs.html#gst-rtsp-header-allow-multiple" title="gst_rtsp_header_allow_multiple ()">gst_rtsp_header_allow_multiple</a>      (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a> field</code></em>);
  60 const <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-gstrtspdefs.html#gst-rtsp-status-as-text" title="gst_rtsp_status_as_text ()">gst_rtsp_status_as_text</a>             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPStatusCode" title="enum GstRTSPStatusCode"><span class="type">GstRTSPStatusCode</span></a> code</code></em>);
  61 <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-gstrtspdefs.html#gst-rtsp-options-as-text" title="gst_rtsp_options_as_text ()">gst_rtsp_options_as_text</a>            (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a> options</code></em>);
  62 <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="returnvalue">GstRTSPHeaderField</span></a>  <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#gst-rtsp-find-header-field" title="gst_rtsp_find_header_field ()">gst_rtsp_find_header_field</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> *header</code></em>);
  63 <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="returnvalue">GstRTSPMethod</span></a>       <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#gst-rtsp-find-method" title="gst_rtsp_find_method ()">gst_rtsp_find_method</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> *method</code></em>);
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-base-libs-gstrtspdefs.description"></a><h2>Description</h2>
  68 <p>
  69 Provides common defines for the RTSP library.
  70
  71 Last reviewed on 2007-07-24 (0.10.14)
  72 </p>
  73 </div>
  74 <div class="refsect1">
  75 <a name="gst-plugins-base-libs-gstrtspdefs.details"></a><h2>Details</h2>
  76 <div class="refsect2">
  77 <a name="GST-RTSP-CHECK:CAPS"></a><h3>GST_RTSP_CHECK()</h3>
  78 <pre class="programlisting">#define             GST_RTSP_CHECK(stmt, label)</pre>
  79 <p>
  80 Macro that checks the return value of <em class="parameter"><code>stmt</code></em> and jumps to <em class="parameter"><code>label</code></em> when it does
  81 not equal <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GST-RTSP-OK:CAPS"><span class="type">GST_RTSP_OK</span></a>.
  82 </p>
  83 <div class="variablelist"><table border="0">
  84 <col align="left" valign="top">
  85 <tbody>
  86 <tr>
  87 <td><p><span class="term"><em class="parameter"><code>stmt</code></em> :</span></p></td>
  88 <td>a statement</td>
  89 </tr>
  90 <tr>
  91 <td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
  92 <td>a label</td>
  93 </tr>
  94 </tbody>
  95 </table></div>
  96 </div>
  97 <hr>
  98 <div class="refsect2">
  99 <a name="GST-RTSP-AUTH-MAX:CAPS"></a><h3>GST_RTSP_AUTH_MAX</h3>
 100 <pre class="programlisting">#define GST_RTSP_AUTH_MAX GST_RTSP_AUTH_DIGEST
 101 </pre>
 102 <p>
 103 Strongest available authentication method
 104 </p>
 105 </div>
 106 <hr>
 107 <div class="refsect2">
 108 <a name="GstRTSPEvent"></a><h3>enum GstRTSPEvent</h3>
 109 <pre class="programlisting">typedef enum {
 110   GST_RTSP_EV_READ  = (1 &lt;&lt; 0),
 111   GST_RTSP_EV_WRITE = (1 &lt;&lt; 1)
 112 } GstRTSPEvent;
 113 </pre>
 114 <p>
 115 The possible events for the connection.
 116 </p>
 117 <div class="variablelist"><table border="0">
 118 <col align="left" valign="top">
 119 <tbody>
 120 <tr>
 121 <td><p><a name="GST-RTSP-EV-READ:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EV_READ</code></span></p></td>
 122 <td>connection is readable
 123 </td>
 124 </tr>
 125 <tr>
 126 <td><p><a name="GST-RTSP-EV-WRITE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EV_WRITE</code></span></p></td>
 127 <td>connection is writable
 128 </td>
 129 </tr>
 130 </tbody>
 131 </table></div>
 132 </div>
 133 <hr>
 134 <div class="refsect2">
 135 <a name="GstRTSPResult"></a><h3>enum GstRTSPResult</h3>
 136 <pre class="programlisting">typedef enum {
 137   GST_RTSP_OK          =  0,
 138   /* errors */
 139   GST_RTSP_ERROR       = -1,
 140   GST_RTSP_EINVAL      = -2,
 141   GST_RTSP_EINTR       = -3,
 142   GST_RTSP_ENOMEM      = -4,
 143   GST_RTSP_ERESOLV     = -5,
 144   GST_RTSP_ENOTIMPL    = -6,
 145   GST_RTSP_ESYS        = -7,
 146   GST_RTSP_EPARSE      = -8,
 147   GST_RTSP_EWSASTART   = -9,
 148   GST_RTSP_EWSAVERSION = -10,
 149   GST_RTSP_EEOF        = -11,
 150   GST_RTSP_ENET        = -12,
 151   GST_RTSP_ENOTIP      = -13,
 152   GST_RTSP_ETIMEOUT    = -14,
 153   GST_RTSP_ETGET       = -15,
 154   GST_RTSP_ETPOST      = -16,
 155
 156   GST_RTSP_ELAST       = -17
 157 } GstRTSPResult;
 158 </pre>
 159 <p>
 160 Result codes from the RTSP functions.
 161 </p>
 162 <div class="variablelist"><table border="0">
 163 <col align="left" valign="top">
 164 <tbody>
 165 <tr>
 166 <td><p><a name="GST-RTSP-OK:CAPS"></a><span class="term"><code class="literal">GST_RTSP_OK</code></span></p></td>
 167 <td>no error
 168 </td>
 169 </tr>
 170 <tr>
 171 <td><p><a name="GST-RTSP-ERROR:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ERROR</code></span></p></td>
 172 <td>some unspecified error occured
 173 </td>
 174 </tr>
 175 <tr>
 176 <td><p><a name="GST-RTSP-EINVAL:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EINVAL</code></span></p></td>
 177 <td>invalid arguments were provided to a function
 178 </td>
 179 </tr>
 180 <tr>
 181 <td><p><a name="GST-RTSP-EINTR:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EINTR</code></span></p></td>
 182 <td>an operation was canceled
 183 </td>
 184 </tr>
 185 <tr>
 186 <td><p><a name="GST-RTSP-ENOMEM:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ENOMEM</code></span></p></td>
 187 <td>no memory was available for the operation
 188 </td>
 189 </tr>
 190 <tr>
 191 <td><p><a name="GST-RTSP-ERESOLV:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ERESOLV</code></span></p></td>
 192 <td>a host resolve error occured
 193 </td>
 194 </tr>
 195 <tr>
 196 <td><p><a name="GST-RTSP-ENOTIMPL:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ENOTIMPL</code></span></p></td>
 197 <td>function not implemented
 198 </td>
 199 </tr>
 200 <tr>
 201 <td><p><a name="GST-RTSP-ESYS:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ESYS</code></span></p></td>
 202 <td>a system error occured, errno contains more details
 203 </td>
 204 </tr>
 205 <tr>
 206 <td><p><a name="GST-RTSP-EPARSE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EPARSE</code></span></p></td>
 207 <td>a persing error occured
 208 </td>
 209 </tr>
 210 <tr>
 211 <td><p><a name="GST-RTSP-EWSASTART:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EWSASTART</code></span></p></td>
 212 <td>windows networking could not start
 213 </td>
 214 </tr>
 215 <tr>
 216 <td><p><a name="GST-RTSP-EWSAVERSION:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EWSAVERSION</code></span></p></td>
 217 <td>windows networking stack has wrong version
 218 </td>
 219 </tr>
 220 <tr>
 221 <td><p><a name="GST-RTSP-EEOF:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EEOF</code></span></p></td>
 222 <td>end-of-file was reached
 223 </td>
 224 </tr>
 225 <tr>
 226 <td><p><a name="GST-RTSP-ENET:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ENET</code></span></p></td>
 227 <td>a network problem occured, h_errno contains more details
 228 </td>
 229 </tr>
 230 <tr>
 231 <td><p><a name="GST-RTSP-ENOTIP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ENOTIP</code></span></p></td>
 232 <td>the host is not an IP host
 233 </td>
 234 </tr>
 235 <tr>
 236 <td><p><a name="GST-RTSP-ETIMEOUT:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ETIMEOUT</code></span></p></td>
 237 <td>a timeout occured
 238 </td>
 239 </tr>
 240 <tr>
 241 <td><p><a name="GST-RTSP-ETGET:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ETGET</code></span></p></td>
 242 <td>the tunnel GET request has been performed
 243 </td>
 244 </tr>
 245 <tr>
 246 <td><p><a name="GST-RTSP-ETPOST:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ETPOST</code></span></p></td>
 247 <td>the tunnel POST request has been performed
 248 </td>
 249 </tr>
 250 <tr>
 251 <td><p><a name="GST-RTSP-ELAST:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ELAST</code></span></p></td>
 252 <td>last error
 253 </td>
 254 </tr>
 255 </tbody>
 256 </table></div>
 257 </div>
 258 <hr>
 259 <div class="refsect2">
 260 <a name="GstRTSPFamily"></a><h3>enum GstRTSPFamily</h3>
 261 <pre class="programlisting">typedef enum {
 262   GST_RTSP_FAM_NONE,
 263   GST_RTSP_FAM_INET,
 264   GST_RTSP_FAM_INET6
 265 } GstRTSPFamily;
 266 </pre>
 267 <p>
 268 The possible network families.
 269 </p>
 270 <div class="variablelist"><table border="0">
 271 <col align="left" valign="top">
 272 <tbody>
 273 <tr>
 274 <td><p><a name="GST-RTSP-FAM-NONE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_FAM_NONE</code></span></p></td>
 275 <td>unknown network family
 276 </td>
 277 </tr>
 278 <tr>
 279 <td><p><a name="GST-RTSP-FAM-INET:CAPS"></a><span class="term"><code class="literal">GST_RTSP_FAM_INET</code></span></p></td>
 280 <td>internet
 281 </td>
 282 </tr>
 283 <tr>
 284 <td><p><a name="GST-RTSP-FAM-INET6:CAPS"></a><span class="term"><code class="literal">GST_RTSP_FAM_INET6</code></span></p></td>
 285 <td>internet V6
 286 </td>
 287 </tr>
 288 </tbody>
 289 </table></div>
 290 </div>
 291 <hr>
 292 <div class="refsect2">
 293 <a name="GstRTSPState"></a><h3>enum GstRTSPState</h3>
 294 <pre class="programlisting">typedef enum {
 295   GST_RTSP_STATE_INVALID,
 296   GST_RTSP_STATE_INIT,
 297   GST_RTSP_STATE_READY,
 298   GST_RTSP_STATE_SEEKING,
 299   GST_RTSP_STATE_PLAYING,
 300   GST_RTSP_STATE_RECORDING
 301 } GstRTSPState;
 302 </pre>
 303 <p>
 304 The different RTSP states.
 305 </p>
 306 <div class="variablelist"><table border="0">
 307 <col align="left" valign="top">
 308 <tbody>
 309 <tr>
 310 <td><p><a name="GST-RTSP-STATE-INVALID:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_INVALID</code></span></p></td>
 311 <td>invalid state
 312 </td>
 313 </tr>
 314 <tr>
 315 <td><p><a name="GST-RTSP-STATE-INIT:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_INIT</code></span></p></td>
 316 <td>initializing
 317 </td>
 318 </tr>
 319 <tr>
 320 <td><p><a name="GST-RTSP-STATE-READY:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_READY</code></span></p></td>
 321 <td>ready for operation
 322 </td>
 323 </tr>
 324 <tr>
 325 <td><p><a name="GST-RTSP-STATE-SEEKING:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_SEEKING</code></span></p></td>
 326 <td>seeking in progress
 327 </td>
 328 </tr>
 329 <tr>
 330 <td><p><a name="GST-RTSP-STATE-PLAYING:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_PLAYING</code></span></p></td>
 331 <td>playing
 332 </td>
 333 </tr>
 334 <tr>
 335 <td><p><a name="GST-RTSP-STATE-RECORDING:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_RECORDING</code></span></p></td>
 336 <td>recording
 337 </td>
 338 </tr>
 339 </tbody>
 340 </table></div>
 341 </div>
 342 <hr>
 343 <div class="refsect2">
 344 <a name="GstRTSPVersion"></a><h3>enum GstRTSPVersion</h3>
 345 <pre class="programlisting">typedef enum {
 346   GST_RTSP_VERSION_INVALID = 0x00,
 347   GST_RTSP_VERSION_1_0     = 0x10,
 348   GST_RTSP_VERSION_1_1     = 0x11
 349 } GstRTSPVersion;
 350 </pre>
 351 <p>
 352 The supported RTSP versions.
 353 </p>
 354 <div class="variablelist"><table border="0">
 355 <col align="left" valign="top">
 356 <tbody>
 357 <tr>
 358 <td><p><a name="GST-RTSP-VERSION-INVALID:CAPS"></a><span class="term"><code class="literal">GST_RTSP_VERSION_INVALID</code></span></p></td>
 359 <td>unknown/invalid version
 360 </td>
 361 </tr>
 362 <tr>
 363 <td><p><a name="GST-RTSP-VERSION-1-0:CAPS"></a><span class="term"><code class="literal">GST_RTSP_VERSION_1_0</code></span></p></td>
 364 <td>version 1.0
 365 </td>
 366 </tr>
 367 <tr>
 368 <td><p><a name="GST-RTSP-VERSION-1-1:CAPS"></a><span class="term"><code class="literal">GST_RTSP_VERSION_1_1</code></span></p></td>
 369 <td>version 1.1. Since 0.10.25
 370 </td>
 371 </tr>
 372 </tbody>
 373 </table></div>
 374 </div>
 375 <hr>
 376 <div class="refsect2">
 377 <a name="GstRTSPMethod"></a><h3>enum GstRTSPMethod</h3>
 378 <pre class="programlisting">typedef enum {
 379   GST_RTSP_INVALID          = 0,
 380   GST_RTSP_DESCRIBE         = (1 &lt;&lt;  0),
 381   GST_RTSP_ANNOUNCE         = (1 &lt;&lt;  1),
 382   GST_RTSP_GET_PARAMETER    = (1 &lt;&lt;  2),
 383   GST_RTSP_OPTIONS          = (1 &lt;&lt;  3),
 384   GST_RTSP_PAUSE            = (1 &lt;&lt;  4),
 385   GST_RTSP_PLAY             = (1 &lt;&lt;  5),
 386   GST_RTSP_RECORD           = (1 &lt;&lt;  6),
 387   GST_RTSP_REDIRECT         = (1 &lt;&lt;  7),
 388   GST_RTSP_SETUP            = (1 &lt;&lt;  8),
 389   GST_RTSP_SET_PARAMETER    = (1 &lt;&lt;  9),
 390   GST_RTSP_TEARDOWN         = (1 &lt;&lt; 10),
 391   GST_RTSP_GET              = (1 &lt;&lt; 11),
 392   GST_RTSP_POST             = (1 &lt;&lt; 12)
 393 } GstRTSPMethod;
 394 </pre>
 395 <p>
 396 The different supported RTSP methods.
 397 </p>
 398 <div class="variablelist"><table border="0">
 399 <col align="left" valign="top">
 400 <tbody>
 401 <tr>
 402 <td><p><a name="GST-RTSP-INVALID:CAPS"></a><span class="term"><code class="literal">GST_RTSP_INVALID</code></span></p></td>
 403 <td>invalid method
 404 </td>
 405 </tr>
 406 <tr>
 407 <td><p><a name="GST-RTSP-DESCRIBE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_DESCRIBE</code></span></p></td>
 408 <td>the DESCRIBE method
 409 </td>
 410 </tr>
 411 <tr>
 412 <td><p><a name="GST-RTSP-ANNOUNCE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ANNOUNCE</code></span></p></td>
 413 <td>the ANNOUNCE method
 414 </td>
 415 </tr>
 416 <tr>
 417 <td><p><a name="GST-RTSP-GET-PARAMETER:CAPS"></a><span class="term"><code class="literal">GST_RTSP_GET_PARAMETER</code></span></p></td>
 418 <td>the GET_PARAMETER method
 419 </td>
 420 </tr>
 421 <tr>
 422 <td><p><a name="GST-RTSP-OPTIONS:CAPS"></a><span class="term"><code class="literal">GST_RTSP_OPTIONS</code></span></p></td>
 423 <td>the OPTIONS method
 424 </td>
 425 </tr>
 426 <tr>
 427 <td><p><a name="GST-RTSP-PAUSE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_PAUSE</code></span></p></td>
 428 <td>the PAUSE method
 429 </td>
 430 </tr>
 431 <tr>
 432 <td><p><a name="GST-RTSP-PLAY:CAPS"></a><span class="term"><code class="literal">GST_RTSP_PLAY</code></span></p></td>
 433 <td>the PLAY method
 434 </td>
 435 </tr>
 436 <tr>
 437 <td><p><a name="GST-RTSP-RECORD:CAPS"></a><span class="term"><code class="literal">GST_RTSP_RECORD</code></span></p></td>
 438 <td>the RECORD method
 439 </td>
 440 </tr>
 441 <tr>
 442 <td><p><a name="GST-RTSP-REDIRECT:CAPS"></a><span class="term"><code class="literal">GST_RTSP_REDIRECT</code></span></p></td>
 443 <td>the REDIRECT method
 444 </td>
 445 </tr>
 446 <tr>
 447 <td><p><a name="GST-RTSP-SETUP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_SETUP</code></span></p></td>
 448 <td>the SETUP method
 449 </td>
 450 </tr>
 451 <tr>
 452 <td><p><a name="GST-RTSP-SET-PARAMETER:CAPS"></a><span class="term"><code class="literal">GST_RTSP_SET_PARAMETER</code></span></p></td>
 453 <td>the SET_PARAMETER method
 454 </td>
 455 </tr>
 456 <tr>
 457 <td><p><a name="GST-RTSP-TEARDOWN:CAPS"></a><span class="term"><code class="literal">GST_RTSP_TEARDOWN</code></span></p></td>
 458 <td>the TEARDOWN method
 459 </td>
 460 </tr>
 461 <tr>
 462 <td><p><a name="GST-RTSP-GET:CAPS"></a><span class="term"><code class="literal">GST_RTSP_GET</code></span></p></td>
 463 <td>the GET method (HTTP). Since 0.10.25
 464 </td>
 465 </tr>
 466 <tr>
 467 <td><p><a name="GST-RTSP-POST:CAPS"></a><span class="term"><code class="literal">GST_RTSP_POST</code></span></p></td>
 468 <td>the POST method (HTTP). Since 0.10.25
 469 </td>
 470 </tr>
 471 </tbody>
 472 </table></div>
 473 </div>
 474 <hr>
 475 <div class="refsect2">
 476 <a name="GstRTSPAuthMethod"></a><h3>enum GstRTSPAuthMethod</h3>
 477 <pre class="programlisting">typedef enum {
 478   GST_RTSP_AUTH_NONE    = 0x00,
 479   GST_RTSP_AUTH_BASIC   = 0x01,
 480   GST_RTSP_AUTH_DIGEST  = 0x02
 481 } GstRTSPAuthMethod;
 482 </pre>
 483 <p>
 484 Authentication methods, ordered by strength
 485 </p>
 486 <div class="variablelist"><table border="0">
 487 <col align="left" valign="top">
 488 <tbody>
 489 <tr>
 490 <td><p><a name="GST-RTSP-AUTH-NONE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_AUTH_NONE</code></span></p></td>
 491 <td>no authentication
 492 </td>
 493 </tr>
 494 <tr>
 495 <td><p><a name="GST-RTSP-AUTH-BASIC:CAPS"></a><span class="term"><code class="literal">GST_RTSP_AUTH_BASIC</code></span></p></td>
 496 <td>basic authentication
 497 </td>
 498 </tr>
 499 <tr>
 500 <td><p><a name="GST-RTSP-AUTH-DIGEST:CAPS"></a><span class="term"><code class="literal">GST_RTSP_AUTH_DIGEST</code></span></p></td>
 501 <td>digest authentication
 502 </td>
 503 </tr>
 504 </tbody>
 505 </table></div>
 506 </div>
 507 <hr>
 508 <div class="refsect2">
 509 <a name="GstRTSPHeaderField"></a><h3>enum GstRTSPHeaderField</h3>
 510 <pre class="programlisting">typedef enum {
 511 } GstRTSPHeaderField;
 512 </pre>
 513 <p>
 514 Enumeration of rtsp header fields.
 515 </p>
 516 </div>
 517 <hr>
 518 <div class="refsect2">
 519 <a name="GstRTSPStatusCode"></a><h3>enum GstRTSPStatusCode</h3>
 520 <pre class="programlisting">typedef enum {
 521 } GstRTSPStatusCode;
 522 </pre>
 523 <p>
 524 Enumeration of rtsp status codes.
 525 </p>
 526 </div>
 527 <hr>
 528 <div class="refsect2">
 529 <a name="gst-rtsp-strresult"></a><h3>gst_rtsp_strresult ()</h3>
 530 <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_strresult                  (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult"><span class="type">GstRTSPResult</span></a> result</code></em>);</pre>
 531 <p>
 532 Convert <em class="parameter"><code>result</code></em> in a human readable string.
 533 </p>
 534 <div class="variablelist"><table border="0">
 535 <col align="left" valign="top">
 536 <tbody>
 537 <tr>
 538 <td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 539 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult"><span class="type">GstRTSPResult</span></a>
 540 </td>
 541 </tr>
 542 <tr>
 543 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 544 <td>a newly allocated string. <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>
 545 </tr>
 546 </tbody>
 547 </table></div>
 548 </div>
 549 <hr>
 550 <div class="refsect2">
 551 <a name="gst-rtsp-method-as-text"></a><h3>gst_rtsp_method_as_text ()</h3>
 552 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_rtsp_method_as_text             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a> method</code></em>);</pre>
 553 <p>
 554 Convert <em class="parameter"><code>method</code></em> to a string.
 555 </p>
 556 <div class="variablelist"><table border="0">
 557 <col align="left" valign="top">
 558 <tbody>
 559 <tr>
 560 <td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 561 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a>
 562 </td>
 563 </tr>
 564 <tr>
 565 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 566 <td>a string representation of <em class="parameter"><code>method</code></em>.</td>
 567 </tr>
 568 </tbody>
 569 </table></div>
 570 </div>
 571 <hr>
 572 <div class="refsect2">
 573 <a name="gst-rtsp-version-as-text"></a><h3>gst_rtsp_version_as_text ()</h3>
 574 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_rtsp_version_as_text            (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPVersion" title="enum GstRTSPVersion"><span class="type">GstRTSPVersion</span></a> version</code></em>);</pre>
 575 <p>
 576 Convert <em class="parameter"><code>version</code></em> to a string.
 577 </p>
 578 <div class="variablelist"><table border="0">
 579 <col align="left" valign="top">
 580 <tbody>
 581 <tr>
 582 <td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
 583 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPVersion" title="enum GstRTSPVersion"><span class="type">GstRTSPVersion</span></a>
 584 </td>
 585 </tr>
 586 <tr>
 587 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 588 <td>a string representation of <em class="parameter"><code>version</code></em>.</td>
 589 </tr>
 590 </tbody>
 591 </table></div>
 592 </div>
 593 <hr>
 594 <div class="refsect2">
 595 <a name="gst-rtsp-header-as-text"></a><h3>gst_rtsp_header_as_text ()</h3>
 596 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_rtsp_header_as_text             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a> field</code></em>);</pre>
 597 <p>
 598 Convert <em class="parameter"><code>field</code></em> to a string.
 599 </p>
 600 <div class="variablelist"><table border="0">
 601 <col align="left" valign="top">
 602 <tbody>
 603 <tr>
 604 <td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
 605 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a>
 606 </td>
 607 </tr>
 608 <tr>
 609 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 610 <td>a string representation of <em class="parameter"><code>field</code></em>.</td>
 611 </tr>
 612 </tbody>
 613 </table></div>
 614 </div>
 615 <hr>
 616 <div class="refsect2">
 617 <a name="gst-rtsp-header-allow-multiple"></a><h3>gst_rtsp_header_allow_multiple ()</h3>
 618 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_rtsp_header_allow_multiple      (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a> field</code></em>);</pre>
 619 <p>
 620 Check whether <em class="parameter"><code>field</code></em> may appear multiple times in a message.
 621 </p>
 622 <div class="variablelist"><table border="0">
 623 <col align="left" valign="top">
 624 <tbody>
 625 <tr>
 626 <td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
 627 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a>
 628 </td>
 629 </tr>
 630 <tr>
 631 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 632 <td>
 633 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if multiple headers are allowed.</td>
 634 </tr>
 635 </tbody>
 636 </table></div>
 637 <p class="since">Since 0.10.25</p>
 638 </div>
 639 <hr>
 640 <div class="refsect2">
 641 <a name="gst-rtsp-status-as-text"></a><h3>gst_rtsp_status_as_text ()</h3>
 642 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_rtsp_status_as_text             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPStatusCode" title="enum GstRTSPStatusCode"><span class="type">GstRTSPStatusCode</span></a> code</code></em>);</pre>
 643 <p>
 644 Convert <em class="parameter"><code>code</code></em> to a string.
 645 </p>
 646 <div class="variablelist"><table border="0">
 647 <col align="left" valign="top">
 648 <tbody>
 649 <tr>
 650 <td><p><span class="term"><em class="parameter"><code>code</code></em> :</span></p></td>
 651 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPStatusCode" title="enum GstRTSPStatusCode"><span class="type">GstRTSPStatusCode</span></a>
 652 </td>
 653 </tr>
 654 <tr>
 655 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 656 <td>a string representation of <em class="parameter"><code>code</code></em>.</td>
 657 </tr>
 658 </tbody>
 659 </table></div>
 660 </div>
 661 <hr>
 662 <div class="refsect2">
 663 <a name="gst-rtsp-options-as-text"></a><h3>gst_rtsp_options_as_text ()</h3>
 664 <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_options_as_text            (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a> options</code></em>);</pre>
 665 <p>
 666 Convert <em class="parameter"><code>options</code></em> to a string.
 667 </p>
 668 <div class="variablelist"><table border="0">
 669 <col align="left" valign="top">
 670 <tbody>
 671 <tr>
 672 <td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
 673 <td>one or more <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a>
 674 </td>
 675 </tr>
 676 <tr>
 677 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 678 <td>a new string of <em class="parameter"><code>options</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>
 679 </tr>
 680 </tbody>
 681 </table></div>
 682 <p class="since">Since 0.10.23</p>
 683 </div>
 684 <hr>
 685 <div class="refsect2">
 686 <a name="gst-rtsp-find-header-field"></a><h3>gst_rtsp_find_header_field ()</h3>
 687 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="returnvalue">GstRTSPHeaderField</span></a>  gst_rtsp_find_header_field          (<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> *header</code></em>);</pre>
 688 <p>
 689 Convert <em class="parameter"><code>header</code></em> to a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a>.
 690 </p>
 691 <div class="variablelist"><table border="0">
 692 <col align="left" valign="top">
 693 <tbody>
 694 <tr>
 695 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
 696 <td>a header string</td>
 697 </tr>
 698 <tr>
 699 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 700 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a> for <em class="parameter"><code>header</code></em> or <span class="type">GST_RTSP_HDR_INVALID</span> if the
 701 header field is unknown.</td>
 702 </tr>
 703 </tbody>
 704 </table></div>
 705 </div>
 706 <hr>
 707 <div class="refsect2">
 708 <a name="gst-rtsp-find-method"></a><h3>gst_rtsp_find_method ()</h3>
 709 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="returnvalue">GstRTSPMethod</span></a>       gst_rtsp_find_method                (<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> *method</code></em>);</pre>
 710 <p>
 711 Convert <em class="parameter"><code>method</code></em> to a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a>.
 712 </p>
 713 <div class="variablelist"><table border="0">
 714 <col align="left" valign="top">
 715 <tbody>
 716 <tr>
 717 <td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 718 <td>a method</td>
 719 </tr>
 720 <tr>
 721 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 722 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a> for <em class="parameter"><code>method</code></em> or <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GST-RTSP-INVALID:CAPS"><span class="type">GST_RTSP_INVALID</span></a> if the
 723 method is unknown.</td>
 724 </tr>
 725 </tbody>
 726 </table></div>
 727 </div>
 728 </div>
 729 <div class="refsect1">
 730 <a name="gst-plugins-base-libs-gstrtspdefs.see-also"></a><h2>See Also</h2>
 731 gstrtspurl, gstrtspconnection
 732 </div>
 733 </div>
 734 <div class="footer">
 735 <hr>
 736           Generated by GTK-Doc V1.18</div>
 737 </body>
 738 </html>