diff options
| author | Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk> | 2008-06-26 15:52:40 +0000 |
|---|---|---|
| committer | Jan Schmidt <thaytan@noraisin.net> | 2009-05-15 23:35:08 +0100 |
| commit | 522f875d31f8dca8becc1ebc000e5b2a088eaa90 (patch) | |
| tree | b19bdd3f7d4d43407e33757a3623420b07a41a24 | |
| parent | 3110dafee83560290e97bb9ed2fbb9d1db18c4b6 (diff) | |
[MOVED FROM BAD] Add documentation for YUV4MPEG2 encoder element.
Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* gst/y4m/gsty4mencode.c:
Add documentation for YUV4MPEG2 encoder element.
| -rw-r--r-- | gst/y4m/gsty4mencode.c | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/gst/y4m/gsty4mencode.c b/gst/y4m/gsty4mencode.c index dc432f8d4..dc2186433 100644 --- a/gst/y4m/gsty4mencode.c +++ b/gst/y4m/gsty4mencode.c @@ -1,6 +1,6 @@ /* GStreamer * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu> - * Copyright (C) <2006> Mark Nauwelaerts <mnauw@skynet.be> + * Copyright (C) <2006> Mark Nauwelaerts <mnauw@users.sourceforge.net> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public @@ -17,6 +17,25 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-y4menc + * + * <refsect2> + * <para> + * Creates a YU4MPEG2 raw video stream as defined by the mjpegtools project. + * </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' \ + * ! y4menc ! filesink location=test.yuv + * </programlisting> + * </para> + * </refsect2> + * + */ /* see mjpegtools/yuv4mpeg.h for yuv4mpeg format */ |