1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>gstrtspdefs</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-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.17 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="gst-plugins-base-libs-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>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gstrtspdefs.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-libs-gstrtspdefs.description" class="shortcut">Description</a>
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>
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>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="gst-plugins-base-libs-gstrtspdefs.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include <gst/rtsp/gstrtspdefs.h>
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,
45 enum <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPEvent" title="enum GstRTSPEvent">GstRTSPEvent</a>;
46 enum <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult">GstRTSPResult</a>;
47 enum <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPFamily" title="enum GstRTSPFamily">GstRTSPFamily</a>;
48 enum <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPState" title="enum GstRTSPState">GstRTSPState</a>;
49 enum <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPVersion" title="enum GstRTSPVersion">GstRTSPVersion</a>;
50 enum <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod">GstRTSPMethod</a>;
51 enum <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPAuthMethod" title="enum GstRTSPAuthMethod">GstRTSPAuthMethod</a>;
52 #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>
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>);
66 <div class="refsect1">
67 <a name="gst-plugins-base-libs-gstrtspdefs.description"></a><h2>Description</h2>
69 Provides common defines for the RTSP library.
71 Last reviewed on 2007-07-24 (0.10.14)
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>
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>.
83 <div class="variablelist"><table border="0">
84 <col align="left" valign="top">
87 <td><p><span class="term"><em class="parameter"><code>stmt</code></em> :</span></p></td>
91 <td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
98 <div class="refsect2">
99 <a name="GstRTSPEvent"></a><h3>enum GstRTSPEvent</h3>
100 <pre class="programlisting">typedef enum {
101 GST_RTSP_EV_READ = (1 << 0),
102 GST_RTSP_EV_WRITE = (1 << 1)
106 The possible events for the connection.
108 <div class="variablelist"><table border="0">
109 <col align="left" valign="top">
112 <td><p><a name="GST-RTSP-EV-READ:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EV_READ</code></span></p></td>
113 <td>connection is readable
117 <td><p><a name="GST-RTSP-EV-WRITE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EV_WRITE</code></span></p></td>
118 <td>connection is writable
125 <div class="refsect2">
126 <a name="GstRTSPResult"></a><h3>enum GstRTSPResult</h3>
127 <pre class="programlisting">typedef enum {
131 GST_RTSP_EINVAL = -2,
133 GST_RTSP_ENOMEM = -4,
134 GST_RTSP_ERESOLV = -5,
135 GST_RTSP_ENOTIMPL = -6,
137 GST_RTSP_EPARSE = -8,
138 GST_RTSP_EWSASTART = -9,
139 GST_RTSP_EWSAVERSION = -10,
142 GST_RTSP_ENOTIP = -13,
143 GST_RTSP_ETIMEOUT = -14,
144 GST_RTSP_ETGET = -15,
145 GST_RTSP_ETPOST = -16,
151 Result codes from the RTSP functions.
153 <div class="variablelist"><table border="0">
154 <col align="left" valign="top">
157 <td><p><a name="GST-RTSP-OK:CAPS"></a><span class="term"><code class="literal">GST_RTSP_OK</code></span></p></td>
162 <td><p><a name="GST-RTSP-ERROR:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ERROR</code></span></p></td>
163 <td>some unspecified error occured
167 <td><p><a name="GST-RTSP-EINVAL:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EINVAL</code></span></p></td>
168 <td>invalid arguments were provided to a function
172 <td><p><a name="GST-RTSP-EINTR:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EINTR</code></span></p></td>
173 <td>an operation was canceled
177 <td><p><a name="GST-RTSP-ENOMEM:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ENOMEM</code></span></p></td>
178 <td>no memory was available for the operation
182 <td><p><a name="GST-RTSP-ERESOLV:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ERESOLV</code></span></p></td>
183 <td>a host resolve error occured
187 <td><p><a name="GST-RTSP-ENOTIMPL:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ENOTIMPL</code></span></p></td>
188 <td>function not implemented
192 <td><p><a name="GST-RTSP-ESYS:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ESYS</code></span></p></td>
193 <td>a system error occured, errno contains more details
197 <td><p><a name="GST-RTSP-EPARSE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EPARSE</code></span></p></td>
198 <td>a persing error occured
202 <td><p><a name="GST-RTSP-EWSASTART:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EWSASTART</code></span></p></td>
203 <td>windows networking could not start
207 <td><p><a name="GST-RTSP-EWSAVERSION:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EWSAVERSION</code></span></p></td>
208 <td>windows networking stack has wrong version
212 <td><p><a name="GST-RTSP-EEOF:CAPS"></a><span class="term"><code class="literal">GST_RTSP_EEOF</code></span></p></td>
213 <td>end-of-file was reached
217 <td><p><a name="GST-RTSP-ENET:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ENET</code></span></p></td>
218 <td>a network problem occured, h_errno contains more details
222 <td><p><a name="GST-RTSP-ENOTIP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ENOTIP</code></span></p></td>
223 <td>the host is not an IP host
227 <td><p><a name="GST-RTSP-ETIMEOUT:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ETIMEOUT</code></span></p></td>
228 <td>a timeout occured
232 <td><p><a name="GST-RTSP-ETGET:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ETGET</code></span></p></td>
233 <td>the tunnel GET request has been performed
237 <td><p><a name="GST-RTSP-ETPOST:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ETPOST</code></span></p></td>
238 <td>the tunnel POST request has been performed
242 <td><p><a name="GST-RTSP-ELAST:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ELAST</code></span></p></td>
250 <div class="refsect2">
251 <a name="GstRTSPFamily"></a><h3>enum GstRTSPFamily</h3>
252 <pre class="programlisting">typedef enum {
259 The possible network families.
261 <div class="variablelist"><table border="0">
262 <col align="left" valign="top">
265 <td><p><a name="GST-RTSP-FAM-NONE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_FAM_NONE</code></span></p></td>
266 <td>unknown network family
270 <td><p><a name="GST-RTSP-FAM-INET:CAPS"></a><span class="term"><code class="literal">GST_RTSP_FAM_INET</code></span></p></td>
275 <td><p><a name="GST-RTSP-FAM-INET6:CAPS"></a><span class="term"><code class="literal">GST_RTSP_FAM_INET6</code></span></p></td>
283 <div class="refsect2">
284 <a name="GstRTSPState"></a><h3>enum GstRTSPState</h3>
285 <pre class="programlisting">typedef enum {
286 GST_RTSP_STATE_INVALID,
288 GST_RTSP_STATE_READY,
289 GST_RTSP_STATE_SEEKING,
290 GST_RTSP_STATE_PLAYING,
291 GST_RTSP_STATE_RECORDING
295 The different RTSP states.
297 <div class="variablelist"><table border="0">
298 <col align="left" valign="top">
301 <td><p><a name="GST-RTSP-STATE-INVALID:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_INVALID</code></span></p></td>
306 <td><p><a name="GST-RTSP-STATE-INIT:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_INIT</code></span></p></td>
311 <td><p><a name="GST-RTSP-STATE-READY:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_READY</code></span></p></td>
312 <td>ready for operation
316 <td><p><a name="GST-RTSP-STATE-SEEKING:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_SEEKING</code></span></p></td>
317 <td>seeking in progress
321 <td><p><a name="GST-RTSP-STATE-PLAYING:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_PLAYING</code></span></p></td>
326 <td><p><a name="GST-RTSP-STATE-RECORDING:CAPS"></a><span class="term"><code class="literal">GST_RTSP_STATE_RECORDING</code></span></p></td>
334 <div class="refsect2">
335 <a name="GstRTSPVersion"></a><h3>enum GstRTSPVersion</h3>
336 <pre class="programlisting">typedef enum {
337 GST_RTSP_VERSION_INVALID = 0x00,
338 GST_RTSP_VERSION_1_0 = 0x10,
339 GST_RTSP_VERSION_1_1 = 0x11
343 The supported RTSP versions.
345 <div class="variablelist"><table border="0">
346 <col align="left" valign="top">
349 <td><p><a name="GST-RTSP-VERSION-INVALID:CAPS"></a><span class="term"><code class="literal">GST_RTSP_VERSION_INVALID</code></span></p></td>
350 <td>unknown/invalid version
354 <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>
359 <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>
360 <td>version 1.1. Since 0.10.25
367 <div class="refsect2">
368 <a name="GstRTSPMethod"></a><h3>enum GstRTSPMethod</h3>
369 <pre class="programlisting">typedef enum {
370 GST_RTSP_INVALID = 0,
371 GST_RTSP_DESCRIBE = (1 << 0),
372 GST_RTSP_ANNOUNCE = (1 << 1),
373 GST_RTSP_GET_PARAMETER = (1 << 2),
374 GST_RTSP_OPTIONS = (1 << 3),
375 GST_RTSP_PAUSE = (1 << 4),
376 GST_RTSP_PLAY = (1 << 5),
377 GST_RTSP_RECORD = (1 << 6),
378 GST_RTSP_REDIRECT = (1 << 7),
379 GST_RTSP_SETUP = (1 << 8),
380 GST_RTSP_SET_PARAMETER = (1 << 9),
381 GST_RTSP_TEARDOWN = (1 << 10),
382 GST_RTSP_GET = (1 << 11),
383 GST_RTSP_POST = (1 << 12)
387 The different supported RTSP methods.
389 <div class="variablelist"><table border="0">
390 <col align="left" valign="top">
393 <td><p><a name="GST-RTSP-INVALID:CAPS"></a><span class="term"><code class="literal">GST_RTSP_INVALID</code></span></p></td>
398 <td><p><a name="GST-RTSP-DESCRIBE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_DESCRIBE</code></span></p></td>
399 <td>the DESCRIBE method
403 <td><p><a name="GST-RTSP-ANNOUNCE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_ANNOUNCE</code></span></p></td>
404 <td>the ANNOUNCE method
408 <td><p><a name="GST-RTSP-GET-PARAMETER:CAPS"></a><span class="term"><code class="literal">GST_RTSP_GET_PARAMETER</code></span></p></td>
409 <td>the GET_PARAMETER method
413 <td><p><a name="GST-RTSP-OPTIONS:CAPS"></a><span class="term"><code class="literal">GST_RTSP_OPTIONS</code></span></p></td>
414 <td>the OPTIONS method
418 <td><p><a name="GST-RTSP-PAUSE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_PAUSE</code></span></p></td>
423 <td><p><a name="GST-RTSP-PLAY:CAPS"></a><span class="term"><code class="literal">GST_RTSP_PLAY</code></span></p></td>
428 <td><p><a name="GST-RTSP-RECORD:CAPS"></a><span class="term"><code class="literal">GST_RTSP_RECORD</code></span></p></td>
429 <td>the RECORD method
433 <td><p><a name="GST-RTSP-REDIRECT:CAPS"></a><span class="term"><code class="literal">GST_RTSP_REDIRECT</code></span></p></td>
434 <td>the REDIRECT method
438 <td><p><a name="GST-RTSP-SETUP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_SETUP</code></span></p></td>
443 <td><p><a name="GST-RTSP-SET-PARAMETER:CAPS"></a><span class="term"><code class="literal">GST_RTSP_SET_PARAMETER</code></span></p></td>
444 <td>the SET_PARAMETER method
448 <td><p><a name="GST-RTSP-TEARDOWN:CAPS"></a><span class="term"><code class="literal">GST_RTSP_TEARDOWN</code></span></p></td>
449 <td>the TEARDOWN method
453 <td><p><a name="GST-RTSP-GET:CAPS"></a><span class="term"><code class="literal">GST_RTSP_GET</code></span></p></td>
454 <td>the GET method (HTTP). Since 0.10.25
458 <td><p><a name="GST-RTSP-POST:CAPS"></a><span class="term"><code class="literal">GST_RTSP_POST</code></span></p></td>
459 <td>the POST method (HTTP). Since 0.10.25
466 <div class="refsect2">
467 <a name="GstRTSPAuthMethod"></a><h3>enum GstRTSPAuthMethod</h3>
468 <pre class="programlisting">typedef enum {
469 GST_RTSP_AUTH_NONE = 0x00,
470 GST_RTSP_AUTH_BASIC = 0x01,
471 GST_RTSP_AUTH_DIGEST = 0x02
475 Authentication methods, ordered by strength
477 <div class="variablelist"><table border="0">
478 <col align="left" valign="top">
481 <td><p><a name="GST-RTSP-AUTH-NONE:CAPS"></a><span class="term"><code class="literal">GST_RTSP_AUTH_NONE</code></span></p></td>
482 <td>no authentication
486 <td><p><a name="GST-RTSP-AUTH-BASIC:CAPS"></a><span class="term"><code class="literal">GST_RTSP_AUTH_BASIC</code></span></p></td>
487 <td>basic authentication
491 <td><p><a name="GST-RTSP-AUTH-DIGEST:CAPS"></a><span class="term"><code class="literal">GST_RTSP_AUTH_DIGEST</code></span></p></td>
492 <td>digest authentication
499 <div class="refsect2">
500 <a name="GST-RTSP-AUTH-MAX:CAPS"></a><h3>GST_RTSP_AUTH_MAX</h3>
501 <pre class="programlisting">#define GST_RTSP_AUTH_MAX GST_RTSP_AUTH_DIGEST
504 Strongest available authentication method
508 <div class="refsect2">
509 <a name="GstRTSPHeaderField"></a><h3>enum GstRTSPHeaderField</h3>
510 <pre class="programlisting">typedef enum {
511 GST_RTSP_HDR_INVALID,
519 GST_RTSP_HDR_ACCEPT, /* Accept R opt. entity */
520 GST_RTSP_HDR_ACCEPT_ENCODING, /* Accept-Encoding R opt. entity */
521 GST_RTSP_HDR_ACCEPT_LANGUAGE, /* Accept-Language R opt. all */
522 GST_RTSP_HDR_ALLOW, /* Allow r opt. all */
523 GST_RTSP_HDR_AUTHORIZATION, /* Authorization R opt. all */
524 GST_RTSP_HDR_BANDWIDTH, /* Bandwidth R opt. all */
525 GST_RTSP_HDR_BLOCKSIZE, /* Blocksize R opt. all but OPTIONS, TEARDOWN */
526 GST_RTSP_HDR_CACHE_CONTROL, /* Cache-Control g opt. SETUP */
527 GST_RTSP_HDR_CONFERENCE, /* Conference R opt. SETUP */
528 GST_RTSP_HDR_CONNECTION, /* Connection g req. all */
529 GST_RTSP_HDR_CONTENT_BASE, /* Content-Base e opt. entity */
530 GST_RTSP_HDR_CONTENT_ENCODING, /* Content-Encoding e req. SET_PARAMETER, DESCRIBE, ANNOUNCE */
531 GST_RTSP_HDR_CONTENT_LANGUAGE, /* Content-Language e req. DESCRIBE, ANNOUNCE */
532 GST_RTSP_HDR_CONTENT_LENGTH, /* Content-Length e req. SET_PARAMETER, ANNOUNCE, entity */
533 GST_RTSP_HDR_CONTENT_LOCATION, /* Content-Location e opt. entity */
534 GST_RTSP_HDR_CONTENT_TYPE, /* Content-Type e req. SET_PARAMETER, ANNOUNCE, entity */
535 GST_RTSP_HDR_CSEQ, /* CSeq g req. all */
536 GST_RTSP_HDR_DATE, /* Date g opt. all */
537 GST_RTSP_HDR_EXPIRES, /* Expires e opt. DESCRIBE, ANNOUNCE */
538 GST_RTSP_HDR_FROM, /* From R opt. all */
539 GST_RTSP_HDR_IF_MODIFIED_SINCE, /* If-Modified-Since R opt. DESCRIBE, SETUP */
540 GST_RTSP_HDR_LAST_MODIFIED, /* Last-Modified e opt. entity */
541 GST_RTSP_HDR_PROXY_AUTHENTICATE, /* Proxy-Authenticate */
542 GST_RTSP_HDR_PROXY_REQUIRE, /* Proxy-Require R req. all */
543 GST_RTSP_HDR_PUBLIC, /* Public r opt. all */
544 GST_RTSP_HDR_RANGE, /* Range Rr opt. PLAY, PAUSE, RECORD */
545 GST_RTSP_HDR_REFERER, /* Referer R opt. all */
546 GST_RTSP_HDR_REQUIRE, /* Require R req. all */
547 GST_RTSP_HDR_RETRY_AFTER, /* Retry-After r opt. all */
548 GST_RTSP_HDR_RTP_INFO, /* RTP-Info r req. PLAY */
549 GST_RTSP_HDR_SCALE, /* Scale Rr opt. PLAY, RECORD */
550 GST_RTSP_HDR_SESSION, /* Session Rr req. all but SETUP, OPTIONS */
551 GST_RTSP_HDR_SERVER, /* Server r opt. all */
552 GST_RTSP_HDR_SPEED, /* Speed Rr opt. PLAY */
553 GST_RTSP_HDR_TRANSPORT, /* Transport Rr req. SETUP */
554 GST_RTSP_HDR_UNSUPPORTED, /* Unsupported r req. all */
555 GST_RTSP_HDR_USER_AGENT, /* User-Agent R opt. all */
556 GST_RTSP_HDR_VIA, /* Via g opt. all */
557 GST_RTSP_HDR_WWW_AUTHENTICATE, /* WWW-Authenticate r opt. all */
559 /* Real extensions */
560 GST_RTSP_HDR_CLIENT_CHALLENGE, /* ClientChallenge */
561 GST_RTSP_HDR_REAL_CHALLENGE1, /* RealChallenge1 */
562 GST_RTSP_HDR_REAL_CHALLENGE2, /* RealChallenge2 */
563 GST_RTSP_HDR_REAL_CHALLENGE3, /* RealChallenge3 */
564 GST_RTSP_HDR_SUBSCRIBE, /* Subscribe */
565 GST_RTSP_HDR_ALERT, /* Alert */
566 GST_RTSP_HDR_CLIENT_ID, /* ClientID */
567 GST_RTSP_HDR_COMPANY_ID, /* CompanyID */
568 GST_RTSP_HDR_GUID, /* GUID */
569 GST_RTSP_HDR_REGION_DATA, /* RegionData */
570 GST_RTSP_HDR_MAX_ASM_WIDTH, /* SupportsMaximumASMBandwidth */
571 GST_RTSP_HDR_LANGUAGE, /* Language */
572 GST_RTSP_HDR_PLAYER_START_TIME, /* PlayerStarttime */
575 GST_RTSP_HDR_LOCATION, /* Location */
578 GST_RTSP_HDR_ETAG, /* ETag */
579 GST_RTSP_HDR_IF_MATCH, /* If-Match */
581 /* WM extensions [MS-RTSP] Since 0.10.23 */
582 GST_RTSP_HDR_ACCEPT_CHARSET, /* Accept-Charset */
583 GST_RTSP_HDR_SUPPORTED, /* Supported */
584 GST_RTSP_HDR_VARY, /* Vary */
585 GST_RTSP_HDR_X_ACCELERATE_STREAMING, /* X-Accelerate-Streaming */
586 GST_RTSP_HDR_X_ACCEPT_AUTHENT, /* X-Accept-Authentication */
587 GST_RTSP_HDR_X_ACCEPT_PROXY_AUTHENT, /* X-Accept-Proxy-Authentication */
588 GST_RTSP_HDR_X_BROADCAST_ID, /* X-Broadcast-Id */
589 GST_RTSP_HDR_X_BURST_STREAMING, /* X-Burst-Streaming */
590 GST_RTSP_HDR_X_NOTICE, /* X-Notice */
591 GST_RTSP_HDR_X_PLAYER_LAG_TIME, /* X-Player-Lag-Time */
592 GST_RTSP_HDR_X_PLAYLIST, /* X-Playlist */
593 GST_RTSP_HDR_X_PLAYLIST_CHANGE_NOTICE, /* X-Playlist-Change-Notice */
594 GST_RTSP_HDR_X_PLAYLIST_GEN_ID, /* X-Playlist-Gen-Id */
595 GST_RTSP_HDR_X_PLAYLIST_SEEK_ID, /* X-Playlist-Seek-Id */
596 GST_RTSP_HDR_X_PROXY_CLIENT_AGENT, /* X-Proxy-Client-Agent */
597 GST_RTSP_HDR_X_PROXY_CLIENT_VERB, /* X-Proxy-Client-Verb */
598 GST_RTSP_HDR_X_RECEDING_PLAYLISTCHANGE, /* X-Receding-PlaylistChange */
599 GST_RTSP_HDR_X_RTP_INFO, /* X-RTP-Info */
600 GST_RTSP_HDR_X_STARTUPPROFILE, /* X-StartupProfile */
603 GST_RTSP_HDR_TIMESTAMP, /* Timestamp */
606 GST_RTSP_HDR_AUTHENTICATION_INFO, /* Authentication-Info */
607 GST_RTSP_HDR_HOST, /* Host */
608 GST_RTSP_HDR_PRAGMA, /* Pragma */
609 GST_RTSP_HDR_X_SERVER_IP_ADDRESS, /* X-Server-IP-Address */
610 GST_RTSP_HDR_X_SESSIONCOOKIE, /* X-Sessioncookie */
613 } GstRTSPHeaderField;
617 <div class="refsect2">
618 <a name="GstRTSPStatusCode"></a><h3>enum GstRTSPStatusCode</h3>
619 <pre class="programlisting">typedef enum {
620 GST_RTSP_STS_INVALID = 0,
621 GST_RTSP_STS_CONTINUE = 100,
622 GST_RTSP_STS_OK = 200,
623 GST_RTSP_STS_CREATED = 201,
624 GST_RTSP_STS_LOW_ON_STORAGE = 250,
625 GST_RTSP_STS_MULTIPLE_CHOICES = 300,
626 GST_RTSP_STS_MOVED_PERMANENTLY = 301,
627 GST_RTSP_STS_MOVE_TEMPORARILY = 302,
628 GST_RTSP_STS_SEE_OTHER = 303,
629 GST_RTSP_STS_NOT_MODIFIED = 304,
630 GST_RTSP_STS_USE_PROXY = 305,
631 GST_RTSP_STS_BAD_REQUEST = 400,
632 GST_RTSP_STS_UNAUTHORIZED = 401,
633 GST_RTSP_STS_PAYMENT_REQUIRED = 402,
634 GST_RTSP_STS_FORBIDDEN = 403,
635 GST_RTSP_STS_NOT_FOUND = 404,
636 GST_RTSP_STS_METHOD_NOT_ALLOWED = 405,
637 GST_RTSP_STS_NOT_ACCEPTABLE = 406,
638 GST_RTSP_STS_PROXY_AUTH_REQUIRED = 407,
639 GST_RTSP_STS_REQUEST_TIMEOUT = 408,
640 GST_RTSP_STS_GONE = 410,
641 GST_RTSP_STS_LENGTH_REQUIRED = 411,
642 GST_RTSP_STS_PRECONDITION_FAILED = 412,
643 GST_RTSP_STS_REQUEST_ENTITY_TOO_LARGE = 413,
644 GST_RTSP_STS_REQUEST_URI_TOO_LARGE = 414,
645 GST_RTSP_STS_UNSUPPORTED_MEDIA_TYPE = 415,
646 GST_RTSP_STS_PARAMETER_NOT_UNDERSTOOD = 451,
647 GST_RTSP_STS_CONFERENCE_NOT_FOUND = 452,
648 GST_RTSP_STS_NOT_ENOUGH_BANDWIDTH = 453,
649 GST_RTSP_STS_SESSION_NOT_FOUND = 454,
650 GST_RTSP_STS_METHOD_NOT_VALID_IN_THIS_STATE = 455,
651 GST_RTSP_STS_HEADER_FIELD_NOT_VALID_FOR_RESOURCE = 456,
652 GST_RTSP_STS_INVALID_RANGE = 457,
653 GST_RTSP_STS_PARAMETER_IS_READONLY = 458,
654 GST_RTSP_STS_AGGREGATE_OPERATION_NOT_ALLOWED = 459,
655 GST_RTSP_STS_ONLY_AGGREGATE_OPERATION_ALLOWED = 460,
656 GST_RTSP_STS_UNSUPPORTED_TRANSPORT = 461,
657 GST_RTSP_STS_DESTINATION_UNREACHABLE = 462,
658 GST_RTSP_STS_INTERNAL_SERVER_ERROR = 500,
659 GST_RTSP_STS_NOT_IMPLEMENTED = 501,
660 GST_RTSP_STS_BAD_GATEWAY = 502,
661 GST_RTSP_STS_SERVICE_UNAVAILABLE = 503,
662 GST_RTSP_STS_GATEWAY_TIMEOUT = 504,
663 GST_RTSP_STS_RTSP_VERSION_NOT_SUPPORTED = 505,
664 GST_RTSP_STS_OPTION_NOT_SUPPORTED = 551
669 <div class="refsect2">
670 <a name="gst-rtsp-strresult"></a><h3>gst_rtsp_strresult ()</h3>
671 <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>
673 Convert <em class="parameter"><code>result</code></em> in a human readable string.
675 <div class="variablelist"><table border="0">
676 <col align="left" valign="top">
679 <td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
680 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult"><span class="type">GstRTSPResult</span></a>
684 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
685 <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>
691 <div class="refsect2">
692 <a name="gst-rtsp-method-as-text"></a><h3>gst_rtsp_method_as_text ()</h3>
693 <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>
695 Convert <em class="parameter"><code>method</code></em> to a string.
697 <div class="variablelist"><table border="0">
698 <col align="left" valign="top">
701 <td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
702 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a>
706 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
707 <td>a string representation of <em class="parameter"><code>method</code></em>.</td>
713 <div class="refsect2">
714 <a name="gst-rtsp-version-as-text"></a><h3>gst_rtsp_version_as_text ()</h3>
715 <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>
717 Convert <em class="parameter"><code>version</code></em> to a string.
719 <div class="variablelist"><table border="0">
720 <col align="left" valign="top">
723 <td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
724 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPVersion" title="enum GstRTSPVersion"><span class="type">GstRTSPVersion</span></a>
728 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
729 <td>a string representation of <em class="parameter"><code>version</code></em>.</td>
735 <div class="refsect2">
736 <a name="gst-rtsp-header-as-text"></a><h3>gst_rtsp_header_as_text ()</h3>
737 <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>
739 Convert <em class="parameter"><code>field</code></em> to a string.
741 <div class="variablelist"><table border="0">
742 <col align="left" valign="top">
745 <td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
746 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a>
750 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
751 <td>a string representation of <em class="parameter"><code>field</code></em>.</td>
757 <div class="refsect2">
758 <a name="gst-rtsp-header-allow-multiple"></a><h3>gst_rtsp_header_allow_multiple ()</h3>
759 <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>
761 Check whether <em class="parameter"><code>field</code></em> may appear multiple times in a message.
763 <div class="variablelist"><table border="0">
764 <col align="left" valign="top">
767 <td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
768 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPHeaderField" title="enum GstRTSPHeaderField"><span class="type">GstRTSPHeaderField</span></a>
772 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
774 <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>
778 <p class="since">Since 0.10.25</p>
781 <div class="refsect2">
782 <a name="gst-rtsp-status-as-text"></a><h3>gst_rtsp_status_as_text ()</h3>
783 <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>
785 Convert <em class="parameter"><code>code</code></em> to a string.
787 <div class="variablelist"><table border="0">
788 <col align="left" valign="top">
791 <td><p><span class="term"><em class="parameter"><code>code</code></em> :</span></p></td>
792 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPStatusCode" title="enum GstRTSPStatusCode"><span class="type">GstRTSPStatusCode</span></a>
796 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
797 <td>a string representation of <em class="parameter"><code>code</code></em>.</td>
803 <div class="refsect2">
804 <a name="gst-rtsp-options-as-text"></a><h3>gst_rtsp_options_as_text ()</h3>
805 <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>
807 Convert <em class="parameter"><code>options</code></em> to a string.
809 <div class="variablelist"><table border="0">
810 <col align="left" valign="top">
813 <td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
814 <td>one or more <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod" title="enum GstRTSPMethod"><span class="type">GstRTSPMethod</span></a>
818 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
819 <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>
823 <p class="since">Since 0.10.23</p>
826 <div class="refsect2">
827 <a name="gst-rtsp-find-header-field"></a><h3>gst_rtsp_find_header_field ()</h3>
828 <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>
830 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>.
832 <div class="variablelist"><table border="0">
833 <col align="left" valign="top">
836 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
837 <td>a header string</td>
840 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
841 <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
842 header field is unknown.</td>
848 <div class="refsect2">
849 <a name="gst-rtsp-find-method"></a><h3>gst_rtsp_find_method ()</h3>
850 <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>
852 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>.
854 <div class="variablelist"><table border="0">
855 <col align="left" valign="top">
858 <td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
862 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
863 <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
864 method is unknown.</td>
870 <div class="refsect1">
871 <a name="gst-plugins-base-libs-gstrtspdefs.see-also"></a><h2>See Also</h2>
872 gstrtspurl, gstrtspconnection
877 Generated by GTK-Doc V1.17</div>