docs/libs/html/GstRTSPSession.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: GstRTSPSession</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="GstRTSPSessionPool.html" title="GstRTSPSessionPool">
  10 <link rel="next" href="gst-rtsp-server-GstRTSPSessionMedia.html" title="GstRTSPSessionMedia">
  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="#GstRTSPSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#GstRTSPSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span>
  20                   <a href="#GstRTSPSession.properties" class="shortcut">Properties</a></span>
  21 </td>
  22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  23 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  24 <td><a accesskey="p" href="GstRTSPSessionPool.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  25 <td><a accesskey="n" href="gst-rtsp-server-GstRTSPSessionMedia.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  26 </tr></table>
  27 <div class="refentry">
  28 <a name="GstRTSPSession"></a><div class="titlepage"></div>
  29 <div class="refnamediv"><table width="100%"><tr>
  30 <td valign="top">
  31 <h2><span class="refentrytitle"><a name="GstRTSPSession.top_of_page"></a>GstRTSPSession</span></h2>
  32 <p>GstRTSPSession — An object to manage media</p>
  33 </td>
  34 <td class="gallery_image" valign="top" align="right"></td>
  35 </tr></table></div>
  36 <div class="refsect1">
  37 <a name="GstRTSPSession.functions"></a><h2>Functions</h2>
  38 <div class="informaltable"><table width="100%" border="0">
  39 <colgroup>
  40 <col width="150px" class="functions_return">
  41 <col class="functions_name">
  42 </colgroup>
  43 <tbody>
  44 <tr>
  45 <td class="function_type">
  46 <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="returnvalue">GstRTSPSession</span></a> *
  47 </td>
  48 <td class="function_name">
  49 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-new" title="gst_rtsp_session_new ()">gst_rtsp_session_new</a> <span class="c_punctuation">()</span>
  50 </td>
  51 </tr>
  52 <tr>
  53 <td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  54 </td>
  55 <td class="function_name">
  56 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-get-sessionid" title="gst_rtsp_session_get_sessionid ()">gst_rtsp_session_get_sessionid</a> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  62 </td>
  63 <td class="function_name">
  64 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-get-header" title="gst_rtsp_session_get_header ()">gst_rtsp_session_get_header</a> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <span class="returnvalue">void</span>
  70 </td>
  71 <td class="function_name">
  72 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-set-timeout" title="gst_rtsp_session_set_timeout ()">gst_rtsp_session_set_timeout</a> <span class="c_punctuation">()</span>
  73 </td>
  74 </tr>
  75 <tr>
  76 <td class="function_type">
  77 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
  78 </td>
  79 <td class="function_name">
  80 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-get-timeout" title="gst_rtsp_session_get_timeout ()">gst_rtsp_session_get_timeout</a> <span class="c_punctuation">()</span>
  81 </td>
  82 </tr>
  83 <tr>
  84 <td class="function_type">
  85 <span class="returnvalue">void</span>
  86 </td>
  87 <td class="function_name">
  88 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-touch" title="gst_rtsp_session_touch ()">gst_rtsp_session_touch</a> <span class="c_punctuation">()</span>
  89 </td>
  90 </tr>
  91 <tr>
  92 <td class="function_type">
  93 <span class="returnvalue">void</span>
  94 </td>
  95 <td class="function_name">
  96 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-prevent-expire" title="gst_rtsp_session_prevent_expire ()">gst_rtsp_session_prevent_expire</a> <span class="c_punctuation">()</span>
  97 </td>
  98 </tr>
  99 <tr>
 100 <td class="function_type">
 101 <span class="returnvalue">void</span>
 102 </td>
 103 <td class="function_name">
 104 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-allow-expire" title="gst_rtsp_session_allow_expire ()">gst_rtsp_session_allow_expire</a> <span class="c_punctuation">()</span>
 105 </td>
 106 </tr>
 107 <tr>
 108 <td class="function_type">
 109 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 110 </td>
 111 <td class="function_name">
 112 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-next-timeout" title="gst_rtsp_session_next_timeout ()">gst_rtsp_session_next_timeout</a> <span class="c_punctuation">()</span>
 113 </td>
 114 </tr>
 115 <tr>
 116 <td class="function_type">
 117 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 118 </td>
 119 <td class="function_name">
 120 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-is-expired" title="gst_rtsp_session_is_expired ()">gst_rtsp_session_is_expired</a> <span class="c_punctuation">()</span>
 121 </td>
 122 </tr>
 123 <tr>
 124 <td class="function_type">
 125 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="returnvalue">GstRTSPSessionMedia</span></a> *
 126 </td>
 127 <td class="function_name">
 128 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-manage-media" title="gst_rtsp_session_manage_media ()">gst_rtsp_session_manage_media</a> <span class="c_punctuation">()</span>
 129 </td>
 130 </tr>
 131 <tr>
 132 <td class="function_type">
 133 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 134 </td>
 135 <td class="function_name">
 136 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-release-media" title="gst_rtsp_session_release_media ()">gst_rtsp_session_release_media</a> <span class="c_punctuation">()</span>
 137 </td>
 138 </tr>
 139 <tr>
 140 <td class="function_type">
 141 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="returnvalue">GstRTSPSessionMedia</span></a> *
 142 </td>
 143 <td class="function_name">
 144 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-get-media" title="gst_rtsp_session_get_media ()">gst_rtsp_session_get_media</a> <span class="c_punctuation">()</span>
 145 </td>
 146 </tr>
 147 <tr>
 148 <td class="function_type">
 149 <a class="link" href="GstRTSPSession.html#GstRTSPFilterResult" title="enum GstRTSPFilterResult"><span class="returnvalue">GstRTSPFilterResult</span></a>
 150 </td>
 151 <td class="function_name">
 152 <span class="c_punctuation">(</span><a class="link" href="GstRTSPSession.html#GstRTSPSessionFilterFunc" title="GstRTSPSessionFilterFunc ()">*GstRTSPSessionFilterFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
 153 </td>
 154 </tr>
 155 <tr>
 156 <td class="function_type">
 157 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 158 </td>
 159 <td class="function_name">
 160 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-filter" title="gst_rtsp_session_filter ()">gst_rtsp_session_filter</a> <span class="c_punctuation">()</span>
 161 </td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 </div>
 166 <div class="refsect1">
 167 <a name="GstRTSPSession.properties"></a><h2>Properties</h2>
 168 <div class="informaltable"><table border="0">
 169 <colgroup>
 170 <col width="150px" class="properties_type">
 171 <col width="300px" class="properties_name">
 172 <col width="200px" class="properties_flags">
 173 </colgroup>
 174 <tbody>
 175 <tr>
 176 <td class="property_type">
 177 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 178 <td class="property_name"><a class="link" href="GstRTSPSession.html#GstRTSPSession--sessionid" title="The “sessionid” property">sessionid</a></td>
 179 <td class="property_flags">Read / Write / Construct Only</td>
 180 </tr>
 181 <tr>
 182 <td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
 183 <td class="property_name"><a class="link" href="GstRTSPSession.html#GstRTSPSession--timeout" title="The “timeout” property">timeout</a></td>
 184 <td class="property_flags">Read / Write</td>
 185 </tr>
 186 <tr>
 187 <td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 188 <td class="property_name"><a class="link" href="GstRTSPSession.html#GstRTSPSession--timeout-always-visible" title="The “timeout-always-visible” property">timeout-always-visible</a></td>
 189 <td class="property_flags">Read / Write</td>
 190 </tr>
 191 </tbody>
 192 </table></div>
 193 </div>
 194 <div class="refsect1">
 195 <a name="GstRTSPSession.other"></a><h2>Types and Values</h2>
 196 <div class="informaltable"><table width="100%" border="0">
 197 <colgroup>
 198 <col width="150px" class="name">
 199 <col class="description">
 200 </colgroup>
 201 <tbody>
 202 <tr>
 203 <td class="datatype_keyword">struct</td>
 204 <td class="function_name"><a class="link" href="GstRTSPSession.html#GstRTSPSession-struct" title="struct GstRTSPSession">GstRTSPSession</a></td>
 205 </tr>
 206 <tr>
 207 <td class="datatype_keyword">struct</td>
 208 <td class="function_name"><a class="link" href="GstRTSPSession.html#GstRTSPSessionClass" title="struct GstRTSPSessionClass">GstRTSPSessionClass</a></td>
 209 </tr>
 210 <tr>
 211 <td class="datatype_keyword">enum</td>
 212 <td class="function_name"><a class="link" href="GstRTSPSession.html#GstRTSPFilterResult" title="enum GstRTSPFilterResult">GstRTSPFilterResult</a></td>
 213 </tr>
 214 </tbody>
 215 </table></div>
 216 </div>
 217 <div class="refsect1">
 218 <a name="GstRTSPSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
 219 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 220     <span class="lineart">╰──</span> GstRTSPSession
 221 </pre>
 222 </div>
 223 <div class="refsect1">
 224 <a name="GstRTSPSession.description"></a><h2>Description</h2>
 225 <p>The <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> is identified by an id, unique in the
 226 <a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="type">GstRTSPSessionPool</span></a> that created the session and manages media and its
 227 configuration.</p>
 228 <p>A <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> has a timeout that can be retrieved with
 229 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-get-timeout" title="gst_rtsp_session_get_timeout ()"><code class="function">gst_rtsp_session_get_timeout()</code></a>. You can check if the sessions is expired with
 230 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-is-expired" title="gst_rtsp_session_is_expired ()"><code class="function">gst_rtsp_session_is_expired()</code></a>. <a class="link" href="GstRTSPSession.html#gst-rtsp-session-touch" title="gst_rtsp_session_touch ()"><code class="function">gst_rtsp_session_touch()</code></a> will reset the
 231 expiration counter of the session.</p>
 232 <p>When a client configures a media with SETUP, a session will be created to
 233 keep track of the configuration of that media. With
 234 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-manage-media" title="gst_rtsp_session_manage_media ()"><code class="function">gst_rtsp_session_manage_media()</code></a>, the media is added to the managed media
 235 in the session. With <a class="link" href="GstRTSPSession.html#gst-rtsp-session-release-media" title="gst_rtsp_session_release_media ()"><code class="function">gst_rtsp_session_release_media()</code></a> the media can be
 236 released again from the session. Managed media is identified in the sessions
 237 with a url. Use <a class="link" href="GstRTSPSession.html#gst-rtsp-session-get-media" title="gst_rtsp_session_get_media ()"><code class="function">gst_rtsp_session_get_media()</code></a> to get the media that matches
 238 (part of) the given url.</p>
 239 <p>The media in a session can be iterated with <a class="link" href="GstRTSPSession.html#gst-rtsp-session-filter" title="gst_rtsp_session_filter ()"><code class="function">gst_rtsp_session_filter()</code></a>.</p>
 240 <p>Last reviewed on 2013-07-11 (1.0.0)</p>
 241 </div>
 242 <div class="refsect1">
 243 <a name="GstRTSPSession.functions_details"></a><h2>Functions</h2>
 244 <div class="refsect2">
 245 <a name="gst-rtsp-session-new"></a><h3>gst_rtsp_session_new ()</h3>
 246 <pre class="programlisting"><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="returnvalue">GstRTSPSession</span></a> *
 247 gst_rtsp_session_new (<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> *sessionid</code></em>);</pre>
 248 <p>Create a new <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> instance with <em class="parameter"><code>sessionid</code></em>
 249 .</p>
 250 <div class="refsect3">
 251 <a name="id-1.2.10.8.2.5"></a><h4>Parameters</h4>
 252 <div class="informaltable"><table width="100%" border="0">
 253 <colgroup>
 254 <col width="150px" class="parameters_name">
 255 <col class="parameters_description">
 256 <col width="200px" class="parameters_annotations">
 257 </colgroup>
 258 <tbody><tr>
 259 <td class="parameter_name"><p>sessionid</p></td>
 260 <td class="parameter_description"><p>a session id</p></td>
 261 <td class="parameter_annotations"> </td>
 262 </tr></tbody>
 263 </table></div>
 264 </div>
 265 <div class="refsect3">
 266 <a name="id-1.2.10.8.2.6"></a><h4>Returns</h4>
 267 <p> a new <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a>. </p>
 268 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 269 </div>
 270 </div>
 271 <hr>
 272 <div class="refsect2">
 273 <a name="gst-rtsp-session-get-sessionid"></a><h3>gst_rtsp_session_get_sessionid ()</h3>
 274 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 275 gst_rtsp_session_get_sessionid (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *session</code></em>);</pre>
 276 <p>Get the sessionid of <em class="parameter"><code>session</code></em>
 277 .</p>
 278 <div class="refsect3">
 279 <a name="id-1.2.10.8.3.5"></a><h4>Parameters</h4>
 280 <div class="informaltable"><table width="100%" border="0">
 281 <colgroup>
 282 <col width="150px" class="parameters_name">
 283 <col class="parameters_description">
 284 <col width="200px" class="parameters_annotations">
 285 </colgroup>
 286 <tbody><tr>
 287 <td class="parameter_name"><p>session</p></td>
 288 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 289 <td class="parameter_annotations"> </td>
 290 </tr></tbody>
 291 </table></div>
 292 </div>
 293 <div class="refsect3">
 294 <a name="id-1.2.10.8.3.6"></a><h4>Returns</h4>
 295 <p> the sessionid of <em class="parameter"><code>session</code></em>
 296 . The value remains valid
 297 as long as <em class="parameter"><code>session</code></em>
 298 is alive. </p>
 299 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 300 </div>
 301 </div>
 302 <hr>
 303 <div class="refsect2">
 304 <a name="gst-rtsp-session-get-header"></a><h3>gst_rtsp_session_get_header ()</h3>
 305 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 306 gst_rtsp_session_get_header (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *session</code></em>);</pre>
 307 <p>Get the string that can be placed in the Session header field.</p>
 308 <div class="refsect3">
 309 <a name="id-1.2.10.8.4.5"></a><h4>Parameters</h4>
 310 <div class="informaltable"><table width="100%" border="0">
 311 <colgroup>
 312 <col width="150px" class="parameters_name">
 313 <col class="parameters_description">
 314 <col width="200px" class="parameters_annotations">
 315 </colgroup>
 316 <tbody><tr>
 317 <td class="parameter_name"><p>session</p></td>
 318 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 319 <td class="parameter_annotations"> </td>
 320 </tr></tbody>
 321 </table></div>
 322 </div>
 323 <div class="refsect3">
 324 <a name="id-1.2.10.8.4.6"></a><h4>Returns</h4>
 325 <p> the Session header of <em class="parameter"><code>session</code></em>
 326 . <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>
 327 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 328 </div>
 329 </div>
 330 <hr>
 331 <div class="refsect2">
 332 <a name="gst-rtsp-session-set-timeout"></a><h3>gst_rtsp_session_set_timeout ()</h3>
 333 <pre class="programlisting"><span class="returnvalue">void</span>
 334 gst_rtsp_session_set_timeout (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *session</code></em>,
 335                               <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timeout</code></em>);</pre>
 336 <p>Configure <em class="parameter"><code>session</code></em>
 337  for a timeout of <em class="parameter"><code>timeout</code></em>
 338  seconds. The session will be
 339 cleaned up when there is no activity for <em class="parameter"><code>timeout</code></em>
 340  seconds.</p>
 341 <div class="refsect3">
 342 <a name="id-1.2.10.8.5.5"></a><h4>Parameters</h4>
 343 <div class="informaltable"><table width="100%" border="0">
 344 <colgroup>
 345 <col width="150px" class="parameters_name">
 346 <col class="parameters_description">
 347 <col width="200px" class="parameters_annotations">
 348 </colgroup>
 349 <tbody>
 350 <tr>
 351 <td class="parameter_name"><p>session</p></td>
 352 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 353 <td class="parameter_annotations"> </td>
 354 </tr>
 355 <tr>
 356 <td class="parameter_name"><p>timeout</p></td>
 357 <td class="parameter_description"><p>the new timeout</p></td>
 358 <td class="parameter_annotations"> </td>
 359 </tr>
 360 </tbody>
 361 </table></div>
 362 </div>
 363 </div>
 364 <hr>
 365 <div class="refsect2">
 366 <a name="gst-rtsp-session-get-timeout"></a><h3>gst_rtsp_session_get_timeout ()</h3>
 367 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
 368 gst_rtsp_session_get_timeout (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *session</code></em>);</pre>
 369 <p>Get the timeout value of <em class="parameter"><code>session</code></em>
 370 .</p>
 371 <div class="refsect3">
 372 <a name="id-1.2.10.8.6.5"></a><h4>Parameters</h4>
 373 <div class="informaltable"><table width="100%" border="0">
 374 <colgroup>
 375 <col width="150px" class="parameters_name">
 376 <col class="parameters_description">
 377 <col width="200px" class="parameters_annotations">
 378 </colgroup>
 379 <tbody><tr>
 380 <td class="parameter_name"><p>session</p></td>
 381 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 382 <td class="parameter_annotations"> </td>
 383 </tr></tbody>
 384 </table></div>
 385 </div>
 386 <div class="refsect3">
 387 <a name="id-1.2.10.8.6.6"></a><h4>Returns</h4>
 388 <p> the timeout of <em class="parameter"><code>session</code></em>
 389 in seconds.</p>
 390 <p></p>
 391 </div>
 392 </div>
 393 <hr>
 394 <div class="refsect2">
 395 <a name="gst-rtsp-session-touch"></a><h3>gst_rtsp_session_touch ()</h3>
 396 <pre class="programlisting"><span class="returnvalue">void</span>
 397 gst_rtsp_session_touch (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *session</code></em>);</pre>
 398 <p>Update the last_access time of the session to the current time.</p>
 399 <div class="refsect3">
 400 <a name="id-1.2.10.8.7.5"></a><h4>Parameters</h4>
 401 <div class="informaltable"><table width="100%" border="0">
 402 <colgroup>
 403 <col width="150px" class="parameters_name">
 404 <col class="parameters_description">
 405 <col width="200px" class="parameters_annotations">
 406 </colgroup>
 407 <tbody><tr>
 408 <td class="parameter_name"><p>session</p></td>
 409 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 410 <td class="parameter_annotations"> </td>
 411 </tr></tbody>
 412 </table></div>
 413 </div>
 414 </div>
 415 <hr>
 416 <div class="refsect2">
 417 <a name="gst-rtsp-session-prevent-expire"></a><h3>gst_rtsp_session_prevent_expire ()</h3>
 418 <pre class="programlisting"><span class="returnvalue">void</span>
 419 gst_rtsp_session_prevent_expire (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *session</code></em>);</pre>
 420 <p>Prevent <em class="parameter"><code>session</code></em>
 421  from expiring.</p>
 422 <div class="refsect3">
 423 <a name="id-1.2.10.8.8.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>session</p></td>
 432 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 433 <td class="parameter_annotations"> </td>
 434 </tr></tbody>
 435 </table></div>
 436 </div>
 437 </div>
 438 <hr>
 439 <div class="refsect2">
 440 <a name="gst-rtsp-session-allow-expire"></a><h3>gst_rtsp_session_allow_expire ()</h3>
 441 <pre class="programlisting"><span class="returnvalue">void</span>
 442 gst_rtsp_session_allow_expire (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *session</code></em>);</pre>
 443 <p>Allow <em class="parameter"><code>session</code></em>
 444  to expire. This method must be called an equal
 445 amount of time as <a class="link" href="GstRTSPSession.html#gst-rtsp-session-prevent-expire" title="gst_rtsp_session_prevent_expire ()"><code class="function">gst_rtsp_session_prevent_expire()</code></a>.</p>
 446 <div class="refsect3">
 447 <a name="id-1.2.10.8.9.5"></a><h4>Parameters</h4>
 448 <div class="informaltable"><table width="100%" border="0">
 449 <colgroup>
 450 <col width="150px" class="parameters_name">
 451 <col class="parameters_description">
 452 <col width="200px" class="parameters_annotations">
 453 </colgroup>
 454 <tbody><tr>
 455 <td class="parameter_name"><p>session</p></td>
 456 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 457 <td class="parameter_annotations"> </td>
 458 </tr></tbody>
 459 </table></div>
 460 </div>
 461 </div>
 462 <hr>
 463 <div class="refsect2">
 464 <a name="gst-rtsp-session-next-timeout"></a><h3>gst_rtsp_session_next_timeout ()</h3>
 465 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 466 gst_rtsp_session_next_timeout (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *session</code></em>,
 467                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"><span class="type">GTimeVal</span></a> *now</code></em>);</pre>
 468 <p>Get the amount of milliseconds till the session will expire.</p>
 469 <div class="refsect3">
 470 <a name="id-1.2.10.8.10.5"></a><h4>Parameters</h4>
 471 <div class="informaltable"><table width="100%" border="0">
 472 <colgroup>
 473 <col width="150px" class="parameters_name">
 474 <col class="parameters_description">
 475 <col width="200px" class="parameters_annotations">
 476 </colgroup>
 477 <tbody>
 478 <tr>
 479 <td class="parameter_name"><p>session</p></td>
 480 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 481 <td class="parameter_annotations"> </td>
 482 </tr>
 483 <tr>
 484 <td class="parameter_name"><p>now</p></td>
 485 <td class="parameter_description"><p> the current system time. </p></td>
 486 <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>
 487 </tr>
 488 </tbody>
 489 </table></div>
 490 </div>
 491 <div class="refsect3">
 492 <a name="id-1.2.10.8.10.6"></a><h4>Returns</h4>
 493 <p> the amount of milliseconds since the session will time out.</p>
 494 <p></p>
 495 </div>
 496 </div>
 497 <hr>
 498 <div class="refsect2">
 499 <a name="gst-rtsp-session-is-expired"></a><h3>gst_rtsp_session_is_expired ()</h3>
 500 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 501 gst_rtsp_session_is_expired (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *session</code></em>,
 502                              <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"><span class="type">GTimeVal</span></a> *now</code></em>);</pre>
 503 <p>Check if <em class="parameter"><code>session</code></em>
 504  timeout out.</p>
 505 <div class="refsect3">
 506 <a name="id-1.2.10.8.11.5"></a><h4>Parameters</h4>
 507 <div class="informaltable"><table width="100%" border="0">
 508 <colgroup>
 509 <col width="150px" class="parameters_name">
 510 <col class="parameters_description">
 511 <col width="200px" class="parameters_annotations">
 512 </colgroup>
 513 <tbody>
 514 <tr>
 515 <td class="parameter_name"><p>session</p></td>
 516 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 517 <td class="parameter_annotations"> </td>
 518 </tr>
 519 <tr>
 520 <td class="parameter_name"><p>now</p></td>
 521 <td class="parameter_description"><p> the current system time. </p></td>
 522 <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>
 523 </tr>
 524 </tbody>
 525 </table></div>
 526 </div>
 527 <div class="refsect3">
 528 <a name="id-1.2.10.8.11.6"></a><h4>Returns</h4>
 529 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>session</code></em>
 530 timed out</p>
 531 <p></p>
 532 </div>
 533 </div>
 534 <hr>
 535 <div class="refsect2">
 536 <a name="gst-rtsp-session-manage-media"></a><h3>gst_rtsp_session_manage_media ()</h3>
 537 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="returnvalue">GstRTSPSessionMedia</span></a> *
 538 gst_rtsp_session_manage_media (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *sess</code></em>,
 539                                <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> *path</code></em>,
 540                                <em class="parameter"><code><a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a> *media</code></em>);</pre>
 541 <p>Manage the media object <em class="parameter"><code>obj</code></em>
 542  in <em class="parameter"><code>sess</code></em>
 543 . <em class="parameter"><code>path</code></em>
 544  will be used to retrieve this
 545 media from the session with <a class="link" href="GstRTSPSession.html#gst-rtsp-session-get-media" title="gst_rtsp_session_get_media ()"><code class="function">gst_rtsp_session_get_media()</code></a>.</p>
 546 <p>Ownership is taken from <em class="parameter"><code>media</code></em>
 547 .</p>
 548 <div class="refsect3">
 549 <a name="id-1.2.10.8.12.6"></a><h4>Parameters</h4>
 550 <div class="informaltable"><table width="100%" border="0">
 551 <colgroup>
 552 <col width="150px" class="parameters_name">
 553 <col class="parameters_description">
 554 <col width="200px" class="parameters_annotations">
 555 </colgroup>
 556 <tbody>
 557 <tr>
 558 <td class="parameter_name"><p>sess</p></td>
 559 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 560 <td class="parameter_annotations"> </td>
 561 </tr>
 562 <tr>
 563 <td class="parameter_name"><p>path</p></td>
 564 <td class="parameter_description"><p>the path for the media</p></td>
 565 <td class="parameter_annotations"> </td>
 566 </tr>
 567 <tr>
 568 <td class="parameter_name"><p>media</p></td>
 569 <td class="parameter_description"><p> a <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a>. </p></td>
 570 <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>
 571 </tr>
 572 </tbody>
 573 </table></div>
 574 </div>
 575 <div class="refsect3">
 576 <a name="id-1.2.10.8.12.7"></a><h4>Returns</h4>
 577 <p> a new <em class="parameter"><code>GstRTSPSessionMedia</code></em>
 578 object. </p>
 579 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 580 </div>
 581 </div>
 582 <hr>
 583 <div class="refsect2">
 584 <a name="gst-rtsp-session-release-media"></a><h3>gst_rtsp_session_release_media ()</h3>
 585 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 586 gst_rtsp_session_release_media (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *sess</code></em>,
 587                                 <em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>);</pre>
 588 <p>Release the managed <em class="parameter"><code>media</code></em>
 589  in <em class="parameter"><code>sess</code></em>
 590 , freeing the memory allocated by it.</p>
 591 <div class="refsect3">
 592 <a name="id-1.2.10.8.13.5"></a><h4>Parameters</h4>
 593 <div class="informaltable"><table width="100%" border="0">
 594 <colgroup>
 595 <col width="150px" class="parameters_name">
 596 <col class="parameters_description">
 597 <col width="200px" class="parameters_annotations">
 598 </colgroup>
 599 <tbody>
 600 <tr>
 601 <td class="parameter_name"><p>sess</p></td>
 602 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 603 <td class="parameter_annotations"> </td>
 604 </tr>
 605 <tr>
 606 <td class="parameter_name"><p>media</p></td>
 607 <td class="parameter_description"><p> a <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a>. </p></td>
 608 <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>
 609 </tr>
 610 </tbody>
 611 </table></div>
 612 </div>
 613 <div class="refsect3">
 614 <a name="id-1.2.10.8.13.6"></a><h4>Returns</h4>
 615 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there are more media session left in <em class="parameter"><code>sess</code></em>
 616 .</p>
 617 <p></p>
 618 </div>
 619 </div>
 620 <hr>
 621 <div class="refsect2">
 622 <a name="gst-rtsp-session-get-media"></a><h3>gst_rtsp_session_get_media ()</h3>
 623 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="returnvalue">GstRTSPSessionMedia</span></a> *
 624 gst_rtsp_session_get_media (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *sess</code></em>,
 625                             <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> *path</code></em>,
 626                             <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *matched</code></em>);</pre>
 627 <p>Get the session media for <em class="parameter"><code>path</code></em>
 628 . <em class="parameter"><code>matched</code></em>
 629  will contain the number of matched
 630 characters of <em class="parameter"><code>path</code></em>
 631 .</p>
 632 <div class="refsect3">
 633 <a name="id-1.2.10.8.14.5"></a><h4>Parameters</h4>
 634 <div class="informaltable"><table width="100%" border="0">
 635 <colgroup>
 636 <col width="150px" class="parameters_name">
 637 <col class="parameters_description">
 638 <col width="200px" class="parameters_annotations">
 639 </colgroup>
 640 <tbody>
 641 <tr>
 642 <td class="parameter_name"><p>sess</p></td>
 643 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 644 <td class="parameter_annotations"> </td>
 645 </tr>
 646 <tr>
 647 <td class="parameter_name"><p>path</p></td>
 648 <td class="parameter_description"><p>the path for the media</p></td>
 649 <td class="parameter_annotations"> </td>
 650 </tr>
 651 <tr>
 652 <td class="parameter_name"><p>matched</p></td>
 653 <td class="parameter_description"><p> the amount of matched characters. </p></td>
 654 <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>
 655 </tr>
 656 </tbody>
 657 </table></div>
 658 </div>
 659 <div class="refsect3">
 660 <a name="id-1.2.10.8.14.6"></a><h4>Returns</h4>
 661 <p> the configuration for <em class="parameter"><code>path</code></em>
 662 in <em class="parameter"><code>sess</code></em>
 663 . </p>
 664 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 665 </div>
 666 </div>
 667 <hr>
 668 <div class="refsect2">
 669 <a name="GstRTSPSessionFilterFunc"></a><h3>GstRTSPSessionFilterFunc ()</h3>
 670 <pre class="programlisting"><a class="link" href="GstRTSPSession.html#GstRTSPFilterResult" title="enum GstRTSPFilterResult"><span class="returnvalue">GstRTSPFilterResult</span></a>
 671 <span class="c_punctuation">(</span>*GstRTSPSessionFilterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *sess</code></em>,
 672                              <em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>,
 673                              <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>
 674 <p>This function will be called by the <a class="link" href="GstRTSPSession.html#gst-rtsp-session-filter" title="gst_rtsp_session_filter ()"><code class="function">gst_rtsp_session_filter()</code></a>. An
 675 implementation should return a value of <a class="link" href="GstRTSPSession.html#GstRTSPFilterResult" title="enum GstRTSPFilterResult"><span class="type">GstRTSPFilterResult</span></a>.</p>
 676 <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>media</code></em>
 677  will be removed
 678 from <em class="parameter"><code>sess</code></em>
 679 .</p>
 680 <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>media</code></em>
 681  untouched in
 682 <em class="parameter"><code>sess</code></em>
 683 .</p>
 684 <p>A value of GST_RTSP_FILTER_REF will add <em class="parameter"><code>media</code></em>
 685  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
 686 <a class="link" href="GstRTSPSession.html#gst-rtsp-session-filter" title="gst_rtsp_session_filter ()"><code class="function">gst_rtsp_session_filter()</code></a>.</p>
 687 <div class="refsect3">
 688 <a name="id-1.2.10.8.15.8"></a><h4>Parameters</h4>
 689 <div class="informaltable"><table width="100%" border="0">
 690 <colgroup>
 691 <col width="150px" class="parameters_name">
 692 <col class="parameters_description">
 693 <col width="200px" class="parameters_annotations">
 694 </colgroup>
 695 <tbody>
 696 <tr>
 697 <td class="parameter_name"><p>sess</p></td>
 698 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> object</p></td>
 699 <td class="parameter_annotations"> </td>
 700 </tr>
 701 <tr>
 702 <td class="parameter_name"><p>media</p></td>
 703 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> in <em class="parameter"><code>sess</code></em>
 704 </p></td>
 705 <td class="parameter_annotations"> </td>
 706 </tr>
 707 <tr>
 708 <td class="parameter_name"><p>user_data</p></td>
 709 <td class="parameter_description"><p>user data that has been given to <a class="link" href="GstRTSPSession.html#gst-rtsp-session-filter" title="gst_rtsp_session_filter ()"><code class="function">gst_rtsp_session_filter()</code></a></p></td>
 710 <td class="parameter_annotations"> </td>
 711 </tr>
 712 </tbody>
 713 </table></div>
 714 </div>
 715 <div class="refsect3">
 716 <a name="id-1.2.10.8.15.9"></a><h4>Returns</h4>
 717 <p> a <a class="link" href="GstRTSPSession.html#GstRTSPFilterResult" title="enum GstRTSPFilterResult"><span class="type">GstRTSPFilterResult</span></a>.</p>
 718 <p></p>
 719 </div>
 720 </div>
 721 <hr>
 722 <div class="refsect2">
 723 <a name="gst-rtsp-session-filter"></a><h3>gst_rtsp_session_filter ()</h3>
 724 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 725 gst_rtsp_session_filter (<em class="parameter"><code><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *sess</code></em>,
 726                          <em class="parameter"><code><a class="link" href="GstRTSPSession.html#GstRTSPSessionFilterFunc" title="GstRTSPSessionFilterFunc ()"><span class="type">GstRTSPSessionFilterFunc</span></a> func</code></em>,
 727                          <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>
 728 <p>Call <em class="parameter"><code>func</code></em>
 729  for each media in <em class="parameter"><code>sess</code></em>
 730 . The result value of <em class="parameter"><code>func</code></em>
 731  determines
 732 what happens to the media. <em class="parameter"><code>func</code></em>
 733  will be called with <em class="parameter"><code>sess</code></em>
 734
 735 locked so no further actions on <em class="parameter"><code>sess</code></em>
 736  can be performed from <em class="parameter"><code>func</code></em>
 737 .</p>
 738 <p>If <em class="parameter"><code>func</code></em>
 739  returns <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-REMOVE:CAPS"><span class="type">GST_RTSP_FILTER_REMOVE</span></a>, the media will be removed from
 740 <em class="parameter"><code>sess</code></em>
 741 .</p>
 742 <p>If <em class="parameter"><code>func</code></em>
 743  returns <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-KEEP:CAPS"><span class="type">GST_RTSP_FILTER_KEEP</span></a>, the media will remain in <em class="parameter"><code>sess</code></em>
 744 .</p>
 745 <p>If <em class="parameter"><code>func</code></em>
 746  returns <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-REF:CAPS"><span class="type">GST_RTSP_FILTER_REF</span></a>, the media will remain in <em class="parameter"><code>sess</code></em>
 747  but
 748 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
 749 function..</p>
 750 <p>When <em class="parameter"><code>func</code></em>
 751  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 all media.</p>
 752 <div class="refsect3">
 753 <a name="id-1.2.10.8.16.9"></a><h4>Parameters</h4>
 754 <div class="informaltable"><table width="100%" border="0">
 755 <colgroup>
 756 <col width="150px" class="parameters_name">
 757 <col class="parameters_description">
 758 <col width="200px" class="parameters_annotations">
 759 </colgroup>
 760 <tbody>
 761 <tr>
 762 <td class="parameter_name"><p>sess</p></td>
 763 <td class="parameter_description"><p>a <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p></td>
 764 <td class="parameter_annotations"> </td>
 765 </tr>
 766 <tr>
 767 <td class="parameter_name"><p>func</p></td>
 768 <td class="parameter_description"><p> a callback. </p></td>
 769 <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>
 770 </tr>
 771 <tr>
 772 <td class="parameter_name"><p>user_data</p></td>
 773 <td class="parameter_description"><p> user data passed to <em class="parameter"><code>func</code></em>
 774 . </p></td>
 775 <td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
 776 </tr>
 777 </tbody>
 778 </table></div>
 779 </div>
 780 <div class="refsect3">
 781 <a name="id-1.2.10.8.16.10"></a><h4>Returns</h4>
 782 <p> a GList with all
 783 media for which <em class="parameter"><code>func</code></em>
 784 returned <a class="link" href="GstRTSPSession.html#GST-RTSP-FILTER-REF:CAPS"><span class="type">GST_RTSP_FILTER_REF</span></a>. After usage, each
 785 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>
 786 <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GstRTSPSessionMedia][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 787 </div>
 788 </div>
 789 </div>
 790 <div class="refsect1">
 791 <a name="GstRTSPSession.other_details"></a><h2>Types and Values</h2>
 792 <div class="refsect2">
 793 <a name="GstRTSPSession-struct"></a><h3>struct GstRTSPSession</h3>
 794 <pre class="programlisting">struct GstRTSPSession;</pre>
 795 <p>Session information kept by the server for a specific client.
 796 One client session, identified with a session id, can handle multiple medias
 797 identified with the url of a media.</p>
 798 </div>
 799 <hr>
 800 <div class="refsect2">
 801 <a name="GstRTSPSessionClass"></a><h3>struct GstRTSPSessionClass</h3>
 802 <pre class="programlisting">struct GstRTSPSessionClass {
 803   GObjectClass  parent_class;
 804 };
 805 </pre>
 806 </div>
 807 <hr>
 808 <div class="refsect2">
 809 <a name="GstRTSPFilterResult"></a><h3>enum GstRTSPFilterResult</h3>
 810 <p>Possible return values for <a class="link" href="GstRTSPSessionPool.html#gst-rtsp-session-pool-filter" title="gst_rtsp_session_pool_filter ()"><code class="function">gst_rtsp_session_pool_filter()</code></a>.</p>
 811 <div class="refsect3">
 812 <a name="id-1.2.10.9.4.4"></a><h4>Members</h4>
 813 <div class="informaltable"><table width="100%" border="0">
 814 <colgroup>
 815 <col width="300px" class="enum_members_name">
 816 <col class="enum_members_description">
 817 <col width="200px" class="enum_members_annotations">
 818 </colgroup>
 819 <tbody>
 820 <tr>
 821 <td class="enum_member_name"><p><a name="GST-RTSP-FILTER-REMOVE:CAPS"></a>GST_RTSP_FILTER_REMOVE</p></td>
 822 <td class="enum_member_description">
 823 <p>Remove session</p>
 824 </td>
 825 <td class="enum_member_annotations"> </td>
 826 </tr>
 827 <tr>
 828 <td class="enum_member_name"><p><a name="GST-RTSP-FILTER-KEEP:CAPS"></a>GST_RTSP_FILTER_KEEP</p></td>
 829 <td class="enum_member_description">
 830 <p>Keep session in the pool</p>
 831 </td>
 832 <td class="enum_member_annotations"> </td>
 833 </tr>
 834 <tr>
 835 <td class="enum_member_name"><p><a name="GST-RTSP-FILTER-REF:CAPS"></a>GST_RTSP_FILTER_REF</p></td>
 836 <td class="enum_member_description">
 837 <p>Ref session in the result list</p>
 838 </td>
 839 <td class="enum_member_annotations"> </td>
 840 </tr>
 841 </tbody>
 842 </table></div>
 843 </div>
 844 </div>
 845 </div>
 846 <div class="refsect1">
 847 <a name="GstRTSPSession.property-details"></a><h2>Property Details</h2>
 848 <div class="refsect2">
 849 <a name="GstRTSPSession--sessionid"></a><h3>The <code class="literal">“sessionid”</code> property</h3>
 850 <pre class="programlisting">  “sessionid”                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
 851 <p>the session id.</p>
 852 <p>Flags: Read / Write / Construct Only</p>
 853 <p>Default value: NULL</p>
 854 </div>
 855 <hr>
 856 <div class="refsect2">
 857 <a name="GstRTSPSession--timeout"></a><h3>The <code class="literal">“timeout”</code> property</h3>
 858 <pre class="programlisting">  “timeout”                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
 859 <p>the timeout of the session (0 = never).</p>
 860 <p>Flags: Read / Write</p>
 861 <p>Default value: 60</p>
 862 </div>
 863 <hr>
 864 <div class="refsect2">
 865 <a name="GstRTSPSession--timeout-always-visible"></a><h3>The <code class="literal">“timeout-always-visible”</code> property</h3>
 866 <pre class="programlisting">  “timeout-always-visible”   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
 867 <p>timeout always visible in header.</p>
 868 <p>Flags: Read / Write</p>
 869 <p>Default value: FALSE</p>
 870 </div>
 871 </div>
 872 <div class="refsect1">
 873 <a name="GstRTSPSession.see-also"></a><h2>See Also</h2>
 874 <p><a class="link" href="GstRTSPSessionPool.html" title="GstRTSPSessionPool"><span class="type">GstRTSPSessionPool</span></a>, <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a>, <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a></p>
 875 </div>
 876 </div>
 877 <div class="footer">
 878 <hr>
 879           Generated by GTK-Doc V1.21</div>
 880 </body>
 881 </html>