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.
This commit is contained in:
Mark Nauwelaerts 2008-06-26 15:52:40 +00:00
parent 53bb18b291
commit ed52aa4949
5 changed files with 42 additions and 1 deletions

View file

@ -1,3 +1,11 @@
2008-06-26 Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>
* 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.
2008-06-25 Edward Hervey <edward.hervey@collabora.co.uk>
* gst/deinterlace2/tvtime/tomsmocomp/tomsmocompmacros.h:

View file

@ -138,6 +138,7 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/videosignal/gstvideoanalyse.h \
$(top_srcdir)/gst/videosignal/gstvideodetect.h \
$(top_srcdir)/gst/videosignal/gstvideomark.h \
$(top_srcdir)/gst/y4m/gsty4mencode.h \
$(top_srcdir)/sys/dvb/gstdvbsrc.h
# Images to copy into HTML directory.

View file

@ -55,6 +55,7 @@
<xi:include href="xml/element-videomark.xml" />
<xi:include href="xml/element-videoparse.xml" />
<xi:include href="xml/element-wildmidi.xml" />
<xi:include href="xml/element-y4menc.xml" />
</chapter>
<chapter>

View file

@ -703,3 +703,15 @@ GST_IS_WILDMIDI_CLASS
GST_TYPE_WILDMIDI
</SECTION>
<SECTION>
<FILE>element-y4menc</FILE>
<TITLE>y4menc</TITLE>
GstY4mEncode
<SUBSECTION Standard>
GstY4mEncodeClass
GST_Y4M_ENCODE
GST_Y4M_ENCODE_CLASS
GST_IS_Y4M_ENCODE
GST_IS_Y4M_ENCODE_CLASS
GST_TYPE_Y4M_ENCODE
</SECTION>

View file

@ -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 */