docs/plugins/html/gst-plugins-base-plugins-gnomevfssrc.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>gnomevfssrc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-gnomevfssink.html" title="gnomevfssink">
  10 <link rel="next" href="gst-plugins-base-plugins-multifdsink.html" title="multifdsink">
  11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-base-plugins-gnomevfssink.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-multifdsink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-plugins-gnomevfssrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-gnomevfssrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-gnomevfssrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-gnomevfssrc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-gnomevfssrc.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-base-plugins-gnomevfssrc"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-gnomevfssrc.top_of_page"></a>gnomevfssrc</span></h2>
  40 <p>gnomevfssrc — Read from any GnomeVFS-supported file</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-base-plugins-gnomevfssrc.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstGnomeVFSSrc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc-struct" title="struct GstGnomeVFSSrc">GstGnomeVFSSrc</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-base-plugins-gnomevfssrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
  56                      +----GstGnomeVFSSrc
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-base-plugins-gnomevfssrc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  61 <p>
  62 GstGnomeVFSSrc implements
  63  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a>.</p>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gst-plugins-base-plugins-gnomevfssrc.properties"></a><h2>Properties</h2>
  67 <pre class="synopsis">
  68   "<a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--handle" title='The "handle" property'>handle</a>"                   <span class="type">GnomeVFSHandle</span>*       : Read / Write
  69   "<a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-genre" title='The "iradio-genre" property'>iradio-genre</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  70   "<a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-mode" title='The "iradio-mode" property'>iradio-mode</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  71   "<a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-name" title='The "iradio-name" property'>iradio-name</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  72   "<a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-title" title='The "iradio-title" property'>iradio-title</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  73   "<a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-url" title='The "iradio-url" property'>iradio-url</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  74   "<a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--location" title='The "location" property'>location</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  75   "<a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--random-access" title='The "random-access" property'>random-access</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  76 </pre>
  77 </div>
  78 <div class="refsect1">
  79 <a name="gst-plugins-base-plugins-gnomevfssrc.description"></a><h2>Description</h2>
  80 <p>
  81 This plugin reads data from a local or remote location specified
  82 by an URI. This location can be specified using any protocol supported by
  83 the GnomeVFS library. Common protocols are 'file', 'http', 'ftp', or 'smb'.
  84 </p>
  85 <p>
  86 In case the <a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-mode" title='The "iradio-mode" property'><span class="type">"iradio-mode"</span></a> property is set and the
  87 location is a http resource, gnomevfssrc will send special icecast http
  88 headers to the server to request additional icecast metainformation. If
  89 the server is not an icecast server, it will display the same behaviour
  90 as if the <a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-mode" title='The "iradio-mode" property'><span class="type">"iradio-mode"</span></a> property was not set. However,
  91 if the server is in fact an icecast server, gnomevfssrc will output
  92 data with a media type of application/x-icy, in which case you will
  93 need to use the <span class="type">GstICYDemux</span> element as follow-up element to extract
  94 the icecast meta data and to determine the underlying media type.
  95 </p>
  96 <p>
  97 </p>
  98 <div class="refsect2">
  99 <a name="idp11778080"></a><h3>Example launch lines</h3>
 100 <div class="informalexample">
 101   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 102     <tbody>
 103       <tr>
 104         <td class="listing_lines" align="right"><pre>1</pre></td>
 105         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v gnomevfssrc location<span class="gtkdoc opt">=</span>file<span class="gtkdoc opt">:</span><span class="gtkdoc slc">///home/joe/foo.xyz ! fakesink</span></pre></td>
 106       </tr>
 107     </tbody>
 108   </table>
 109 </div>
 110  The above pipeline will simply read a local file and do nothing with the
 111 data read. Instead of gnomevfssrc, we could just as well have used the
 112 filesrc element here.
 113 <div class="informalexample">
 114   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 115     <tbody>
 116       <tr>
 117         <td class="listing_lines" align="right"><pre>1</pre></td>
 118         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v gnomevfssrc location<span class="gtkdoc opt">=</span>smb<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//othercomputer/foo.xyz ! filesink location=/home/joe/foo.xyz</span></pre></td>
 119       </tr>
 120     </tbody>
 121   </table>
 122 </div>
 123  The above pipeline will copy a file from a remote host to the local file
 124 system using the Samba protocol.
 125 <div class="informalexample">
 126   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 127     <tbody>
 128       <tr>
 129         <td class="listing_lines" align="right"><pre>1</pre></td>
 130         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v gnomevfssrc location<span class="gtkdoc opt">=</span>http<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//music.foobar.com/demo.mp3 ! mad ! audioconvert ! audioresample ! alsasink</span></pre></td>
 131       </tr>
 132     </tbody>
 133   </table>
 134 </div>
 135  The above pipeline will read and decode and play an mp3 file from a
 136 web server using the http protocol.
 137 </div>
 138 <p>
 139 </p>
 140 <div class="refsynopsisdiv">
 141 <h2>Synopsis</h2>
 142 <div class="refsect2">
 143 <a name="idp11782928"></a><h3>Element Information</h3>
 144 <div class="variablelist"><table border="0">
 145 <col align="left" valign="top">
 146 <tbody>
 147 <tr>
 148 <td><p><span class="term">plugin</span></p></td>
 149 <td>
 150             <a class="link" href="gst-plugins-base-plugins-plugin-gnomevfs.html#plugin-gnomevfs">gnomevfs</a>
 151           </td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term">author</span></p></td>
 155 <td>Bastien Nocera &lt;hadess@hadess.net&gt;, GStreamer maintainers &lt;gstreamer-devel@lists.sourceforge.net&gt;</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term">class</span></p></td>
 159 <td>Source/File</td>
 160 </tr>
 161 </tbody>
 162 </table></div>
 163 </div>
 164 <hr>
 165 <div class="refsect2">
 166 <a name="idp11790448"></a><h3>Element Pads</h3>
 167 <div class="variablelist"><table border="0">
 168 <col align="left" valign="top">
 169 <tbody>
 170 <tr>
 171 <td><p><span class="term">name</span></p></td>
 172 <td>src</td>
 173 </tr>
 174 <tr>
 175 <td><p><span class="term">direction</span></p></td>
 176 <td>source</td>
 177 </tr>
 178 <tr>
 179 <td><p><span class="term">presence</span></p></td>
 180 <td>always</td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term">details</span></p></td>
 184 <td>ANY</td>
 185 </tr>
 186 </tbody>
 187 </table></div>
 188 </div>
 189 </div>
 190 <p>
 191 </p>
 192 </div>
 193 <div class="refsect1">
 194 <a name="gst-plugins-base-plugins-gnomevfssrc.details"></a><h2>Details</h2>
 195 <div class="refsect2">
 196 <a name="GstGnomeVFSSrc-struct"></a><h3>struct GstGnomeVFSSrc</h3>
 197 <pre class="programlisting">struct GstGnomeVFSSrc;</pre>
 198 <p>
 199 Opaque data structure.
 200 </p>
 201 </div>
 202 </div>
 203 <div class="refsect1">
 204 <a name="gst-plugins-base-plugins-gnomevfssrc.property-details"></a><h2>Property Details</h2>
 205 <div class="refsect2">
 206 <a name="GstGnomeVFSSrc--handle"></a><h3>The <code class="literal">"handle"</code> property</h3>
 207 <pre class="programlisting">  "handle"                   <span class="type">GnomeVFSHandle</span>*       : Read / Write</pre>
 208 <p>Handle for GnomeVFS.</p>
 209 </div>
 210 <hr>
 211 <div class="refsect2">
 212 <a name="GstGnomeVFSSrc--iradio-genre"></a><h3>The <code class="literal">"iradio-genre"</code> property</h3>
 213 <pre class="programlisting">  "iradio-genre"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 214 <p>Genre of the stream.</p>
 215 <p>Default value: NULL</p>
 216 </div>
 217 <hr>
 218 <div class="refsect2">
 219 <a name="GstGnomeVFSSrc--iradio-mode"></a><h3>The <code class="literal">"iradio-mode"</code> property</h3>
 220 <pre class="programlisting">  "iradio-mode"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 221 <p>Enable internet radio mode (extraction of shoutcast/icecast metadata).</p>
 222 <p>Default value: FALSE</p>
 223 </div>
 224 <hr>
 225 <div class="refsect2">
 226 <a name="GstGnomeVFSSrc--iradio-name"></a><h3>The <code class="literal">"iradio-name"</code> property</h3>
 227 <pre class="programlisting">  "iradio-name"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 228 <p>Name of the stream.</p>
 229 <p>Default value: NULL</p>
 230 </div>
 231 <hr>
 232 <div class="refsect2">
 233 <a name="GstGnomeVFSSrc--iradio-title"></a><h3>The <code class="literal">"iradio-title"</code> property</h3>
 234 <pre class="programlisting">  "iradio-title"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 235 <p>Name of currently playing song.</p>
 236 <p>Default value: NULL</p>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="GstGnomeVFSSrc--iradio-url"></a><h3>The <code class="literal">"iradio-url"</code> property</h3>
 241 <pre class="programlisting">  "iradio-url"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 242 <p>Homepage URL for radio stream.</p>
 243 <p>Default value: NULL</p>
 244 </div>
 245 <hr>
 246 <div class="refsect2">
 247 <a name="GstGnomeVFSSrc--location"></a><h3>The <code class="literal">"location"</code> property</h3>
 248 <pre class="programlisting">  "location"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 249 <p>Location of the file to read.</p>
 250 <p>Default value: NULL</p>
 251 </div>
 252 <hr>
 253 <div class="refsect2">
 254 <a name="GstGnomeVFSSrc--random-access"></a><h3>The <code class="literal">"random-access"</code> property</h3>
 255 <pre class="programlisting">  "random-access"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 256 <p>Enable random file access.</p>
 257 <p>Default value: FALSE</p>
 258 </div>
 259 </div>
 260 <div class="refsect1">
 261 <a name="gst-plugins-base-plugins-gnomevfssrc.see-also"></a><h2>See Also</h2>
 262 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/gstreamer-plugins-filesrc.html#GstFileSrc"><span class="type">GstFileSrc</span></a>, <a class="link" href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink"><span class="type">GstGnomeVFSSink</span></a>
 263 </div>
 264 </div>
 265 <div class="footer">
 266 <hr>
 267           Generated by GTK-Doc V1.17</div>
 268 </body>
 269 </html>