mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-17 03:35:21 +00:00
Code Issues 1 Projects Releases Wiki Activity

ext/gio/: Make the documentation of giosink/giosrc complete, large parts are based on the gnomevfssink/gnomevfssrc docs.

Browse source 
Original commit message from CVS:
* ext/gio/gstgiosink.c:
* ext/gio/gstgiosrc.c:
Make the documentation of giosink/giosrc complete, large parts
are based on the gnomevfssink/gnomevfssrc docs.
This commit is contained in:
Sebastian Dröge 2008-02-12 08:55:57 +00:00
parent e6bbc03778
commit 9313ee92fd
3 changed files with 64 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
ChangeLog
View file

@ -1,3 +1,10 @@
2008-02-12 Sebastian Dröge <slomo@circular-chaos.org>
* ext/gio/gstgiosink.c:
* ext/gio/gstgiosrc.c:
Make the documentation of giosink/giosrc complete, large parts
are based on the gnomevfssink/gnomevfssrc docs.
2008-02-12 Sebastian Dröge <slomo@circular-chaos.org>
* docs/plugins/gst-plugins-base-plugins-docs.sgml:

30
ext/gio/gstgiosink.c
View file

@ -21,13 +21,39 @@
/**
* SECTION:element-giosink
* @short_description: Write a stream to any GIO-supported location
* @see_also: #GstFileSink, #GstGnomeVFSSink, #GstGioSrc
*
* <refsect2>
* <title>Example launch line</title>
* <para>
* This plugin writes incoming data to a local or remote location specified
* by an URI. This location can be specified using any protocol supported by
* the GIO library or it's VFS backends. Common protocols are 'file', 'ftp',
* or 'smb'.
* </para>
* <para>
* Example pipeline:
* <programlisting>
* gst-launch audiotestsrc num-buffers=100 ! flacenc ! giosink location=file:///home/foo/bar.flac
* gst-launch -v filesrc location=input.xyz ! giosink location=file:///home/joe/out.xyz
* </programlisting>
* The above pipeline will simply copy a local file. Instead of giosink,
* we could just as well have used the filesink element here.
* </para>
* <para>
* Another example pipeline:
* <programlisting>
* gst-launch -v filesrc location=foo.mp3 ! mad ! flacenc ! giosink location=smb://othercomputer/foo.flac
* </programlisting>
* The above pipeline will re-encode an mp3 file into FLAC format and store
* it on a remote host using the Samba protocol.
* </para>
* <para>
* Another example pipeline:
* <programlisting>
* gst-launch -v audiotestsrc num-buffers=100 ! vorbisenc ! oggmux ! giosink location=file:///home/foo/bar.ogg
* </programlisting>
* The above pipeline will encode a 440Hz sine wave to Ogg Vorbis and stores
* it in the home directory of user foo.
* </para>
* </refsect2>
*/

31
ext/gio/gstgiosrc.c
View file

@ -21,13 +21,40 @@
/**
* SECTION:element-giosrc
* @short_description: Read from any GIO-supported location
* @see_also: #GstFileSrc, #GstGnomeVFSSrc, #GstGioSink
*
* <refsect2>
* <title>Example launch line</title>
* <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 GIO library or it's VFS backends. Common protocols are 'file', 'http',
* 'ftp', or 'smb'.
* </para>
* <para>
* Example pipeline:
* <programlisting>
* gst-launch giosrc location=file:///home/foo/bar.ext ! fakesink
* gst-launch -v giosrc location=file:///home/joe/foo.xyz ! fakesink
* </programlisting>
* The above pipeline will simply read a local file and do nothing with the
* data read. Instead of giosrc, we could just as well have used the
* filesrc element here.
* </para>
* <para>
* Another example pipeline:
* <programlisting>
* gst-launch -v giosrc 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
* system using the Samba protocol.
* </para>
* <para>
* Yet another example pipeline:
* <programlisting>
* gst-launch -v giosrc 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
* web server using the http protocol.
* </para>
* </refsect2>
*/