docs/libs/html/GstRTSPMountPoints.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: GstRTSPMountPoints</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="gst-rtsp-server-GstRTSPContext.html" title="GstRTSPContext">
  10 <link rel="next" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory">
  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="#GstRTSPMountPoints.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#GstRTSPMountPoints.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="gst-rtsp-server-GstRTSPContext.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="GstRTSPMediaFactory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="GstRTSPMountPoints"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="GstRTSPMountPoints.top_of_page"></a>GstRTSPMountPoints</span></h2>
  31 <p>GstRTSPMountPoints — Map a path to media</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="GstRTSPMountPoints.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="returnvalue">GstRTSPMountPoints</span></a> *
  46 </td>
  47 <td class="function_name">
  48 <a class="link" href="GstRTSPMountPoints.html#gst-rtsp-mount-points-new" title="gst_rtsp_mount_points_new ()">gst_rtsp_mount_points_new</a> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <span class="returnvalue">void</span>
  54 </td>
  55 <td class="function_name">
  56 <a class="link" href="GstRTSPMountPoints.html#gst-rtsp-mount-points-add-factory" title="gst_rtsp_mount_points_add_factory ()">gst_rtsp_mount_points_add_factory</a> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <span class="returnvalue">void</span>
  62 </td>
  63 <td class="function_name">
  64 <a class="link" href="GstRTSPMountPoints.html#gst-rtsp-mount-points-remove-factory" title="gst_rtsp_mount_points_remove_factory ()">gst_rtsp_mount_points_remove_factory</a> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="returnvalue">GstRTSPMediaFactory</span></a> *
  70 </td>
  71 <td class="function_name">
  72 <a class="link" href="GstRTSPMountPoints.html#gst-rtsp-mount-points-match" title="gst_rtsp_mount_points_match ()">gst_rtsp_mount_points_match</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#gchar"><span class="returnvalue">gchar</span></a> *
  78 </td>
  79 <td class="function_name">
  80 <a class="link" href="GstRTSPMountPoints.html#gst-rtsp-mount-points-make-path" title="gst_rtsp_mount_points_make_path ()">gst_rtsp_mount_points_make_path</a> <span class="c_punctuation">()</span>
  81 </td>
  82 </tr>
  83 </tbody>
  84 </table></div>
  85 </div>
  86 <div class="refsect1">
  87 <a name="GstRTSPMountPoints.other"></a><h2>Types and Values</h2>
  88 <div class="informaltable"><table width="100%" border="0">
  89 <colgroup>
  90 <col width="150px" class="name">
  91 <col class="description">
  92 </colgroup>
  93 <tbody>
  94 <tr>
  95 <td class="datatype_keyword">struct</td>
  96 <td class="function_name"><a class="link" href="GstRTSPMountPoints.html#GstRTSPMountPoints-struct" title="struct GstRTSPMountPoints">GstRTSPMountPoints</a></td>
  97 </tr>
  98 <tr>
  99 <td class="datatype_keyword">struct</td>
 100 <td class="function_name"><a class="link" href="GstRTSPMountPoints.html#GstRTSPMountPointsClass" title="struct GstRTSPMountPointsClass">GstRTSPMountPointsClass</a></td>
 101 </tr>
 102 </tbody>
 103 </table></div>
 104 </div>
 105 <div class="refsect1">
 106 <a name="GstRTSPMountPoints.object-hierarchy"></a><h2>Object Hierarchy</h2>
 107 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 108     <span class="lineart">╰──</span> GstRTSPMountPoints
 109 </pre>
 110 </div>
 111 <div class="refsect1">
 112 <a name="GstRTSPMountPoints.description"></a><h2>Description</h2>
 113 <p>A <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> object maintains a relation between paths
 114 and <a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="type">GstRTSPMediaFactory</span></a> objects. This object is usually given to
 115 <a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a> and used to find the media attached to a path.</p>
 116 <p>With <a class="link" href="GstRTSPMountPoints.html#gst-rtsp-mount-points-add-factory" title="gst_rtsp_mount_points_add_factory ()"><code class="function">gst_rtsp_mount_points_add_factory()</code></a> and
 117 <a class="link" href="GstRTSPMountPoints.html#gst-rtsp-mount-points-remove-factory" title="gst_rtsp_mount_points_remove_factory ()"><code class="function">gst_rtsp_mount_points_remove_factory()</code></a>, factories can be added and
 118 removed.</p>
 119 <p>With <a class="link" href="GstRTSPMountPoints.html#gst-rtsp-mount-points-match" title="gst_rtsp_mount_points_match ()"><code class="function">gst_rtsp_mount_points_match()</code></a> you can find the <a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="type">GstRTSPMediaFactory</span></a>
 120 object that completely matches the given path.</p>
 121 <p>Last reviewed on 2013-07-11 (1.0.0)</p>
 122 </div>
 123 <div class="refsect1">
 124 <a name="GstRTSPMountPoints.functions_details"></a><h2>Functions</h2>
 125 <div class="refsect2">
 126 <a name="gst-rtsp-mount-points-new"></a><h3>gst_rtsp_mount_points_new ()</h3>
 127 <pre class="programlisting"><a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="returnvalue">GstRTSPMountPoints</span></a> *
 128 gst_rtsp_mount_points_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 129 <p>Make a new mount points object.</p>
 130 <div class="refsect3">
 131 <a name="id-1.2.4.7.2.5"></a><h4>Returns</h4>
 132 <p> a new <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a>. </p>
 133 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 134 </div>
 135 </div>
 136 <hr>
 137 <div class="refsect2">
 138 <a name="gst-rtsp-mount-points-add-factory"></a><h3>gst_rtsp_mount_points_add_factory ()</h3>
 139 <pre class="programlisting"><span class="returnvalue">void</span>
 140 gst_rtsp_mount_points_add_factory (<em class="parameter"><code><a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> *mounts</code></em>,
 141                                    <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>,
 142                                    <em class="parameter"><code><a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="type">GstRTSPMediaFactory</span></a> *factory</code></em>);</pre>
 143 <p>Attach <em class="parameter"><code>factory</code></em>
 144  to the mount point <em class="parameter"><code>path</code></em>
 145  in <em class="parameter"><code>mounts</code></em>
 146 .</p>
 147 <p><em class="parameter"><code>path</code></em>
 148  is of the form (/node)+. Any previous mount point will be freed.</p>
 149 <p>Ownership is taken of the reference on <em class="parameter"><code>factory</code></em>
 150  so that <em class="parameter"><code>factory</code></em>
 151  should not be
 152 used after calling this function.</p>
 153 <div class="refsect3">
 154 <a name="id-1.2.4.7.3.7"></a><h4>Parameters</h4>
 155 <div class="informaltable"><table width="100%" border="0">
 156 <colgroup>
 157 <col width="150px" class="parameters_name">
 158 <col class="parameters_description">
 159 <col width="200px" class="parameters_annotations">
 160 </colgroup>
 161 <tbody>
 162 <tr>
 163 <td class="parameter_name"><p>mounts</p></td>
 164 <td class="parameter_description"><p>a <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a></p></td>
 165 <td class="parameter_annotations"> </td>
 166 </tr>
 167 <tr>
 168 <td class="parameter_name"><p>path</p></td>
 169 <td class="parameter_description"><p>a mount point</p></td>
 170 <td class="parameter_annotations"> </td>
 171 </tr>
 172 <tr>
 173 <td class="parameter_name"><p>factory</p></td>
 174 <td class="parameter_description"><p> a <a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="type">GstRTSPMediaFactory</span></a>. </p></td>
 175 <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>
 176 </tr>
 177 </tbody>
 178 </table></div>
 179 </div>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="gst-rtsp-mount-points-remove-factory"></a><h3>gst_rtsp_mount_points_remove_factory ()</h3>
 184 <pre class="programlisting"><span class="returnvalue">void</span>
 185 gst_rtsp_mount_points_remove_factory (<em class="parameter"><code><a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> *mounts</code></em>,
 186                                       <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>);</pre>
 187 <p>Remove the <a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="type">GstRTSPMediaFactory</span></a> associated with <em class="parameter"><code>path</code></em>
 188  in <em class="parameter"><code>mounts</code></em>
 189 .</p>
 190 <div class="refsect3">
 191 <a name="id-1.2.4.7.4.5"></a><h4>Parameters</h4>
 192 <div class="informaltable"><table width="100%" border="0">
 193 <colgroup>
 194 <col width="150px" class="parameters_name">
 195 <col class="parameters_description">
 196 <col width="200px" class="parameters_annotations">
 197 </colgroup>
 198 <tbody>
 199 <tr>
 200 <td class="parameter_name"><p>mounts</p></td>
 201 <td class="parameter_description"><p>a <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a></p></td>
 202 <td class="parameter_annotations"> </td>
 203 </tr>
 204 <tr>
 205 <td class="parameter_name"><p>path</p></td>
 206 <td class="parameter_description"><p>a mount point</p></td>
 207 <td class="parameter_annotations"> </td>
 208 </tr>
 209 </tbody>
 210 </table></div>
 211 </div>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="gst-rtsp-mount-points-match"></a><h3>gst_rtsp_mount_points_match ()</h3>
 216 <pre class="programlisting"><a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="returnvalue">GstRTSPMediaFactory</span></a> *
 217 gst_rtsp_mount_points_match (<em class="parameter"><code><a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> *mounts</code></em>,
 218                              <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>,
 219                              <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>
 220 <p>Find the factory in <em class="parameter"><code>mounts</code></em>
 221  that has the longest match with <em class="parameter"><code>path</code></em>
 222 .</p>
 223 <p>If <em class="parameter"><code>matched</code></em>
 224  is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>path</code></em>
 225  will match the factory exactly otherwise
 226 the amount of characters that matched is returned in <em class="parameter"><code>matched</code></em>
 227 .</p>
 228 <div class="refsect3">
 229 <a name="id-1.2.4.7.5.6"></a><h4>Parameters</h4>
 230 <div class="informaltable"><table width="100%" border="0">
 231 <colgroup>
 232 <col width="150px" class="parameters_name">
 233 <col class="parameters_description">
 234 <col width="200px" class="parameters_annotations">
 235 </colgroup>
 236 <tbody>
 237 <tr>
 238 <td class="parameter_name"><p>mounts</p></td>
 239 <td class="parameter_description"><p>a <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a></p></td>
 240 <td class="parameter_annotations"> </td>
 241 </tr>
 242 <tr>
 243 <td class="parameter_name"><p>path</p></td>
 244 <td class="parameter_description"><p>a mount point</p></td>
 245 <td class="parameter_annotations"> </td>
 246 </tr>
 247 <tr>
 248 <td class="parameter_name"><p>matched</p></td>
 249 <td class="parameter_description"><p> the amount of <em class="parameter"><code>path</code></em>
 250 matched. </p></td>
 251 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
 252 </tr>
 253 </tbody>
 254 </table></div>
 255 </div>
 256 <div class="refsect3">
 257 <a name="id-1.2.4.7.5.7"></a><h4>Returns</h4>
 258 <p> the <a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="type">GstRTSPMediaFactory</span></a> for <em class="parameter"><code>path</code></em>
 259 .
 260 <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 usage. </p>
 261 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 262 </div>
 263 </div>
 264 <hr>
 265 <div class="refsect2">
 266 <a name="gst-rtsp-mount-points-make-path"></a><h3>gst_rtsp_mount_points_make_path ()</h3>
 267 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 268 gst_rtsp_mount_points_make_path (<em class="parameter"><code><a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a> *mounts</code></em>,
 269                                  <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspurl.html#GstRTSPUrl"><span class="type">GstRTSPUrl</span></a> *url</code></em>);</pre>
 270 <p>Make a path string from <em class="parameter"><code>url</code></em>
 271 .</p>
 272 <div class="refsect3">
 273 <a name="id-1.2.4.7.6.5"></a><h4>Parameters</h4>
 274 <div class="informaltable"><table width="100%" border="0">
 275 <colgroup>
 276 <col width="150px" class="parameters_name">
 277 <col class="parameters_description">
 278 <col width="200px" class="parameters_annotations">
 279 </colgroup>
 280 <tbody>
 281 <tr>
 282 <td class="parameter_name"><p>mounts</p></td>
 283 <td class="parameter_description"><p>a <a class="link" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints"><span class="type">GstRTSPMountPoints</span></a></p></td>
 284 <td class="parameter_annotations"> </td>
 285 </tr>
 286 <tr>
 287 <td class="parameter_name"><p>url</p></td>
 288 <td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspurl.html#GstRTSPUrl"><span class="type">GstRTSPUrl</span></a></p></td>
 289 <td class="parameter_annotations"> </td>
 290 </tr>
 291 </tbody>
 292 </table></div>
 293 </div>
 294 <div class="refsect3">
 295 <a name="id-1.2.4.7.6.6"></a><h4>Returns</h4>
 296 <p> a path string for <em class="parameter"><code>url</code></em>
 297 , <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>
 298 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 299 </div>
 300 </div>
 301 </div>
 302 <div class="refsect1">
 303 <a name="GstRTSPMountPoints.other_details"></a><h2>Types and Values</h2>
 304 <div class="refsect2">
 305 <a name="GstRTSPMountPoints-struct"></a><h3>struct GstRTSPMountPoints</h3>
 306 <pre class="programlisting">struct GstRTSPMountPoints;</pre>
 307 <p>Creates a <a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="type">GstRTSPMediaFactory</span></a> object for a given url.</p>
 308 </div>
 309 <hr>
 310 <div class="refsect2">
 311 <a name="GstRTSPMountPointsClass"></a><h3>struct GstRTSPMountPointsClass</h3>
 312 <pre class="programlisting">struct GstRTSPMountPointsClass {
 313   GObjectClass  parent_class;
 314
 315   gchar * (*make_path) (GstRTSPMountPoints *mounts,
 316                         const GstRTSPUrl *url);
 317 };
 318 </pre>
 319 <p>The class for the media mounts object.</p>
 320 <div class="refsect3">
 321 <a name="id-1.2.4.8.3.5"></a><h4>Members</h4>
 322 <div class="informaltable"><table width="100%" border="0">
 323 <colgroup>
 324 <col width="300px" class="struct_members_name">
 325 <col class="struct_members_description">
 326 <col width="200px" class="struct_members_annotations">
 327 </colgroup>
 328 <tbody>
 329 <tr>
 330 <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="GstRTSPMountPointsClass.parent-class"></a>parent_class</code></em>;</p></td>
 331 <td> </td>
 332 <td> </td>
 333 </tr>
 334 <tr>
 335 <td class="struct_member_name"><p><em class="structfield"><code><a name="GstRTSPMountPointsClass.make-path"></a>make_path</code></em> ()</p></td>
 336 <td class="struct_member_description"><p>make a path from the given url.</p></td>
 337 <td class="struct_member_annotations"> </td>
 338 </tr>
 339 </tbody>
 340 </table></div>
 341 </div>
 342 </div>
 343 </div>
 344 <div class="refsect1">
 345 <a name="GstRTSPMountPoints.see-also"></a><h2>See Also</h2>
 346 <p><a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="type">GstRTSPMediaFactory</span></a>, <a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a></p>
 347 </div>
 348 </div>
 349 <div class="footer">
 350 <hr>
 351           Generated by GTK-Doc V1.21</div>
 352 </body>
 353 </html>