diff options
Diffstat (limited to 'ext/gnomevfs/gstgnomevfssrc.c')
| -rw-r--r-- | ext/gnomevfs/gstgnomevfssrc.c | 41 |
1 files changed, 13 insertions, 28 deletions
diff --git a/ext/gnomevfs/gstgnomevfssrc.c b/ext/gnomevfs/gstgnomevfssrc.c index 3242f653..84c43640 100644 --- a/ext/gnomevfs/gstgnomevfssrc.c +++ b/ext/gnomevfs/gstgnomevfssrc.c @@ -25,53 +25,38 @@ /** * SECTION:element-gnomevfssrc - * @short_description: Read from any GnomeVFS-supported location * @see_also: #GstFileSrc, #GstGnomeVFSSink * - * <refsect2> - * <para> * 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'. - * </para> - * <para> - * In case the element-gnomevfssrc::iradio-mode property is set and the + * + * In case the #GstGnomeVFSSrc: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, + * as if the #GstGnomeVFSSrc: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 #ICYDemux element as follow-up element to extract + * need to use the #GstICYDemux element as follow-up element to extract * the icecast meta data and to determine the underlying media type. - * </para> - * <para> - * Example pipeline: - * <programlisting> + * + * <refsect2> + * <title>Example launch lines</title> + * |[ * gst-launch -v gnomevfssrc location=file:///home/joe/foo.xyz ! fakesink - * </programlisting> - * The above pipeline will simply read a local file and do nothing with the + * ]| 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. - * </para> - * <para> - * Another example pipeline: - * <programlisting> + * |[ * gst-launch -v gnomevfssrc location=smb://othercomputer/foo.xyz ! filesink location=/home/joe/foo.xyz - * </programlisting> - * The above pipeline will copy a file from a remote host to the local file + * ]| The above pipeline will copy a file from a remote host to the local file * system using the Samba protocol. - * </para> - * <para> - * Yet another example pipeline: - * <programlisting> + * |[ * gst-launch -v gnomevfssrc location=http://music.foobar.com/demo.mp3 ! mad ! audioconvert ! audioresample ! alsasink - * </programlisting> - * The above pipeline will read and decode and play an mp3 file from a + * ]| The above pipeline will read and decode and play an mp3 file from a * web server using the http protocol. - * </para> * </refsect2> - * */ |