diff options
Diffstat (limited to 'ext/gio')
| -rw-r--r-- | ext/gio/gstgiosink.c | 31 | ||||
| -rw-r--r-- | ext/gio/gstgiosrc.c | 31 | ||||
| -rw-r--r-- | ext/gio/gstgiostreamsink.c | 13 | ||||
| -rw-r--r-- | ext/gio/gstgiostreamsrc.c | 13 |
4 files changed, 28 insertions, 60 deletions
diff --git a/ext/gio/gstgiosink.c b/ext/gio/gstgiosink.c index 985276270..5dda5a8d0 100644 --- a/ext/gio/gstgiosink.c +++ b/ext/gio/gstgiosink.c @@ -21,40 +21,27 @@ /** * SECTION:element-giosink - * @short_description: Write a stream to any GIO-supported location * @see_also: #GstFileSink, #GstGnomeVFSSink, #GstGioSrc * - * <refsect2> - * <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> + * + * <refsect2> + * <title>Example pipelines</title> + * |[ * 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, + * ]| 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 + * ]| 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 + * ]| The above pipeline will encode a 440Hz sine wave to Ogg Vorbis and stores * it in the home directory of user foo. - * </para> * </refsect2> */ diff --git a/ext/gio/gstgiosrc.c b/ext/gio/gstgiosrc.c index e06003381..244398b8a 100644 --- a/ext/gio/gstgiosrc.c +++ b/ext/gio/gstgiosrc.c @@ -21,41 +21,28 @@ /** * SECTION:element-giosrc - * @short_description: Read from any GIO-supported location * @see_also: #GstFileSrc, #GstGnomeVFSSrc, #GstGioSink * - * <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 GIO library or it's VFS backends. Common protocols are 'file', 'http', * 'ftp', or 'smb'. - * </para> - * <para> - * Example pipeline: - * <programlisting> + * + * <refsect2> + * <title>Example launch lines</title> + * |[ * 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 + * ]| 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 + * ]| 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 + * ]| The above pipeline will read and decode and play an mp3 file from a * web server using the http protocol. - * </para> * </refsect2> */ diff --git a/ext/gio/gstgiostreamsink.c b/ext/gio/gstgiostreamsink.c index da3892203..dfade6811 100644 --- a/ext/gio/gstgiostreamsink.c +++ b/ext/gio/gstgiostreamsink.c @@ -21,20 +21,17 @@ /** * SECTION:element-giostreamsink - * @short_description: Write to a GIO GOutputStream * - * <refsect2> - * <para> * This plugin writes incoming data to a custom GIO #GOutputStream. - * </para> - * <para> + * * It can, for example, be used to write a stream to memory with a * #GMemoryOuputStream or to write to a file with a #GFileOuputStream. - * </para> + * + * <refsect2> * <title>Example code</title> * <para> * The following example writes the received data to a #GMemoryOutputStream. - * <programlisting> + * |[ #include <gst/gst.h> #include <gio/gio.h> @@ -60,7 +57,7 @@ out_data = g_memory_ouput_stream_get_data (G_MEMORY_OUTPUT_STREAM (stream)); ... - * </programlisting> + * ]| * </para> * </refsect2> */ diff --git a/ext/gio/gstgiostreamsrc.c b/ext/gio/gstgiostreamsrc.c index 8b3dab03e..81f0596d2 100644 --- a/ext/gio/gstgiostreamsrc.c +++ b/ext/gio/gstgiostreamsrc.c @@ -21,21 +21,18 @@ /** * SECTION:element-giostreamsrc - * @short_description: Reads data from a GIO GInputStream * - * <refsect2> - * <para> * This plugin reads data from a custom GIO #GInputStream. - * </para> - * <para> + * * It can, for example, be used to read data from memory with a * #GMemoryInputStream or to read from a file with a * #GFileInputStream. - * </para> + * + * <refsect2> * <title>Example code</title> * <para> * The following example reads data from a #GMemoryOutputStream. - * <programlisting> + * |[ #include <gst/gst.h> #include <gio/gio.h> @@ -60,7 +57,7 @@ g_object_set (G_OBJECT (src), "stream", stream, NULL); ... - * </programlisting> + * ]| * </para> * </refsect2> */ |