Initial release including wifi display based on gst-rtsp-server-1.4.1
[platform/upstream/gstreamer.git] / docs / libs / html / GstRTSPServer.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>GStreamer RTSP Server Reference Manual: GstRTSPServer</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="GStreamer RTSP Server Reference Manual">
8 <link rel="up" href="ch01.html" title="">
9 <link rel="prev" href="ch01.html" title="">
10 <link rel="next" href="GstRTSPClient.html" title="GstRTSPClient">
11 <meta name="generator" content="GTK-Doc V1.21 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18                   <a href="#GstRTSPServer.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19                   <a href="#GstRTSPServer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
20                   <a href="#GstRTSPServer.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
21                   <a href="#GstRTSPServer.signals" class="shortcut">Signals</a></span>
22 </td>
23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25 <td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26 <td><a accesskey="n" href="GstRTSPClient.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27 </tr></table>
28 <div class="refentry">
29 <a name="GstRTSPServer"></a><div class="titlepage"></div>
30 <div class="refnamediv"><table width="100%"><tr>
31 <td valign="top">
32 <h2><span class="refentrytitle"><a name="GstRTSPServer.top_of_page"></a>GstRTSPServer</span></h2>
33 <p>GstRTSPServer — The main server object</p>
34 </td>
35 <td class="gallery_image" valign="top" align="right"></td>
36 </tr></table></div>
37 <div class="refsect1">
38 <a name="GstRTSPServer.functions"></a><h2>Functions</h2>
39 <div class="informaltable"><table width="100%" border="0">
40 <colgroup>
41 <col width="150px" class="functions_return">
42 <col class="functions_name">
43 </colgroup>
44 <tbody>
45 <tr>
46 <td class="function_type">
47 <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="returnvalue">GstRTSPServer</span></a> *
48 </td>
49 <td class="function_name">
50 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-new" title="gst_rtsp_server_new ()">gst_rtsp_server_new</a> <span class="c_punctuation">()</span>
51 </td>
52 </tr>
53 <tr>
54 <td class="function_type">
55 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
56 </td>
57 <td class="function_name">
58 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-get-address" title="gst_rtsp_server_get_address ()">gst_rtsp_server_get_address</a> <span class="c_punctuation">()</span>
59 </td>
60 </tr>
61 <tr>
62 <td class="function_type">
63 <span class="returnvalue">void</span>
64 </td>
65 <td class="function_name">
66 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-address" title="gst_rtsp_server_set_address ()">gst_rtsp_server_set_address</a> <span class="c_punctuation">()</span>
67 </td>
68 </tr>
69 <tr>
70 <td class="function_type">
71 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
72 </td>
73 <td class="function_name">
74 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-get-service" title="gst_rtsp_server_get_service ()">gst_rtsp_server_get_service</a> <span class="c_punctuation">()</span>
75 </td>
76 </tr>
77 <tr>
78 <td class="function_type">
79 <span class="returnvalue">void</span>
80 </td>
81 <td class="function_name">
82 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-service" title="gst_rtsp_server_set_service ()">gst_rtsp_server_set_service</a> <span class="c_punctuation">()</span>
83 </td>
84 </tr>
85 <tr>
86 <td class="function_type">
87 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
88 </td>
89 <td class="function_name">
90 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-get-backlog" title="gst_rtsp_server_get_backlog ()">gst_rtsp_server_get_backlog</a> <span class="c_punctuation">()</span>
91 </td>
92 </tr>
93 <tr>
94 <td class="function_type">
95 <span class="returnvalue">void</span>
96 </td>
97 <td class="function_name">
98 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-backlog" title="gst_rtsp_server_set_backlog ()">gst_rtsp_server_set_backlog</a> <span class="c_punctuation">()</span>
99 </td>
100 </tr>
101 <tr>
102 <td class="function_type">
103 <span class="returnvalue">int</span>
104 </td>
105 <td class="function_name">
106 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-get-bound-port" title="gst_rtsp_server_get_bound_port ()">gst_rtsp_server_get_bound_port</a> <span class="c_punctuation">()</span>
107 </td>
108 </tr>
109 <tr>
110 <td class="function_type">
111 <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="returnvalue">GstRTSPMountPoints</span></a> *
112 </td>
113 <td class="function_name">
114 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-get-mount-points" title="gst_rtsp_server_get_mount_points ()">gst_rtsp_server_get_mount_points</a> <span class="c_punctuation">()</span>
115 </td>
116 </tr>
117 <tr>
118 <td class="function_type">
119 <span class="returnvalue">void</span>
120 </td>
121 <td class="function_name">
122 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-mount-points" title="gst_rtsp_server_set_mount_points ()">gst_rtsp_server_set_mount_points</a> <span class="c_punctuation">()</span>
123 </td>
124 </tr>
125 <tr>
126 <td class="function_type">
127 <a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="returnvalue">GstRTSPSessionPool</span></a> *
128 </td>
129 <td class="function_name">
130 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-get-session-pool" title="gst_rtsp_server_get_session_pool ()">gst_rtsp_server_get_session_pool</a> <span class="c_punctuation">()</span>
131 </td>
132 </tr>
133 <tr>
134 <td class="function_type">
135 <span class="returnvalue">void</span>
136 </td>
137 <td class="function_name">
138 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-session-pool" title="gst_rtsp_server_set_session_pool ()">gst_rtsp_server_set_session_pool</a> <span class="c_punctuation">()</span>
139 </td>
140 </tr>
141 <tr>
142 <td class="function_type">
143 <a class="link" href="gst-rtsp-server-GstRTSPThreadPool.html#GstRTSPThreadPool" title="struct GstRTSPThreadPool"><span class="returnvalue">GstRTSPThreadPool</span></a> *
144 </td>
145 <td class="function_name">
146 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-get-thread-pool" title="gst_rtsp_server_get_thread_pool ()">gst_rtsp_server_get_thread_pool</a> <span class="c_punctuation">()</span>
147 </td>
148 </tr>
149 <tr>
150 <td class="function_type">
151 <span class="returnvalue">void</span>
152 </td>
153 <td class="function_name">
154 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-thread-pool" title="gst_rtsp_server_set_thread_pool ()">gst_rtsp_server_set_thread_pool</a> <span class="c_punctuation">()</span>
155 </td>
156 </tr>
157 <tr>
158 <td class="function_type">
159 <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="returnvalue">GstRTSPAuth</span></a> *
160 </td>
161 <td class="function_name">
162 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-get-auth" title="gst_rtsp_server_get_auth ()">gst_rtsp_server_get_auth</a> <span class="c_punctuation">()</span>
163 </td>
164 </tr>
165 <tr>
166 <td class="function_type">
167 <span class="returnvalue">void</span>
168 </td>
169 <td class="function_name">
170 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-auth" title="gst_rtsp_server_set_auth ()">gst_rtsp_server_set_auth</a> <span class="c_punctuation">()</span>
171 </td>
172 </tr>
173 <tr>
174 <td class="function_type">
175 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
176 </td>
177 <td class="function_name">
178 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-transfer-connection" title="gst_rtsp_server_transfer_connection ()">gst_rtsp_server_transfer_connection</a> <span class="c_punctuation">()</span>
179 </td>
180 </tr>
181 <tr>
182 <td class="function_type">
183 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
184 </td>
185 <td class="function_name">
186 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-io-func" title="gst_rtsp_server_io_func ()">gst_rtsp_server_io_func</a> <span class="c_punctuation">()</span>
187 </td>
188 </tr>
189 <tr>
190 <td class="function_type">
191 <a href="http://library.gnome.org/devel/gio/unstable/GSocket.html"><span class="returnvalue">GSocket</span></a> *
192 </td>
193 <td class="function_name">
194 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-create-socket" title="gst_rtsp_server_create_socket ()">gst_rtsp_server_create_socket</a> <span class="c_punctuation">()</span>
195 </td>
196 </tr>
197 <tr>
198 <td class="function_type">
199 <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *
200 </td>
201 <td class="function_name">
202 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-create-source" title="gst_rtsp_server_create_source ()">gst_rtsp_server_create_source</a> <span class="c_punctuation">()</span>
203 </td>
204 </tr>
205 <tr>
206 <td class="function_type">
207 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
208 </td>
209 <td class="function_name">
210 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-attach" title="gst_rtsp_server_attach ()">gst_rtsp_server_attach</a> <span class="c_punctuation">()</span>
211 </td>
212 </tr>
213 <tr>
214 <td class="function_type">
215 <a class="link" href="GstRTSPSession.html#GstRTSPFilterResult" title="enum GstRTSPFilterResult"><span class="returnvalue">GstRTSPFilterResult</span></a>
216 </td>
217 <td class="function_name">
218 <span class="c_punctuation">(</span><a class="link" href="GstRTSPServer.html#GstRTSPServerClientFilterFunc" title="GstRTSPServerClientFilterFunc ()">*GstRTSPServerClientFilterFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
219 </td>
220 </tr>
221 <tr>
222 <td class="function_type">
223 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
224 </td>
225 <td class="function_name">
226 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-client-filter" title="gst_rtsp_server_client_filter ()">gst_rtsp_server_client_filter</a> <span class="c_punctuation">()</span>
227 </td>
228 </tr>
229 </tbody>
230 </table></div>
231 </div>
232 <div class="refsect1">
233 <a name="GstRTSPServer.properties"></a><h2>Properties</h2>
234 <div class="informaltable"><table border="0">
235 <colgroup>
236 <col width="150px" class="properties_type">
237 <col width="300px" class="properties_name">
238 <col width="200px" class="properties_flags">
239 </colgroup>
240 <tbody>
241 <tr>
242 <td class="property_type">
243 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
244 <td class="property_name"><a class="link" href="GstRTSPServer.html#GstRTSPServer--address" title="The “address” property">address</a></td>
245 <td class="property_flags">Read / Write</td>
246 </tr>
247 <tr>
248 <td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
249 <td class="property_name"><a class="link" href="GstRTSPServer.html#GstRTSPServer--backlog" title="The “backlog” property">backlog</a></td>
250 <td class="property_flags">Read / Write</td>
251 </tr>
252 <tr>
253 <td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
254 <td class="property_name"><a class="link" href="GstRTSPServer.html#GstRTSPServer--bound-port" title="The “bound-port” property">bound-port</a></td>
255 <td class="property_flags">Read</td>
256 </tr>
257 <tr>
258 <td class="property_type">
259 <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> *</td>
260 <td class="property_name"><a class="link" href="GstRTSPServer.html#GstRTSPServer--mount-points" title="The “mount-points” property">mount-points</a></td>
261 <td class="property_flags">Read / Write</td>
262 </tr>
263 <tr>
264 <td class="property_type">
265 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
266 <td class="property_name"><a class="link" href="GstRTSPServer.html#GstRTSPServer--service" title="The “service” property">service</a></td>
267 <td class="property_flags">Read / Write</td>
268 </tr>
269 <tr>
270 <td class="property_type">
271 <a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="type">GstRTSPSessionPool</span></a> *</td>
272 <td class="property_name"><a class="link" href="GstRTSPServer.html#GstRTSPServer--session-pool" title="The “session-pool” property">session-pool</a></td>
273 <td class="property_flags">Read / Write</td>
274 </tr>
275 </tbody>
276 </table></div>
277 </div>
278 <div class="refsect1">
279 <a name="GstRTSPServer.signals"></a><h2>Signals</h2>
280 <div class="informaltable"><table border="0">
281 <colgroup>
282 <col width="150px" class="signals_return">
283 <col width="300px" class="signals_name">
284 <col width="200px" class="signals_flags">
285 </colgroup>
286 <tbody><tr>
287 <td class="signal_type"><span class="returnvalue">void</span></td>
288 <td class="signal_name"><a class="link" href="GstRTSPServer.html#GstRTSPServer-client-connected" title="The “client-connected” signal">client-connected</a></td>
289 <td class="signal_flags">Run Last</td>
290 </tr></tbody>
291 </table></div>
292 </div>
293 <div class="refsect1">
294 <a name="GstRTSPServer.other"></a><h2>Types and Values</h2>
295 <div class="informaltable"><table width="100%" border="0">
296 <colgroup>
297 <col width="150px" class="name">
298 <col class="description">
299 </colgroup>
300 <tbody>
301 <tr>
302 <td class="datatype_keyword">struct</td>
303 <td class="function_name"><a class="link" href="GstRTSPServer.html#GstRTSPServer-struct" title="struct GstRTSPServer">GstRTSPServer</a></td>
304 </tr>
305 <tr>
306 <td class="datatype_keyword">struct</td>
307 <td class="function_name"><a class="link" href="GstRTSPServer.html#GstRTSPServerClass" title="struct GstRTSPServerClass">GstRTSPServerClass</a></td>
308 </tr>
309 </tbody>
310 </table></div>
311 </div>
312 <div class="refsect1">
313 <a name="GstRTSPServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
314 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
315     <span class="lineart">╰──</span> GstRTSPServer
316 </pre>
317 </div>
318 <div class="refsect1">
319 <a name="GstRTSPServer.description"></a><h2>Description</h2>
320 <p>The server object is the object listening for connections on a port and
321 creating <a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a> objects to handle those connections.</p>
322 <p>The server will listen on the address set with <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-address" title="gst_rtsp_server_set_address ()"><code class="function">gst_rtsp_server_set_address()</code></a>
323 and the port or service configured with <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-service" title="gst_rtsp_server_set_service ()"><code class="function">gst_rtsp_server_set_service()</code></a>.
324 Use <a class="link" href="GstRTSPServer.html#gst-rtsp-server-set-backlog" title="gst_rtsp_server_set_backlog ()"><code class="function">gst_rtsp_server_set_backlog()</code></a> to configure the amount of pending requests
325 that the server will keep. By default the server listens on the current
326 network (0.0.0.0) and port 8554.</p>
327 <p>The server will require an SSL connection when a TLS certificate has been
328 set in the auth object with <a class="link" href="GstRTSPAuth.html#gst-rtsp-auth-set-tls-certificate" title="gst_rtsp_auth_set_tls_certificate ()"><code class="function">gst_rtsp_auth_set_tls_certificate()</code></a>.</p>
329 <p>To start the server, use <a class="link" href="GstRTSPServer.html#gst-rtsp-server-attach" title="gst_rtsp_server_attach ()"><code class="function">gst_rtsp_server_attach()</code></a> to attach it to a
330 <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a>. For more control, <a class="link" href="GstRTSPServer.html#gst-rtsp-server-create-source" title="gst_rtsp_server_create_source ()"><code class="function">gst_rtsp_server_create_source()</code></a> and
331 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-create-socket" title="gst_rtsp_server_create_socket ()"><code class="function">gst_rtsp_server_create_socket()</code></a> can be used to get a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a> and <a href="http://library.gnome.org/devel/gio/unstable/GSocket.html"><span class="type">GSocket</span></a>
332 respectively.</p>
333 <p>gst_rtsp_server_transfer_connection() can be used to transfer an existing
334 socket to the RTSP server, for example from an HTTP server.</p>
335 <p>Once the server socket is attached to a mainloop, it will start accepting
336 connections. When a new connection is received, a new <a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a> object
337 is created to handle the connection. The new client will be configured with
338 the server <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a>, <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a>, <a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="type">GstRTSPSessionPool</span></a> and
339 <a class="link" href="gst-rtsp-server-GstRTSPThreadPool.html#GstRTSPThreadPool" title="struct GstRTSPThreadPool"><span class="type">GstRTSPThreadPool</span></a>.</p>
340 <p>The server uses the configured <a class="link" href="gst-rtsp-server-GstRTSPThreadPool.html#GstRTSPThreadPool" title="struct GstRTSPThreadPool"><span class="type">GstRTSPThreadPool</span></a> object to handle the
341 remainder of the communication with this client.</p>
342 <p>Last reviewed on 2013-07-11 (1.0.0)</p>
343 </div>
344 <div class="refsect1">
345 <a name="GstRTSPServer.functions_details"></a><h2>Functions</h2>
346 <div class="refsect2">
347 <a name="gst-rtsp-server-new"></a><h3>gst_rtsp_server_new ()</h3>
348 <pre class="programlisting"><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="returnvalue">GstRTSPServer</span></a> *
349 gst_rtsp_server_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
350 <p>Create a new <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> instance.</p>
351 <div class="refsect3">
352 <a name="id-1.2.1.9.2.5"></a><h4>Returns</h4>
353 <p> a new <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a>. </p>
354 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
355 </div>
356 </div>
357 <hr>
358 <div class="refsect2">
359 <a name="gst-rtsp-server-get-address"></a><h3>gst_rtsp_server_get_address ()</h3>
360 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
361 gst_rtsp_server_get_address (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>);</pre>
362 <p>Get the address on which the server will accept connections.</p>
363 <div class="refsect3">
364 <a name="id-1.2.1.9.3.5"></a><h4>Parameters</h4>
365 <div class="informaltable"><table width="100%" border="0">
366 <colgroup>
367 <col width="150px" class="parameters_name">
368 <col class="parameters_description">
369 <col width="200px" class="parameters_annotations">
370 </colgroup>
371 <tbody><tr>
372 <td class="parameter_name"><p>server</p></td>
373 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
374 <td class="parameter_annotations"> </td>
375 </tr></tbody>
376 </table></div>
377 </div>
378 <div class="refsect3">
379 <a name="id-1.2.1.9.3.6"></a><h4>Returns</h4>
380 <p> the server address. <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> after usage. </p>
381 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
382 </div>
383 </div>
384 <hr>
385 <div class="refsect2">
386 <a name="gst-rtsp-server-set-address"></a><h3>gst_rtsp_server_set_address ()</h3>
387 <pre class="programlisting"><span class="returnvalue">void</span>
388 gst_rtsp_server_set_address (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
389                              <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> *address</code></em>);</pre>
390 <p>Configure <em class="parameter"><code>server</code></em>
391  to accept connections on the given address.</p>
392 <p>This function must be called before the server is bound.</p>
393 <div class="refsect3">
394 <a name="id-1.2.1.9.4.6"></a><h4>Parameters</h4>
395 <div class="informaltable"><table width="100%" border="0">
396 <colgroup>
397 <col width="150px" class="parameters_name">
398 <col class="parameters_description">
399 <col width="200px" class="parameters_annotations">
400 </colgroup>
401 <tbody>
402 <tr>
403 <td class="parameter_name"><p>server</p></td>
404 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
405 <td class="parameter_annotations"> </td>
406 </tr>
407 <tr>
408 <td class="parameter_name"><p>address</p></td>
409 <td class="parameter_description"><p>the address</p></td>
410 <td class="parameter_annotations"> </td>
411 </tr>
412 </tbody>
413 </table></div>
414 </div>
415 </div>
416 <hr>
417 <div class="refsect2">
418 <a name="gst-rtsp-server-get-service"></a><h3>gst_rtsp_server_get_service ()</h3>
419 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
420 gst_rtsp_server_get_service (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>);</pre>
421 <p>Get the service on which the server will accept connections.</p>
422 <div class="refsect3">
423 <a name="id-1.2.1.9.5.5"></a><h4>Parameters</h4>
424 <div class="informaltable"><table width="100%" border="0">
425 <colgroup>
426 <col width="150px" class="parameters_name">
427 <col class="parameters_description">
428 <col width="200px" class="parameters_annotations">
429 </colgroup>
430 <tbody><tr>
431 <td class="parameter_name"><p>server</p></td>
432 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
433 <td class="parameter_annotations"> </td>
434 </tr></tbody>
435 </table></div>
436 </div>
437 <div class="refsect3">
438 <a name="id-1.2.1.9.5.6"></a><h4>Returns</h4>
439 <p> the service. use <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> after usage. </p>
440 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
441 </div>
442 </div>
443 <hr>
444 <div class="refsect2">
445 <a name="gst-rtsp-server-set-service"></a><h3>gst_rtsp_server_set_service ()</h3>
446 <pre class="programlisting"><span class="returnvalue">void</span>
447 gst_rtsp_server_set_service (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
448                              <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> *service</code></em>);</pre>
449 <p>Configure <em class="parameter"><code>server</code></em>
450  to accept connections on the given service.
451 <em class="parameter"><code>service</code></em>
452  should be a string containing the service name (see services(5)) or
453 a string containing a port number between 1 and 65535.</p>
454 <p>When <em class="parameter"><code>service</code></em>
455  is set to "0", the server will listen on a random free
456 port. The actual used port can be retrieved with
457 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-get-bound-port" title="gst_rtsp_server_get_bound_port ()"><code class="function">gst_rtsp_server_get_bound_port()</code></a>.</p>
458 <p>This function must be called before the server is bound.</p>
459 <div class="refsect3">
460 <a name="id-1.2.1.9.6.7"></a><h4>Parameters</h4>
461 <div class="informaltable"><table width="100%" border="0">
462 <colgroup>
463 <col width="150px" class="parameters_name">
464 <col class="parameters_description">
465 <col width="200px" class="parameters_annotations">
466 </colgroup>
467 <tbody>
468 <tr>
469 <td class="parameter_name"><p>server</p></td>
470 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
471 <td class="parameter_annotations"> </td>
472 </tr>
473 <tr>
474 <td class="parameter_name"><p>service</p></td>
475 <td class="parameter_description"><p>the service</p></td>
476 <td class="parameter_annotations"> </td>
477 </tr>
478 </tbody>
479 </table></div>
480 </div>
481 </div>
482 <hr>
483 <div class="refsect2">
484 <a name="gst-rtsp-server-get-backlog"></a><h3>gst_rtsp_server_get_backlog ()</h3>
485 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
486 gst_rtsp_server_get_backlog (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>);</pre>
487 <p>The maximum amount of queued requests for the server.</p>
488 <div class="refsect3">
489 <a name="id-1.2.1.9.7.5"></a><h4>Parameters</h4>
490 <div class="informaltable"><table width="100%" border="0">
491 <colgroup>
492 <col width="150px" class="parameters_name">
493 <col class="parameters_description">
494 <col width="200px" class="parameters_annotations">
495 </colgroup>
496 <tbody><tr>
497 <td class="parameter_name"><p>server</p></td>
498 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
499 <td class="parameter_annotations"> </td>
500 </tr></tbody>
501 </table></div>
502 </div>
503 <div class="refsect3">
504 <a name="id-1.2.1.9.7.6"></a><h4>Returns</h4>
505 <p> the server backlog.</p>
506 <p></p>
507 </div>
508 </div>
509 <hr>
510 <div class="refsect2">
511 <a name="gst-rtsp-server-set-backlog"></a><h3>gst_rtsp_server_set_backlog ()</h3>
512 <pre class="programlisting"><span class="returnvalue">void</span>
513 gst_rtsp_server_set_backlog (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
514                              <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> backlog</code></em>);</pre>
515 <p>configure the maximum amount of requests that may be queued for the
516 server.</p>
517 <p>This function must be called before the server is bound.</p>
518 <div class="refsect3">
519 <a name="id-1.2.1.9.8.6"></a><h4>Parameters</h4>
520 <div class="informaltable"><table width="100%" border="0">
521 <colgroup>
522 <col width="150px" class="parameters_name">
523 <col class="parameters_description">
524 <col width="200px" class="parameters_annotations">
525 </colgroup>
526 <tbody>
527 <tr>
528 <td class="parameter_name"><p>server</p></td>
529 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
530 <td class="parameter_annotations"> </td>
531 </tr>
532 <tr>
533 <td class="parameter_name"><p>backlog</p></td>
534 <td class="parameter_description"><p>the backlog</p></td>
535 <td class="parameter_annotations"> </td>
536 </tr>
537 </tbody>
538 </table></div>
539 </div>
540 </div>
541 <hr>
542 <div class="refsect2">
543 <a name="gst-rtsp-server-get-bound-port"></a><h3>gst_rtsp_server_get_bound_port ()</h3>
544 <pre class="programlisting"><span class="returnvalue">int</span>
545 gst_rtsp_server_get_bound_port (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>);</pre>
546 <p>Get the port number where the server was bound to.</p>
547 <div class="refsect3">
548 <a name="id-1.2.1.9.9.5"></a><h4>Parameters</h4>
549 <div class="informaltable"><table width="100%" border="0">
550 <colgroup>
551 <col width="150px" class="parameters_name">
552 <col class="parameters_description">
553 <col width="200px" class="parameters_annotations">
554 </colgroup>
555 <tbody><tr>
556 <td class="parameter_name"><p>server</p></td>
557 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
558 <td class="parameter_annotations"> </td>
559 </tr></tbody>
560 </table></div>
561 </div>
562 <div class="refsect3">
563 <a name="id-1.2.1.9.9.6"></a><h4>Returns</h4>
564 <p> the port number</p>
565 <p></p>
566 </div>
567 </div>
568 <hr>
569 <div class="refsect2">
570 <a name="gst-rtsp-server-get-mount-points"></a><h3>gst_rtsp_server_get_mount_points ()</h3>
571 <pre class="programlisting"><a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="returnvalue">GstRTSPMountPoints</span></a> *
572 gst_rtsp_server_get_mount_points (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>);</pre>
573 <p>Get the <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> used as the mount points of <em class="parameter"><code>server</code></em>
574 .</p>
575 <div class="refsect3">
576 <a name="id-1.2.1.9.10.5"></a><h4>Parameters</h4>
577 <div class="informaltable"><table width="100%" border="0">
578 <colgroup>
579 <col width="150px" class="parameters_name">
580 <col class="parameters_description">
581 <col width="200px" class="parameters_annotations">
582 </colgroup>
583 <tbody><tr>
584 <td class="parameter_name"><p>server</p></td>
585 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
586 <td class="parameter_annotations"> </td>
587 </tr></tbody>
588 </table></div>
589 </div>
590 <div class="refsect3">
591 <a name="id-1.2.1.9.10.6"></a><h4>Returns</h4>
592 <p> the <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> of <em class="parameter"><code>server</code></em>
593 . <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> after
594 usage. </p>
595 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
596 </div>
597 </div>
598 <hr>
599 <div class="refsect2">
600 <a name="gst-rtsp-server-set-mount-points"></a><h3>gst_rtsp_server_set_mount_points ()</h3>
601 <pre class="programlisting"><span class="returnvalue">void</span>
602 gst_rtsp_server_set_mount_points (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
603                                   <em class="parameter"><code><a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> *mounts</code></em>);</pre>
604 <p>configure <em class="parameter"><code>mounts</code></em>
605  to be used as the mount points of <em class="parameter"><code>server</code></em>
606 .</p>
607 <div class="refsect3">
608 <a name="id-1.2.1.9.11.5"></a><h4>Parameters</h4>
609 <div class="informaltable"><table width="100%" border="0">
610 <colgroup>
611 <col width="150px" class="parameters_name">
612 <col class="parameters_description">
613 <col width="200px" class="parameters_annotations">
614 </colgroup>
615 <tbody>
616 <tr>
617 <td class="parameter_name"><p>server</p></td>
618 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
619 <td class="parameter_annotations"> </td>
620 </tr>
621 <tr>
622 <td class="parameter_name"><p>mounts</p></td>
623 <td class="parameter_description"><p> a <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a>. </p></td>
624 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
625 </tr>
626 </tbody>
627 </table></div>
628 </div>
629 </div>
630 <hr>
631 <div class="refsect2">
632 <a name="gst-rtsp-server-get-session-pool"></a><h3>gst_rtsp_server_get_session_pool ()</h3>
633 <pre class="programlisting"><a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="returnvalue">GstRTSPSessionPool</span></a> *
634 gst_rtsp_server_get_session_pool (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>);</pre>
635 <p>Get the <a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="type">GstRTSPSessionPool</span></a> used as the session pool of <em class="parameter"><code>server</code></em>
636 .</p>
637 <div class="refsect3">
638 <a name="id-1.2.1.9.12.5"></a><h4>Parameters</h4>
639 <div class="informaltable"><table width="100%" border="0">
640 <colgroup>
641 <col width="150px" class="parameters_name">
642 <col class="parameters_description">
643 <col width="200px" class="parameters_annotations">
644 </colgroup>
645 <tbody><tr>
646 <td class="parameter_name"><p>server</p></td>
647 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
648 <td class="parameter_annotations"> </td>
649 </tr></tbody>
650 </table></div>
651 </div>
652 <div class="refsect3">
653 <a name="id-1.2.1.9.12.6"></a><h4>Returns</h4>
654 <p> the <a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="type">GstRTSPSessionPool</span></a> used for sessions. <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> after
655 usage. </p>
656 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
657 </div>
658 </div>
659 <hr>
660 <div class="refsect2">
661 <a name="gst-rtsp-server-set-session-pool"></a><h3>gst_rtsp_server_set_session_pool ()</h3>
662 <pre class="programlisting"><span class="returnvalue">void</span>
663 gst_rtsp_server_set_session_pool (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
664                                   <em class="parameter"><code><a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="type">GstRTSPSessionPool</span></a> *pool</code></em>);</pre>
665 <p>configure <em class="parameter"><code>pool</code></em>
666  to be used as the session pool of <em class="parameter"><code>server</code></em>
667 .</p>
668 <div class="refsect3">
669 <a name="id-1.2.1.9.13.5"></a><h4>Parameters</h4>
670 <div class="informaltable"><table width="100%" border="0">
671 <colgroup>
672 <col width="150px" class="parameters_name">
673 <col class="parameters_description">
674 <col width="200px" class="parameters_annotations">
675 </colgroup>
676 <tbody>
677 <tr>
678 <td class="parameter_name"><p>server</p></td>
679 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
680 <td class="parameter_annotations"> </td>
681 </tr>
682 <tr>
683 <td class="parameter_name"><p>pool</p></td>
684 <td class="parameter_description"><p> a <a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="type">GstRTSPSessionPool</span></a>. </p></td>
685 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
686 </tr>
687 </tbody>
688 </table></div>
689 </div>
690 </div>
691 <hr>
692 <div class="refsect2">
693 <a name="gst-rtsp-server-get-thread-pool"></a><h3>gst_rtsp_server_get_thread_pool ()</h3>
694 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPThreadPool.html#GstRTSPThreadPool" title="struct GstRTSPThreadPool"><span class="returnvalue">GstRTSPThreadPool</span></a> *
695 gst_rtsp_server_get_thread_pool (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>);</pre>
696 <p>Get the <a class="link" href="gst-rtsp-server-GstRTSPThreadPool.html#GstRTSPThreadPool" title="struct GstRTSPThreadPool"><span class="type">GstRTSPThreadPool</span></a> used as the thread pool of <em class="parameter"><code>server</code></em>
697 .</p>
698 <div class="refsect3">
699 <a name="id-1.2.1.9.14.5"></a><h4>Parameters</h4>
700 <div class="informaltable"><table width="100%" border="0">
701 <colgroup>
702 <col width="150px" class="parameters_name">
703 <col class="parameters_description">
704 <col width="200px" class="parameters_annotations">
705 </colgroup>
706 <tbody><tr>
707 <td class="parameter_name"><p>server</p></td>
708 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
709 <td class="parameter_annotations"> </td>
710 </tr></tbody>
711 </table></div>
712 </div>
713 <div class="refsect3">
714 <a name="id-1.2.1.9.14.6"></a><h4>Returns</h4>
715 <p> the <a class="link" href="gst-rtsp-server-GstRTSPThreadPool.html#GstRTSPThreadPool" title="struct GstRTSPThreadPool"><span class="type">GstRTSPThreadPool</span></a> of <em class="parameter"><code>server</code></em>
716 . <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> after
717 usage. </p>
718 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
719 </div>
720 </div>
721 <hr>
722 <div class="refsect2">
723 <a name="gst-rtsp-server-set-thread-pool"></a><h3>gst_rtsp_server_set_thread_pool ()</h3>
724 <pre class="programlisting"><span class="returnvalue">void</span>
725 gst_rtsp_server_set_thread_pool (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
726                                  <em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPThreadPool.html#GstRTSPThreadPool" title="struct GstRTSPThreadPool"><span class="type">GstRTSPThreadPool</span></a> *pool</code></em>);</pre>
727 <p>configure <em class="parameter"><code>pool</code></em>
728  to be used as the thread pool of <em class="parameter"><code>server</code></em>
729 .</p>
730 <div class="refsect3">
731 <a name="id-1.2.1.9.15.5"></a><h4>Parameters</h4>
732 <div class="informaltable"><table width="100%" border="0">
733 <colgroup>
734 <col width="150px" class="parameters_name">
735 <col class="parameters_description">
736 <col width="200px" class="parameters_annotations">
737 </colgroup>
738 <tbody>
739 <tr>
740 <td class="parameter_name"><p>server</p></td>
741 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
742 <td class="parameter_annotations"> </td>
743 </tr>
744 <tr>
745 <td class="parameter_name"><p>pool</p></td>
746 <td class="parameter_description"><p> a <a class="link" href="gst-rtsp-server-GstRTSPThreadPool.html#GstRTSPThreadPool" title="struct GstRTSPThreadPool"><span class="type">GstRTSPThreadPool</span></a>. </p></td>
747 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
748 </tr>
749 </tbody>
750 </table></div>
751 </div>
752 </div>
753 <hr>
754 <div class="refsect2">
755 <a name="gst-rtsp-server-get-auth"></a><h3>gst_rtsp_server_get_auth ()</h3>
756 <pre class="programlisting"><a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="returnvalue">GstRTSPAuth</span></a> *
757 gst_rtsp_server_get_auth (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>);</pre>
758 <p>Get the <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a> used as the authentication manager of <em class="parameter"><code>server</code></em>
759 .</p>
760 <div class="refsect3">
761 <a name="id-1.2.1.9.16.5"></a><h4>Parameters</h4>
762 <div class="informaltable"><table width="100%" border="0">
763 <colgroup>
764 <col width="150px" class="parameters_name">
765 <col class="parameters_description">
766 <col width="200px" class="parameters_annotations">
767 </colgroup>
768 <tbody><tr>
769 <td class="parameter_name"><p>server</p></td>
770 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
771 <td class="parameter_annotations"> </td>
772 </tr></tbody>
773 </table></div>
774 </div>
775 <div class="refsect3">
776 <a name="id-1.2.1.9.16.6"></a><h4>Returns</h4>
777 <p> the <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a> of <em class="parameter"><code>server</code></em>
778 . <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> after
779 usage. </p>
780 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
781 </div>
782 </div>
783 <hr>
784 <div class="refsect2">
785 <a name="gst-rtsp-server-set-auth"></a><h3>gst_rtsp_server_set_auth ()</h3>
786 <pre class="programlisting"><span class="returnvalue">void</span>
787 gst_rtsp_server_set_auth (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
788                           <em class="parameter"><code><a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a> *auth</code></em>);</pre>
789 <p>configure <em class="parameter"><code>auth</code></em>
790  to be used as the authentication manager of <em class="parameter"><code>server</code></em>
791 .</p>
792 <div class="refsect3">
793 <a name="id-1.2.1.9.17.5"></a><h4>Parameters</h4>
794 <div class="informaltable"><table width="100%" border="0">
795 <colgroup>
796 <col width="150px" class="parameters_name">
797 <col class="parameters_description">
798 <col width="200px" class="parameters_annotations">
799 </colgroup>
800 <tbody>
801 <tr>
802 <td class="parameter_name"><p>server</p></td>
803 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
804 <td class="parameter_annotations"> </td>
805 </tr>
806 <tr>
807 <td class="parameter_name"><p>auth</p></td>
808 <td class="parameter_description"><p> a <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a>. </p></td>
809 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
810 </tr>
811 </tbody>
812 </table></div>
813 </div>
814 </div>
815 <hr>
816 <div class="refsect2">
817 <a name="gst-rtsp-server-transfer-connection"></a><h3>gst_rtsp_server_transfer_connection ()</h3>
818 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
819 gst_rtsp_server_transfer_connection (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
820                                      <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GSocket.html"><span class="type">GSocket</span></a> *socket</code></em>,
821                                      <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> *ip</code></em>,
822                                      <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port</code></em>,
823                                      <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> *initial_buffer</code></em>);</pre>
824 <p>Take an existing network socket and use it for an RTSP connection. This
825 is used when transferring a socket from an HTTP server which should be used
826 as an RTSP over HTTP tunnel. The <em class="parameter"><code>initial_buffer</code></em>
827  contains any remaining data
828 that the HTTP server read from the socket while parsing the HTTP header.</p>
829 <div class="refsect3">
830 <a name="id-1.2.1.9.18.5"></a><h4>Parameters</h4>
831 <div class="informaltable"><table width="100%" border="0">
832 <colgroup>
833 <col width="150px" class="parameters_name">
834 <col class="parameters_description">
835 <col width="200px" class="parameters_annotations">
836 </colgroup>
837 <tbody>
838 <tr>
839 <td class="parameter_name"><p>server</p></td>
840 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
841 <td class="parameter_annotations"> </td>
842 </tr>
843 <tr>
844 <td class="parameter_name"><p>socket</p></td>
845 <td class="parameter_description"><p> a network socket. </p></td>
846 <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
847 </tr>
848 <tr>
849 <td class="parameter_name"><p>ip</p></td>
850 <td class="parameter_description"><p>the IP address of the remote client</p></td>
851 <td class="parameter_annotations"> </td>
852 </tr>
853 <tr>
854 <td class="parameter_name"><p>port</p></td>
855 <td class="parameter_description"><p>the port used by the other end</p></td>
856 <td class="parameter_annotations"> </td>
857 </tr>
858 <tr>
859 <td class="parameter_name"><p>initial_buffer</p></td>
860 <td class="parameter_description"><p>any initial data that was already read from the socket</p></td>
861 <td class="parameter_annotations"> </td>
862 </tr>
863 </tbody>
864 </table></div>
865 </div>
866 <div class="refsect3">
867 <a name="id-1.2.1.9.18.6"></a><h4>Returns</h4>
868 <p> TRUE if all was ok, FALSE if an error occurred.</p>
869 <p></p>
870 </div>
871 </div>
872 <hr>
873 <div class="refsect2">
874 <a name="gst-rtsp-server-io-func"></a><h3>gst_rtsp_server_io_func ()</h3>
875 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
876 gst_rtsp_server_io_func (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GSocket.html"><span class="type">GSocket</span></a> *socket</code></em>,
877                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition"><span class="type">GIOCondition</span></a> condition</code></em>,
878                          <em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>);</pre>
879 <p>A default <a href="http://library.gnome.org/devel/gio/unstable/GSocket.html#GSocketSourceFunc"><span class="type">GSocketSourceFunc</span></a> that creates a new <a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a> to accept and handle a
880 new connection on <em class="parameter"><code>socket</code></em>
881  or <em class="parameter"><code>server</code></em>
882 .</p>
883 <div class="refsect3">
884 <a name="id-1.2.1.9.19.5"></a><h4>Parameters</h4>
885 <div class="informaltable"><table width="100%" border="0">
886 <colgroup>
887 <col width="150px" class="parameters_name">
888 <col class="parameters_description">
889 <col width="200px" class="parameters_annotations">
890 </colgroup>
891 <tbody>
892 <tr>
893 <td class="parameter_name"><p>socket</p></td>
894 <td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/gio/unstable/GSocket.html"><span class="type">GSocket</span></a></p></td>
895 <td class="parameter_annotations"> </td>
896 </tr>
897 <tr>
898 <td class="parameter_name"><p>condition</p></td>
899 <td class="parameter_description"><p>the condition on <em class="parameter"><code>source</code></em>
900 </p></td>
901 <td class="parameter_annotations"> </td>
902 </tr>
903 <tr>
904 <td class="parameter_name"><p>server</p></td>
905 <td class="parameter_description"><p> a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a>. </p></td>
906 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
907 </tr>
908 </tbody>
909 </table></div>
910 </div>
911 <div class="refsect3">
912 <a name="id-1.2.1.9.19.6"></a><h4>Returns</h4>
913 <p> TRUE if the source could be connected, FALSE if an error occurred.</p>
914 <p></p>
915 </div>
916 </div>
917 <hr>
918 <div class="refsect2">
919 <a name="gst-rtsp-server-create-socket"></a><h3>gst_rtsp_server_create_socket ()</h3>
920 <pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GSocket.html"><span class="returnvalue">GSocket</span></a> *
921 gst_rtsp_server_create_socket (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
922                                <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
923                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
924 <p>Create a <a href="http://library.gnome.org/devel/gio/unstable/GSocket.html"><span class="type">GSocket</span></a> for <em class="parameter"><code>server</code></em>
925 . The socket will listen on the
926 configured service.</p>
927 <div class="refsect3">
928 <a name="id-1.2.1.9.20.5"></a><h4>Parameters</h4>
929 <div class="informaltable"><table width="100%" border="0">
930 <colgroup>
931 <col width="150px" class="parameters_name">
932 <col class="parameters_description">
933 <col width="200px" class="parameters_annotations">
934 </colgroup>
935 <tbody>
936 <tr>
937 <td class="parameter_name"><p>server</p></td>
938 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
939 <td class="parameter_annotations"> </td>
940 </tr>
941 <tr>
942 <td class="parameter_name"><p>cancellable</p></td>
943 <td class="parameter_description"><p> a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
944 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
945 </tr>
946 <tr>
947 <td class="parameter_name"><p>error</p></td>
948 <td class="parameter_description"><p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. </p></td>
949 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
950 </tr>
951 </tbody>
952 </table></div>
953 </div>
954 <div class="refsect3">
955 <a name="id-1.2.1.9.20.6"></a><h4>Returns</h4>
956 <p> the <a href="http://library.gnome.org/devel/gio/unstable/GSocket.html"><span class="type">GSocket</span></a> for <em class="parameter"><code>server</code></em>
957 or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> when an error
958 occurred. </p>
959 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
960 </div>
961 </div>
962 <hr>
963 <div class="refsect2">
964 <a name="gst-rtsp-server-create-source"></a><h3>gst_rtsp_server_create_source ()</h3>
965 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *
966 gst_rtsp_server_create_source (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
967                                <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
968                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
969 <p>Create a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a> for <em class="parameter"><code>server</code></em>
970 . The new source will have a default
971 <a href="http://library.gnome.org/devel/gio/unstable/GSocket.html#GSocketSourceFunc"><span class="type">GSocketSourceFunc</span></a> of <a class="link" href="GstRTSPServer.html#gst-rtsp-server-io-func" title="gst_rtsp_server_io_func ()"><code class="function">gst_rtsp_server_io_func()</code></a>.</p>
972 <p><em class="parameter"><code>cancellable</code></em>
973  if not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> can be used to cancel the source, which will cause
974 the source to trigger, reporting the current condition (which is likely 0
975 unless cancellation happened at the same time as a condition change). You can
976 check for this in the callback using <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html#g-cancellable-is-cancelled"><code class="function">g_cancellable_is_cancelled()</code></a>.</p>
977 <div class="refsect3">
978 <a name="id-1.2.1.9.21.6"></a><h4>Parameters</h4>
979 <div class="informaltable"><table width="100%" border="0">
980 <colgroup>
981 <col width="150px" class="parameters_name">
982 <col class="parameters_description">
983 <col width="200px" class="parameters_annotations">
984 </colgroup>
985 <tbody>
986 <tr>
987 <td class="parameter_name"><p>server</p></td>
988 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
989 <td class="parameter_annotations"> </td>
990 </tr>
991 <tr>
992 <td class="parameter_name"><p>cancellable</p></td>
993 <td class="parameter_description"><p> a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
994 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
995 </tr>
996 <tr>
997 <td class="parameter_name"><p>error</p></td>
998 <td class="parameter_description"><p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. </p></td>
999 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1000 </tr>
1001 </tbody>
1002 </table></div>
1003 </div>
1004 <div class="refsect3">
1005 <a name="id-1.2.1.9.21.7"></a><h4>Returns</h4>
1006 <p> the <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a> for <em class="parameter"><code>server</code></em>
1007 or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> when an error
1008 occurred. Free with <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-unref"><code class="function">g_source_unref()</code></a>. </p>
1009 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
1010 </div>
1011 </div>
1012 <hr>
1013 <div class="refsect2">
1014 <a name="gst-rtsp-server-attach"></a><h3>gst_rtsp_server_attach ()</h3>
1015 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
1016 gst_rtsp_server_attach (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
1017                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *context</code></em>);</pre>
1018 <p>Attaches <em class="parameter"><code>server</code></em>
1019  to <em class="parameter"><code>context</code></em>
1020 . When the mainloop for <em class="parameter"><code>context</code></em>
1021  is run, the
1022 server will be dispatched. When <em class="parameter"><code>context</code></em>
1023  is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default context will be
1024 used).</p>
1025 <p>This function should be called when the server properties and urls are fully
1026 configured and the server is ready to start.</p>
1027 <div class="refsect3">
1028 <a name="id-1.2.1.9.22.6"></a><h4>Parameters</h4>
1029 <div class="informaltable"><table width="100%" border="0">
1030 <colgroup>
1031 <col width="150px" class="parameters_name">
1032 <col class="parameters_description">
1033 <col width="200px" class="parameters_annotations">
1034 </colgroup>
1035 <tbody>
1036 <tr>
1037 <td class="parameter_name"><p>server</p></td>
1038 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
1039 <td class="parameter_annotations"> </td>
1040 </tr>
1041 <tr>
1042 <td class="parameter_name"><p>context</p></td>
1043 <td class="parameter_description"><p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a>. </p></td>
1044 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1045 </tr>
1046 </tbody>
1047 </table></div>
1048 </div>
1049 <div class="refsect3">
1050 <a name="id-1.2.1.9.22.7"></a><h4>Returns</h4>
1051 <p> the ID (greater than 0) for the source within the GMainContext.</p>
1052 <p></p>
1053 </div>
1054 </div>
1055 <hr>
1056 <div class="refsect2">
1057 <a name="GstRTSPServerClientFilterFunc"></a><h3>GstRTSPServerClientFilterFunc ()</h3>
1058 <pre class="programlisting"><a class="link" href="GstRTSPSession.html#GstRTSPFilterResult" title="enum GstRTSPFilterResult"><span class="returnvalue">GstRTSPFilterResult</span></a>
1059 <span class="c_punctuation">(</span>*GstRTSPServerClientFilterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
1060                                   <em class="parameter"><code><a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a> *client</code></em>,
1061                                   <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
1062 <p>This function will be called by the <a class="link" href="GstRTSPServer.html#gst-rtsp-server-client-filter" title="gst_rtsp_server_client_filter ()"><code class="function">gst_rtsp_server_client_filter()</code></a>. An
1063 implementation should return a value of <a class="link" href="GstRTSPSession.html#GstRTSPFilterResult" title="enum GstRTSPFilterResult"><span class="type">GstRTSPFilterResult</span></a>.</p>
1064 <p>When this function returns <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-REMOVE:CAPS"><span class="type">GST_RTSP_FILTER_REMOVE</span></a>, <em class="parameter"><code>client</code></em>
1065  will be removed
1066 from <em class="parameter"><code>server</code></em>
1067 .</p>
1068 <p>A return value of <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-KEEP:CAPS"><span class="type">GST_RTSP_FILTER_KEEP</span></a> will leave <em class="parameter"><code>client</code></em>
1069  untouched in
1070 <em class="parameter"><code>server</code></em>
1071 .</p>
1072 <p>A value of <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-REF:CAPS"><span class="type">GST_RTSP_FILTER_REF</span></a> will add <em class="parameter"><code>client</code></em>
1073  to the result <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
1074 <a class="link" href="GstRTSPServer.html#gst-rtsp-server-client-filter" title="gst_rtsp_server_client_filter ()"><code class="function">gst_rtsp_server_client_filter()</code></a>.</p>
1075 <div class="refsect3">
1076 <a name="id-1.2.1.9.23.8"></a><h4>Parameters</h4>
1077 <div class="informaltable"><table width="100%" border="0">
1078 <colgroup>
1079 <col width="150px" class="parameters_name">
1080 <col class="parameters_description">
1081 <col width="200px" class="parameters_annotations">
1082 </colgroup>
1083 <tbody>
1084 <tr>
1085 <td class="parameter_name"><p>server</p></td>
1086 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> object</p></td>
1087 <td class="parameter_annotations"> </td>
1088 </tr>
1089 <tr>
1090 <td class="parameter_name"><p>client</p></td>
1091 <td class="parameter_description"><p>a <a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a> in <em class="parameter"><code>server</code></em>
1092 </p></td>
1093 <td class="parameter_annotations"> </td>
1094 </tr>
1095 <tr>
1096 <td class="parameter_name"><p>user_data</p></td>
1097 <td class="parameter_description"><p>user data that has been given to <a class="link" href="GstRTSPServer.html#gst-rtsp-server-client-filter" title="gst_rtsp_server_client_filter ()"><code class="function">gst_rtsp_server_client_filter()</code></a></p></td>
1098 <td class="parameter_annotations"> </td>
1099 </tr>
1100 </tbody>
1101 </table></div>
1102 </div>
1103 <div class="refsect3">
1104 <a name="id-1.2.1.9.23.9"></a><h4>Returns</h4>
1105 <p> a <a class="link" href="GstRTSPSession.html#GstRTSPFilterResult" title="enum GstRTSPFilterResult"><span class="type">GstRTSPFilterResult</span></a>.</p>
1106 <p></p>
1107 </div>
1108 </div>
1109 <hr>
1110 <div class="refsect2">
1111 <a name="gst-rtsp-server-client-filter"></a><h3>gst_rtsp_server_client_filter ()</h3>
1112 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
1113 gst_rtsp_server_client_filter (<em class="parameter"><code><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *server</code></em>,
1114                                <em class="parameter"><code><a class="link" href="GstRTSPServer.html#GstRTSPServerClientFilterFunc" title="GstRTSPServerClientFilterFunc ()"><span class="type">GstRTSPServerClientFilterFunc</span></a> func</code></em>,
1115                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
1116 <p>Call <em class="parameter"><code>func</code></em>
1117  for each client managed by <em class="parameter"><code>server</code></em>
1118 . The result value of <em class="parameter"><code>func</code></em>
1119
1120 determines what happens to the client. <em class="parameter"><code>func</code></em>
1121  will be called with <em class="parameter"><code>server</code></em>
1122
1123 locked so no further actions on <em class="parameter"><code>server</code></em>
1124  can be performed from <em class="parameter"><code>func</code></em>
1125 .</p>
1126 <p>If <em class="parameter"><code>func</code></em>
1127  returns <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-REMOVE:CAPS"><span class="type">GST_RTSP_FILTER_REMOVE</span></a>, the client will be removed from
1128 <em class="parameter"><code>server</code></em>
1129 .</p>
1130 <p>If <em class="parameter"><code>func</code></em>
1131  returns <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-KEEP:CAPS"><span class="type">GST_RTSP_FILTER_KEEP</span></a>, the client will remain in <em class="parameter"><code>server</code></em>
1132 .</p>
1133 <p>If <em class="parameter"><code>func</code></em>
1134  returns <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-REF:CAPS"><span class="type">GST_RTSP_FILTER_REF</span></a>, the client will remain in <em class="parameter"><code>server</code></em>
1135  but
1136 will also be added with an additional ref to the result <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of this
1137 function..</p>
1138 <p>When <em class="parameter"><code>func</code></em>
1139  is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-REF:CAPS"><span class="type">GST_RTSP_FILTER_REF</span></a> will be assumed for each client.</p>
1140 <div class="refsect3">
1141 <a name="id-1.2.1.9.24.9"></a><h4>Parameters</h4>
1142 <div class="informaltable"><table width="100%" border="0">
1143 <colgroup>
1144 <col width="150px" class="parameters_name">
1145 <col class="parameters_description">
1146 <col width="200px" class="parameters_annotations">
1147 </colgroup>
1148 <tbody>
1149 <tr>
1150 <td class="parameter_name"><p>server</p></td>
1151 <td class="parameter_description"><p>a <a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a></p></td>
1152 <td class="parameter_annotations"> </td>
1153 </tr>
1154 <tr>
1155 <td class="parameter_name"><p>func</p></td>
1156 <td class="parameter_description"><p> a callback. </p></td>
1157 <td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1158 </tr>
1159 <tr>
1160 <td class="parameter_name"><p>user_data</p></td>
1161 <td class="parameter_description"><p>user data passed to <em class="parameter"><code>func</code></em>
1162 </p></td>
1163 <td class="parameter_annotations"> </td>
1164 </tr>
1165 </tbody>
1166 </table></div>
1167 </div>
1168 <div class="refsect3">
1169 <a name="id-1.2.1.9.24.10"></a><h4>Returns</h4>
1170 <p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> with all
1171 clients for which <em class="parameter"><code>func</code></em>
1172 returned <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-REF:CAPS"><span class="type">GST_RTSP_FILTER_REF</span></a>. After usage, each
1173 element in the <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> should be unreffed before the list is freed. </p>
1174 <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GstRTSPClient][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
1175 </div>
1176 </div>
1177 </div>
1178 <div class="refsect1">
1179 <a name="GstRTSPServer.other_details"></a><h2>Types and Values</h2>
1180 <div class="refsect2">
1181 <a name="GstRTSPServer-struct"></a><h3>struct GstRTSPServer</h3>
1182 <pre class="programlisting">struct GstRTSPServer;</pre>
1183 <p>This object listens on a port, creates and manages the clients connected to
1184 it.</p>
1185 </div>
1186 <hr>
1187 <div class="refsect2">
1188 <a name="GstRTSPServerClass"></a><h3>struct GstRTSPServerClass</h3>
1189 <pre class="programlisting">struct GstRTSPServerClass {
1190   GObjectClass  parent_class;
1191
1192   GstRTSPClient * (*create_client)      (GstRTSPServer *server);
1193
1194   /* signals */
1195   void            (*client_connected)   (GstRTSPServer *server, GstRTSPClient *client);
1196 };
1197 </pre>
1198 <p>The RTSP server class structure</p>
1199 <div class="refsect3">
1200 <a name="id-1.2.1.10.3.5"></a><h4>Members</h4>
1201 <div class="informaltable"><table width="100%" border="0">
1202 <colgroup>
1203 <col width="300px" class="struct_members_name">
1204 <col class="struct_members_description">
1205 <col width="200px" class="struct_members_annotations">
1206 </colgroup>
1207 <tbody>
1208 <tr>
1209 <td class="struct_member_name"><p><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GstRTSPServerClass.parent-class"></a>parent_class</code></em>;</p></td>
1210 <td> </td>
1211 <td> </td>
1212 </tr>
1213 <tr>
1214 <td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTSPServerClass.create-client"></a>create_client</code></em> ()</p></td>
1215 <td class="struct_member_description"><p>Create, configure a new GstRTSPClient
1216 object that handles the new connection on <em class="parameter"><code>socket</code></em>
1217 . The default
1218 implementation will create a GstRTSPClient and will configure the
1219 mount-points, auth, session-pool and thread-pool on the client.</p></td>
1220 <td class="struct_member_annotations"> </td>
1221 </tr>
1222 <tr>
1223 <td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTSPServerClass.client-connected"></a>client_connected</code></em> ()</p></td>
1224 <td class="struct_member_description"><p>emited when a new client connected.</p></td>
1225 <td class="struct_member_annotations"> </td>
1226 </tr>
1227 </tbody>
1228 </table></div>
1229 </div>
1230 </div>
1231 </div>
1232 <div class="refsect1">
1233 <a name="GstRTSPServer.property-details"></a><h2>Property Details</h2>
1234 <div class="refsect2">
1235 <a name="GstRTSPServer--address"></a><h3>The <code class="literal">“address”</code> property</h3>
1236 <pre class="programlisting">  “address”                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
1237 <p>The address the server uses to listen on.</p>
1238 <p>Flags: Read / Write</p>
1239 <p>Default value: "0.0.0.0"</p>
1240 </div>
1241 <hr>
1242 <div class="refsect2">
1243 <a name="GstRTSPServer--backlog"></a><h3>The <code class="literal">“backlog”</code> property</h3>
1244 <pre class="programlisting">  “backlog”                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
1245 <p>The maximum length to which the queue of pending connections may grow.</p>
1246 <p>Flags: Read / Write</p>
1247 <p>Allowed values: &gt;= 0</p>
1248 <p>Default value: 5</p>
1249 </div>
1250 <hr>
1251 <div class="refsect2">
1252 <a name="GstRTSPServer--bound-port"></a><h3>The <code class="literal">“bound-port”</code> property</h3>
1253 <pre class="programlisting">  “bound-port”               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
1254 <p>The port number the server is listening on.</p>
1255 <p>Flags: Read</p>
1256 <p>Allowed values: [-1,65535]</p>
1257 <p>Default value: -1</p>
1258 </div>
1259 <hr>
1260 <div class="refsect2">
1261 <a name="GstRTSPServer--mount-points"></a><h3>The <code class="literal">“mount-points”</code> property</h3>
1262 <pre class="programlisting">  “mount-points”             <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> *</pre>
1263 <p>The mount points to use for client session.</p>
1264 <p>Flags: Read / Write</p>
1265 </div>
1266 <hr>
1267 <div class="refsect2">
1268 <a name="GstRTSPServer--service"></a><h3>The <code class="literal">“service”</code> property</h3>
1269 <pre class="programlisting">  “service”                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
1270 <p>The service or port number the server uses to listen on.</p>
1271 <p>Flags: Read / Write</p>
1272 <p>Default value: "8554"</p>
1273 </div>
1274 <hr>
1275 <div class="refsect2">
1276 <a name="GstRTSPServer--session-pool"></a><h3>The <code class="literal">“session-pool”</code> property</h3>
1277 <pre class="programlisting">  “session-pool”             <a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="type">GstRTSPSessionPool</span></a> *</pre>
1278 <p>The session pool to use for client session.</p>
1279 <p>Flags: Read / Write</p>
1280 </div>
1281 </div>
1282 <div class="refsect1">
1283 <a name="GstRTSPServer.signal-details"></a><h2>Signal Details</h2>
1284 <div class="refsect2">
1285 <a name="GstRTSPServer-client-connected"></a><h3>The <code class="literal">“client-connected”</code> signal</h3>
1286 <pre class="programlisting"><span class="returnvalue">void</span>
1287 user_function (<a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *gstrtspserver,
1288                <a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a> *arg1,
1289                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)</pre>
1290 <p>Flags: Run Last</p>
1291 </div>
1292 </div>
1293 <div class="refsect1">
1294 <a name="GstRTSPServer.see-also"></a><h2>See Also</h2>
1295 <p><a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a>, <a class="link" href="gst-rtsp-server-GstRTSPThreadPool.html#GstRTSPThreadPool" title="struct GstRTSPThreadPool"><span class="type">GstRTSPThreadPool</span></a></p>
1296 </div>
1297 </div>
1298 <div class="footer">
1299 <hr>
1300           Generated by GTK-Doc V1.21</div>
1301 </body>
1302 </html>