faf38d8ec2d77c9c94a897b4dfd6067165287a68
[framework/multimedia/gst-plugins-base0.10.git] / docs / libs / html / gst-plugins-base-libs-gstrtsptransport.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>gstrtsptransport</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-gstrtsprange.html" title="gstrtsprange">
10 <link rel="next" href="gst-plugins-base-libs-gstrtspurl.html" title="gstrtspurl">
11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="gst-plugins-base-libs-gstrtsprange.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-gstrtspurl.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-gstrtsptransport.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-libs-gstrtsptransport.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="gst-plugins-base-libs-gstrtsptransport"></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-gstrtsptransport.top_of_page"></a>gstrtsptransport</span></h2>
34 <p>gstrtsptransport — dealing with RTSP transports</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-gstrtsptransport.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include &lt;gst/rtsp/gstrtsptransport.h&gt;
42
43 enum                <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransMode" title="enum GstRTSPTransMode">GstRTSPTransMode</a>;
44 enum                <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPProfile" title="enum GstRTSPProfile">GstRTSPProfile</a>;
45 struct              <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPRange" title="struct GstRTSPRange">GstRTSPRange</a>;
46 enum                <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPLowerTrans" title="enum GstRTSPLowerTrans">GstRTSPLowerTrans</a>;
47 struct              <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport">GstRTSPTransport</a>;
48 <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-gstrtsptransport.html#gst-rtsp-transport-new" title="gst_rtsp_transport_new ()">gst_rtsp_transport_new</a>              (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> **transport</code></em>);
49 <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-gstrtsptransport.html#gst-rtsp-transport-init" title="gst_rtsp_transport_init ()">gst_rtsp_transport_init</a>             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> *transport</code></em>);
50 <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-gstrtsptransport.html#gst-rtsp-transport-parse" title="gst_rtsp_transport_parse ()">gst_rtsp_transport_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> *str</code></em>,
51                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> *transport</code></em>);
52 <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-gstrtsptransport.html#gst-rtsp-transport-as-text" title="gst_rtsp_transport_as_text ()">gst_rtsp_transport_as_text</a>         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> *transport</code></em>);
53 <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-gstrtsptransport.html#gst-rtsp-transport-get-mime" title="gst_rtsp_transport_get_mime ()">gst_rtsp_transport_get_mime</a>         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransMode" title="enum GstRTSPTransMode"><span class="type">GstRTSPTransMode</span></a> trans</code></em>,
54                                                          <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> **mime</code></em>);
55 <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-gstrtsptransport.html#gst-rtsp-transport-get-manager" title="gst_rtsp_transport_get_manager ()">gst_rtsp_transport_get_manager</a>      (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransMode" title="enum GstRTSPTransMode"><span class="type">GstRTSPTransMode</span></a> trans</code></em>,
56                                                          <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> **manager</code></em>,
57                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> option</code></em>);
58 <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-gstrtsptransport.html#gst-rtsp-transport-free" title="gst_rtsp_transport_free ()">gst_rtsp_transport_free</a>             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> *transport</code></em>);
59 </pre>
60 </div>
61 <div class="refsect1">
62 <a name="gst-plugins-base-libs-gstrtsptransport.description"></a><h2>Description</h2>
63 <p>
64 Provides helper functions to deal with RTSP transport strings.
65  
66 Last reviewed on 2007-07-25 (0.10.14)
67 </p>
68 </div>
69 <div class="refsect1">
70 <a name="gst-plugins-base-libs-gstrtsptransport.details"></a><h2>Details</h2>
71 <div class="refsect2">
72 <a name="GstRTSPTransMode"></a><h3>enum GstRTSPTransMode</h3>
73 <pre class="programlisting">typedef enum {
74   GST_RTSP_TRANS_UNKNOWN =  0,
75   GST_RTSP_TRANS_RTP     = (1 &lt;&lt; 0),
76   GST_RTSP_TRANS_RDT     = (1 &lt;&lt; 1)
77 } GstRTSPTransMode;
78 </pre>
79 <p>
80 The transfer mode to use.
81 </p>
82 <div class="variablelist"><table border="0">
83 <col align="left" valign="top">
84 <tbody>
85 <tr>
86 <td><p><a name="GST-RTSP-TRANS-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_RTSP_TRANS_UNKNOWN</code></span></p></td>
87 <td>invalid tansport mode
88 </td>
89 </tr>
90 <tr>
91 <td><p><a name="GST-RTSP-TRANS-RTP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_TRANS_RTP</code></span></p></td>
92 <td>transfer RTP data
93 </td>
94 </tr>
95 <tr>
96 <td><p><a name="GST-RTSP-TRANS-RDT:CAPS"></a><span class="term"><code class="literal">GST_RTSP_TRANS_RDT</code></span></p></td>
97 <td>transfer RDT (RealMedia) data
98 </td>
99 </tr>
100 </tbody>
101 </table></div>
102 </div>
103 <hr>
104 <div class="refsect2">
105 <a name="GstRTSPProfile"></a><h3>enum GstRTSPProfile</h3>
106 <pre class="programlisting">typedef enum {
107   GST_RTSP_PROFILE_UNKNOWN =  0,
108   GST_RTSP_PROFILE_AVP     = (1 &lt;&lt; 0),
109   GST_RTSP_PROFILE_SAVP    = (1 &lt;&lt; 1)
110 } GstRTSPProfile;
111 </pre>
112 <p>
113 The transfer profile to use.
114 </p>
115 <div class="variablelist"><table border="0">
116 <col align="left" valign="top">
117 <tbody>
118 <tr>
119 <td><p><a name="GST-RTSP-PROFILE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_RTSP_PROFILE_UNKNOWN</code></span></p></td>
120 <td>invalid profile
121 </td>
122 </tr>
123 <tr>
124 <td><p><a name="GST-RTSP-PROFILE-AVP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_PROFILE_AVP</code></span></p></td>
125 <td>the Audio/Visual profile
126 </td>
127 </tr>
128 <tr>
129 <td><p><a name="GST-RTSP-PROFILE-SAVP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_PROFILE_SAVP</code></span></p></td>
130 <td>the secure Audio/Visual profile
131 </td>
132 </tr>
133 </tbody>
134 </table></div>
135 </div>
136 <hr>
137 <div class="refsect2">
138 <a name="GstRTSPRange"></a><h3>struct GstRTSPRange</h3>
139 <pre class="programlisting">struct GstRTSPRange {
140   gint min;
141   gint max;
142 };
143 </pre>
144 <p>
145 A type to specify a range.
146 </p>
147 <div class="variablelist"><table border="0">
148 <col align="left" valign="top">
149 <tbody>
150 <tr>
151 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstRTSPRange.min"></a>min</code></em>;</span></p></td>
152 <td>minimum value of the range</td>
153 </tr>
154 <tr>
155 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstRTSPRange.max"></a>max</code></em>;</span></p></td>
156 <td>maximum value of the range</td>
157 </tr>
158 </tbody>
159 </table></div>
160 </div>
161 <hr>
162 <div class="refsect2">
163 <a name="GstRTSPLowerTrans"></a><h3>enum GstRTSPLowerTrans</h3>
164 <pre class="programlisting">typedef enum {
165   GST_RTSP_LOWER_TRANS_UNKNOWN   = 0,
166   GST_RTSP_LOWER_TRANS_UDP       = (1 &lt;&lt; 0),
167   GST_RTSP_LOWER_TRANS_UDP_MCAST = (1 &lt;&lt; 1),
168   GST_RTSP_LOWER_TRANS_TCP       = (1 &lt;&lt; 2),
169   GST_RTSP_LOWER_TRANS_HTTP      = (1 &lt;&lt; 4)
170 } GstRTSPLowerTrans;
171 </pre>
172 <p>
173 The different transport methods.
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-LOWER-TRANS-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_RTSP_LOWER_TRANS_UNKNOWN</code></span></p></td>
180 <td>invalid transport flag
181 </td>
182 </tr>
183 <tr>
184 <td><p><a name="GST-RTSP-LOWER-TRANS-UDP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_LOWER_TRANS_UDP</code></span></p></td>
185 <td>stream data over UDP
186 </td>
187 </tr>
188 <tr>
189 <td><p><a name="GST-RTSP-LOWER-TRANS-UDP-MCAST:CAPS"></a><span class="term"><code class="literal">GST_RTSP_LOWER_TRANS_UDP_MCAST</code></span></p></td>
190 <td>stream data over UDP multicast
191 </td>
192 </tr>
193 <tr>
194 <td><p><a name="GST-RTSP-LOWER-TRANS-TCP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_LOWER_TRANS_TCP</code></span></p></td>
195 <td>stream data over TCP
196 </td>
197 </tr>
198 <tr>
199 <td><p><a name="GST-RTSP-LOWER-TRANS-HTTP:CAPS"></a><span class="term"><code class="literal">GST_RTSP_LOWER_TRANS_HTTP</code></span></p></td>
200 <td>stream data tunneled over HTTP. Since: 0.10.23
201 </td>
202 </tr>
203 </tbody>
204 </table></div>
205 </div>
206 <hr>
207 <div class="refsect2">
208 <a name="GstRTSPTransport"></a><h3>struct GstRTSPTransport</h3>
209 <pre class="programlisting">struct GstRTSPTransport {
210   GstRTSPTransMode  trans;
211   GstRTSPProfile    profile;
212   GstRTSPLowerTrans lower_transport;
213
214   gchar         *destination;
215   gchar         *source;
216   guint          layers;
217   gboolean       mode_play;
218   gboolean       mode_record;
219   gboolean       append;
220   GstRTSPRange   interleaved;
221
222   /* multicast specific */
223   guint  ttl;
224
225   /* UDP specific */
226   GstRTSPRange   port;
227   GstRTSPRange   client_port;
228   GstRTSPRange   server_port;
229   /* RTP specific */
230   guint          ssrc;
231 };
232 </pre>
233 <p>
234 A structure holding the RTSP transport values.
235 </p>
236 <div class="variablelist"><table border="0">
237 <col align="left" valign="top">
238 <tbody>
239 <tr>
240 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransMode" title="enum GstRTSPTransMode"><span class="type">GstRTSPTransMode</span></a> <em class="structfield"><code><a name="GstRTSPTransport.trans"></a>trans</code></em>;</span></p></td>
241 <td>the transport mode</td>
242 </tr>
243 <tr>
244 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPProfile" title="enum GstRTSPProfile"><span class="type">GstRTSPProfile</span></a> <em class="structfield"><code><a name="GstRTSPTransport.profile"></a>profile</code></em>;</span></p></td>
245 <td>the tansport profile</td>
246 </tr>
247 <tr>
248 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPLowerTrans" title="enum GstRTSPLowerTrans"><span class="type">GstRTSPLowerTrans</span></a> <em class="structfield"><code><a name="GstRTSPTransport.lower-transport"></a>lower_transport</code></em>;</span></p></td>
249 <td>the lower transport</td>
250 </tr>
251 <tr>
252 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstRTSPTransport.destination"></a>destination</code></em>;</span></p></td>
253 <td>the destination ip/hostname</td>
254 </tr>
255 <tr>
256 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstRTSPTransport.source"></a>source</code></em>;</span></p></td>
257 <td>the source ip/hostname</td>
258 </tr>
259 <tr>
260 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstRTSPTransport.layers"></a>layers</code></em>;</span></p></td>
261 <td>the number of layers</td>
262 </tr>
263 <tr>
264 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GstRTSPTransport.mode-play"></a>mode_play</code></em>;</span></p></td>
265 <td>if play mode was selected</td>
266 </tr>
267 <tr>
268 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GstRTSPTransport.mode-record"></a>mode_record</code></em>;</span></p></td>
269 <td>if record mode was selected</td>
270 </tr>
271 <tr>
272 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GstRTSPTransport.append"></a>append</code></em>;</span></p></td>
273 <td>is append mode was selected</td>
274 </tr>
275 <tr>
276 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPRange" title="struct GstRTSPRange"><span class="type">GstRTSPRange</span></a> <em class="structfield"><code><a name="GstRTSPTransport.interleaved"></a>interleaved</code></em>;</span></p></td>
277 <td>the interleave range</td>
278 </tr>
279 <tr>
280 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstRTSPTransport.ttl"></a>ttl</code></em>;</span></p></td>
281 <td>the time to live for multicast UDP</td>
282 </tr>
283 <tr>
284 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPRange" title="struct GstRTSPRange"><span class="type">GstRTSPRange</span></a> <em class="structfield"><code><a name="GstRTSPTransport.port"></a>port</code></em>;</span></p></td>
285 <td>the port pair for multicast sessions</td>
286 </tr>
287 <tr>
288 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPRange" title="struct GstRTSPRange"><span class="type">GstRTSPRange</span></a> <em class="structfield"><code><a name="GstRTSPTransport.client-port"></a>client_port</code></em>;</span></p></td>
289 <td>the client port pair for receiving data</td>
290 </tr>
291 <tr>
292 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPRange" title="struct GstRTSPRange"><span class="type">GstRTSPRange</span></a> <em class="structfield"><code><a name="GstRTSPTransport.server-port"></a>server_port</code></em>;</span></p></td>
293 <td>the server port pair for receiving data</td>
294 </tr>
295 <tr>
296 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstRTSPTransport.ssrc"></a>ssrc</code></em>;</span></p></td>
297 <td>the ssrc that the sender/receiver will use</td>
298 </tr>
299 </tbody>
300 </table></div>
301 </div>
302 <hr>
303 <div class="refsect2">
304 <a name="gst-rtsp-transport-new"></a><h3>gst_rtsp_transport_new ()</h3>
305 <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_transport_new              (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> **transport</code></em>);</pre>
306 <p>
307 Allocate a new initialized <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a>. Use <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#gst-rtsp-transport-free" title="gst_rtsp_transport_free ()"><code class="function">gst_rtsp_transport_free()</code></a>
308 after usage.
309 </p>
310 <div class="variablelist"><table border="0">
311 <col align="left" valign="top">
312 <tbody>
313 <tr>
314 <td><p><span class="term"><em class="parameter"><code>transport</code></em> :</span></p></td>
315 <td>location to hold the new <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a>
316 </td>
317 </tr>
318 <tr>
319 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
320 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult"><span class="type">GstRTSPResult</span></a>.</td>
321 </tr>
322 </tbody>
323 </table></div>
324 </div>
325 <hr>
326 <div class="refsect2">
327 <a name="gst-rtsp-transport-init"></a><h3>gst_rtsp_transport_init ()</h3>
328 <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_transport_init             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> *transport</code></em>);</pre>
329 <p>
330 Initialize <em class="parameter"><code>transport</code></em> so that it can be used.
331 </p>
332 <div class="variablelist"><table border="0">
333 <col align="left" valign="top">
334 <tbody>
335 <tr>
336 <td><p><span class="term"><em class="parameter"><code>transport</code></em> :</span></p></td>
337 <td>a <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a>
338 </td>
339 </tr>
340 <tr>
341 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
342 <td>
343 <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GST-RTSP-OK:CAPS"><span class="type">GST_RTSP_OK</span></a>.</td>
344 </tr>
345 </tbody>
346 </table></div>
347 </div>
348 <hr>
349 <div class="refsect2">
350 <a name="gst-rtsp-transport-parse"></a><h3>gst_rtsp_transport_parse ()</h3>
351 <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_transport_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> *str</code></em>,
352                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> *transport</code></em>);</pre>
353 <p>
354 Parse the RTSP transport string <em class="parameter"><code>str</code></em> into <em class="parameter"><code>transport</code></em>.
355 </p>
356 <div class="variablelist"><table border="0">
357 <col align="left" valign="top">
358 <tbody>
359 <tr>
360 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
361 <td>a transport string</td>
362 </tr>
363 <tr>
364 <td><p><span class="term"><em class="parameter"><code>transport</code></em> :</span></p></td>
365 <td>a <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a>
366 </td>
367 </tr>
368 <tr>
369 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
370 <td>a <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GstRTSPResult" title="enum GstRTSPResult"><span class="type">GstRTSPResult</span></a>.</td>
371 </tr>
372 </tbody>
373 </table></div>
374 </div>
375 <hr>
376 <div class="refsect2">
377 <a name="gst-rtsp-transport-as-text"></a><h3>gst_rtsp_transport_as_text ()</h3>
378 <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_transport_as_text         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> *transport</code></em>);</pre>
379 <p>
380 Convert <em class="parameter"><code>transport</code></em> into a string that can be used to signal the transport in
381 an RTSP SETUP response.
382 </p>
383 <div class="variablelist"><table border="0">
384 <col align="left" valign="top">
385 <tbody>
386 <tr>
387 <td><p><span class="term"><em class="parameter"><code>transport</code></em> :</span></p></td>
388 <td>a <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a>
389 </td>
390 </tr>
391 <tr>
392 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
393 <td>a string describing the RTSP transport or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> when the transport
394 is invalid.</td>
395 </tr>
396 </tbody>
397 </table></div>
398 </div>
399 <hr>
400 <div class="refsect2">
401 <a name="gst-rtsp-transport-get-mime"></a><h3>gst_rtsp_transport_get_mime ()</h3>
402 <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_transport_get_mime         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransMode" title="enum GstRTSPTransMode"><span class="type">GstRTSPTransMode</span></a> trans</code></em>,
403                                                          <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> **mime</code></em>);</pre>
404 <p>
405 Get the mime type of the transport mode <em class="parameter"><code>trans</code></em>. This mime type is typically
406 used to generate <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> on buffers.
407 </p>
408 <div class="variablelist"><table border="0">
409 <col align="left" valign="top">
410 <tbody>
411 <tr>
412 <td><p><span class="term"><em class="parameter"><code>trans</code></em> :</span></p></td>
413 <td>a <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransMode" title="enum GstRTSPTransMode"><span class="type">GstRTSPTransMode</span></a>
414 </td>
415 </tr>
416 <tr>
417 <td><p><span class="term"><em class="parameter"><code>mime</code></em> :</span></p></td>
418 <td>location to hold the result</td>
419 </tr>
420 <tr>
421 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
422 <td>
423 <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GST-RTSP-OK:CAPS"><span class="type">GST_RTSP_OK</span></a>.</td>
424 </tr>
425 </tbody>
426 </table></div>
427 </div>
428 <hr>
429 <div class="refsect2">
430 <a name="gst-rtsp-transport-get-manager"></a><h3>gst_rtsp_transport_get_manager ()</h3>
431 <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_transport_get_manager      (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransMode" title="enum GstRTSPTransMode"><span class="type">GstRTSPTransMode</span></a> trans</code></em>,
432                                                          <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> **manager</code></em>,
433                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> option</code></em>);</pre>
434 <p>
435 Get the <span class="type">GStreamer</span> element that can handle the buffers transported over
436 <em class="parameter"><code>trans</code></em>.
437 </p>
438 <p>
439 It is possible that there are several managers available, use <em class="parameter"><code>option</code></em> to
440 selected one.
441 </p>
442 <p>
443 <em class="parameter"><code>manager</code></em> will contain an element name or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> when no manager is
444 needed/available for <em class="parameter"><code>trans</code></em>.
445 </p>
446 <div class="variablelist"><table border="0">
447 <col align="left" valign="top">
448 <tbody>
449 <tr>
450 <td><p><span class="term"><em class="parameter"><code>trans</code></em> :</span></p></td>
451 <td>a <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransMode" title="enum GstRTSPTransMode"><span class="type">GstRTSPTransMode</span></a>
452 </td>
453 </tr>
454 <tr>
455 <td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
456 <td>location to hold the result</td>
457 </tr>
458 <tr>
459 <td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td>
460 <td>option index.</td>
461 </tr>
462 <tr>
463 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
464 <td>
465 <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GST-RTSP-OK:CAPS"><span class="type">GST_RTSP_OK</span></a>.</td>
466 </tr>
467 </tbody>
468 </table></div>
469 </div>
470 <hr>
471 <div class="refsect2">
472 <a name="gst-rtsp-transport-free"></a><h3>gst_rtsp_transport_free ()</h3>
473 <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_transport_free             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> *transport</code></em>);</pre>
474 <p>
475 Free the memory used by <em class="parameter"><code>transport</code></em>.
476 </p>
477 <div class="variablelist"><table border="0">
478 <col align="left" valign="top">
479 <tbody>
480 <tr>
481 <td><p><span class="term"><em class="parameter"><code>transport</code></em> :</span></p></td>
482 <td>a <a class="link" href="gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport" title="struct GstRTSPTransport"><span class="type">GstRTSPTransport</span></a>
483 </td>
484 </tr>
485 <tr>
486 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
487 <td>
488 <a class="link" href="gst-plugins-base-libs-gstrtspdefs.html#GST-RTSP-OK:CAPS"><span class="type">GST_RTSP_OK</span></a>.</td>
489 </tr>
490 </tbody>
491 </table></div>
492 </div>
493 </div>
494 </div>
495 <div class="footer">
496 <hr>
497           Generated by GTK-Doc V1.17</div>
498 </body>
499 </html>