<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gnomevfssrc</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
<link rel="prev" href="gst-plugins-base-plugins-gnomevfssink.html" title="gnomevfssink">
<link rel="next" href="gst-plugins-base-plugins-multifdsink.html" title="multifdsink">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="gst-plugins-base Elements">
<link rel="chapter" href="ch02.html" title="gst-plugins-base Plugins">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<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>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
<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>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2603472" class="shortcut">Top</a>
 | 
<a href="#id2589779" class="shortcut">Description</a>
 | 
<a href="#id2581559" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2585640" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2557762" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gst-plugins-base-plugins-gnomevfssrc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2603472"></a><span class="refentrytitle">gnomevfssrc</span>
</h2>
<p>gnomevfssrc — Read from any GnomeVFS-supported location</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GstGnomeVFSSrc"></a><pre class="synopsis">
<a href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc-struct">GstGnomeVFSSrc</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2581559"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GstObject
+----GstElement
+----GstBaseSrc
+----GstGnomeVFSSrc
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2585640"></a><h2>Implemented Interfaces</h2>
<p>
GstGnomeVFSSrc implements
GstURIHandler.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2557762"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--handle">handle</a>" GnomeVFSHandle* : Read / Write
"<a href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-genre">iradio-genre</a>" gchar* : Read
"<a href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-mode">iradio-mode</a>" gboolean : Read / Write
"<a href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-name">iradio-name</a>" gchar* : Read
"<a href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-title">iradio-title</a>" gchar* : Read
"<a href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--iradio-url">iradio-url</a>" gchar* : Read
"<a href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--location">location</a>" gchar* : Read / Write
"<a href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc--random-access">random-access</a>" gboolean : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2589779"></a><h2>Description</h2>
<p>
</p>
<div class="refsect2" lang="en">
<a name="id2589792"></a><p>
This plugin reads data from a local or remote location specified
by an URI. This location can be specified using any protocol supported by
the GnomeVFS library. Common protocols are 'file', 'http', 'ftp', or 'smb'.
</p>
<p>
In case the element-gnomevfssrc::iradio-mode property is set and the
location is a http resource, gnomevfssrc will send special icecast http
headers to the server to request additional icecast metainformation. If
the server is not an icecast server, it will display the same behaviour
as if the element-gnomevfssrc::iradio-mode property was not set. However,
if the server is in fact an icecast server, gnomevfssrc will output
data with a media type of application/x-icy, in which case you will
need to use the <span class="type">ICYDemux</span> element as follow-up element to extract
the icecast meta data and to determine the underlying media type.
</p>
<p>
Example pipeline:
</p>
<pre class="programlisting">
gst-launch -v gnomevfssrc location=file:///home/joe/foo.xyz ! fakesink
</pre>
<p>
The above pipeline will simply read a local file and do nothing with the
data read. Instead of gnomevfssrc, we could just as well have used the
filesrc element here.
</p>
<p>
Another example pipeline:
</p>
<pre class="programlisting">
gst-launch -v gnomevfssrc location=smb://othercomputer/foo.xyz ! filesink location=/home/joe/foo.xyz
</pre>
<p>
The above pipeline will copy a file from a remote host to the local file
system using the Samba protocol.
</p>
<p>
Yet another example pipeline:
</p>
<pre class="programlisting">
gst-launch -v gnomevfssrc location=http://music.foobar.com/demo.mp3 ! mad ! audioconvert ! audioresample ! alsasink
</pre>
<p>
The above pipeline will read and decode and play an mp3 file from a
web server using the http protocol.
</p>
</div>
<div class="refsect2" lang="en">
<a name="id2589865"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">plugin</span></td>
<td>
<a href="gst-plugins-base-plugins-plugin-gnomevfs.html#plugin-gnomevfs">gnomevfs</a>
</td>
</tr>
<tr>
<td><span class="term">author</span></td>
<td>Bastien Nocera <hadess@hadess.net>
Ronald S. Bultje <rbultje@ronald.bitfreak.net></td>
</tr>
<tr>
<td><span class="term">class</span></td>
<td>Source/File</td>
</tr>
</tbody>
</table></div>
<h3>Element Pads</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">name</span></td>
<td>src</td>
</tr>
<tr>
<td><span class="term">direction</span></td>
<td>source</td>
</tr>
<tr>
<td><span class="term">presence</span></td>
<td>always</td>
</tr>
<tr>
<td><span class="term">details</span></td>
<td>ANY</td>
</tr>
</tbody>
</table></div>
</div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2600222"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2600233"></a><h3>
<a name="GstGnomeVFSSrc-struct"></a>GstGnomeVFSSrc</h3>
<a class="indexterm" name="id2600245"></a><pre class="programlisting">typedef struct _GstGnomeVFSSrc GstGnomeVFSSrc;</pre>
<p>
Opaque data structure.</p>
<p>
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2600266"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2600277"></a><h3>
<a name="GstGnomeVFSSrc--handle"></a>The "<code class="literal">handle</code>" property</h3>
<a class="indexterm" name="id2600291"></a><pre class="programlisting"> "handle" GnomeVFSHandle* : Read / Write</pre>
<p>Handle for GnomeVFS.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600311"></a><h3>
<a name="GstGnomeVFSSrc--iradio-genre"></a>The "<code class="literal">iradio-genre</code>" property</h3>
<a class="indexterm" name="id2600325"></a><pre class="programlisting"> "iradio-genre" gchar* : Read</pre>
<p>Genre of the stream.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600350"></a><h3>
<a name="GstGnomeVFSSrc--iradio-mode"></a>The "<code class="literal">iradio-mode</code>" property</h3>
<a class="indexterm" name="id2600364"></a><pre class="programlisting"> "iradio-mode" gboolean : Read / Write</pre>
<p>Enable internet radio mode (extraction of shoutcast/icecast metadata).</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600389"></a><h3>
<a name="GstGnomeVFSSrc--iradio-name"></a>The "<code class="literal">iradio-name</code>" property</h3>
<a class="indexterm" name="id2603627"></a><pre class="programlisting"> "iradio-name" gchar* : Read</pre>
<p>Name of the stream.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603651"></a><h3>
<a name="GstGnomeVFSSrc--iradio-title"></a>The "<code class="literal">iradio-title</code>" property</h3>
<a class="indexterm" name="id2603667"></a><pre class="programlisting"> "iradio-title" gchar* : Read</pre>
<p>Name of currently playing song.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603692"></a><h3>
<a name="GstGnomeVFSSrc--iradio-url"></a>The "<code class="literal">iradio-url</code>" property</h3>
<a class="indexterm" name="id2603706"></a><pre class="programlisting"> "iradio-url" gchar* : Read</pre>
<p>Homepage URL for radio stream.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603732"></a><h3>
<a name="GstGnomeVFSSrc--location"></a>The "<code class="literal">location</code>" property</h3>
<a class="indexterm" name="id2603746"></a><pre class="programlisting"> "location" gchar* : Read / Write</pre>
<p>Location of the file to read.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603772"></a><h3>
<a name="GstGnomeVFSSrc--random-access"></a>The "<code class="literal">random-access</code>" property</h3>
<a class="indexterm" name="id2603788"></a><pre class="programlisting"> "random-access" gboolean : Read / Write</pre>
<p>Enable random file access.</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2603815"></a><h2>See Also</h2>
<span class="type">GstFileSrc</span>, <a href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink"><span class="type">GstGnomeVFSSink</span></a>
</div>
</div>
</body>
</html>
