summaryrefslogtreecommitdiffstats
path: root/gst
diff options
context:
space:
mode:
authorMark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>2008-06-26 15:52:40 +0000
committerMark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>2008-06-26 15:52:40 +0000
commited52aa4949339123e81c530cebdb91ee28529479 (patch)
tree4ac975a4e9a8d19761b6fd1b41c5275e3195129f /gst
parent53bb18b291a97220a90f8e0521ce7966cf8360b5 (diff)
downloadgst-plugins-bad-ed52aa4949339123e81c530cebdb91ee28529479.tar.gz
gst-plugins-bad-ed52aa4949339123e81c530cebdb91ee28529479.tar.bz2
gst-plugins-bad-ed52aa4949339123e81c530cebdb91ee28529479.zip
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.
Diffstat (limited to 'gst')
-rw-r--r--gst/y4m/gsty4mencode.c21
1 files changed, 20 insertions, 1 deletions
diff --git a/gst/y4m/gsty4mencode.c b/gst/y4m/gsty4mencode.c
index dc432f8d..dc218643 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 */