diff options
| author | Tim-Philipp Müller <tim@centricular.net> | 2006-04-27 16:05:54 +0000 |
|---|---|---|
| committer | Tim-Philipp Müller <tim@centricular.net> | 2006-04-27 16:05:54 +0000 |
| commit | b88deddeca5ed94c19baa5321d04447897a4840d (patch) | |
| tree | 637daabe2339ef056d0eb3934159223dad98b358 /gst/avi/gstavimux.c | |
| parent | d1cdfa6d3c0950bf95ad25697e4a38586a4eab83 (diff) | |
Add docs for both avidemux and avimux.
Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-good-plugins-docs.sgml:
* docs/plugins/gst-plugins-good-plugins-sections.txt:
* docs/plugins/gst-plugins-good-plugins.hierarchy:
* docs/plugins/inspect/plugin-avi.xml:
* gst/avi/gstavidemux.c:
* gst/avi/gstavimux.c:
Add docs for both avidemux and avimux.
Diffstat (limited to 'gst/avi/gstavimux.c')
| -rw-r--r-- | gst/avi/gstavimux.c | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/gst/avi/gstavimux.c b/gst/avi/gstavimux.c index ce8c4ab0..de070772 100644 --- a/gst/avi/gstavimux.c +++ b/gst/avi/gstavimux.c @@ -25,6 +25,46 @@ * - openDML large-AVI docs */ +/** + * SECTION:element-avimux + * + * <refsect2> + * <para> + * Muxes raw or compressed audio and/or video streams into an AVI file. + * </para> + * <title>Example launch line</title> + * <para> + * (write everything in one line, without the backslash characters) + * <programlisting> + * gst-launch-0.10 videotestsrc num-buffers=250 \ + * ! 'video/x-raw-yuv,format=(fourcc)I420,width=320,height=240,framerate=(fraction)25/1' \ + * ! queue ! mux. \ + * audiotestsrc num-buffers=440 ! audioconvert \ + * ! 'audio/x-raw-int,rate=44100,channels=2' ! queue ! mux. \ + * avimux name=mux ! filesink location=test.avi + * </programlisting> + * This will create an .AVI file containing an uncompressed video stream + * with a test picture and an uncompressed audio stream containing a + * test sound. + * </para> + * <title>Another example launch line</title> + * <para> + * (write everything in one line, without the backslash characters) + * <programlisting> + * gst-launch-0.10 videotestsrc num-buffers=250 \ + * ! 'video/x-raw-yuv,format=(fourcc)I420,width=320,height=240,framerate=(fraction)25/1' \ + * ! xvidenc ! queue ! mux. \ + * audiotestsrc num-buffers=440 ! audioconvert ! 'audio/x-raw-int,rate=44100,channels=2' \ + * ! lame ! queue ! mux. \ + * avimux name=mux ! filesink location=test.avi + * </programlisting> + * This will create an .AVI file containing the same test video and sound + * as above, only that both streams will be compressed this time. This will + * only work if you have the necessary encoder elements installed of course. + * </para> + * </refsect2> + * + */ #ifdef HAVE_CONFIG_H #include "config.h" |