cairorender: Add to the documentation
authorSebastian Dröge <sebastian.droege@collabora.co.uk>
Fri, 17 Jul 2009 11:49:21 +0000 (13:49 +0200)
committerSebastian Dröge <sebastian.droege@collabora.co.uk>
Fri, 17 Jul 2009 11:49:21 +0000 (13:49 +0200)
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.args
docs/plugins/gst-plugins-good-plugins.hierarchy
docs/plugins/inspect/plugin-cairo.xml
ext/cairo/gstcairorender.c

index 9896f0f..dd18964 100644 (file)
@@ -80,6 +80,7 @@ EXTRA_HFILES = \
        $(top_srcdir)/ext/annodex/gstcmmlenc.h \
        $(top_srcdir)/ext/cairo/gsttextoverlay.h \
        $(top_srcdir)/ext/cairo/gsttimeoverlay.h \
+       $(top_srcdir)/ext/cairo/gstcairorender.h \
        $(top_srcdir)/ext/dv/gstdvdec.h \
        $(top_srcdir)/ext/dv/gstdvdemux.h \
        $(top_srcdir)/ext/esd/esdsink.h \
index 00234ae..75714e3 100644 (file)
@@ -48,6 +48,7 @@
     <xi:include href="xml/element-cacasink.xml" />
     <xi:include href="xml/element-cairotextoverlay.xml" />
     <xi:include href="xml/element-cairotimeoverlay.xml" />
+    <xi:include href="xml/element-cairorender.xml" />
     <xi:include href="xml/element-cmmldec.xml" />
     <xi:include href="xml/element-cmmlenc.xml" />
     <xi:include href="xml/element-cutter.xml" />
index 1093c9e..73d7aff 100644 (file)
@@ -421,6 +421,20 @@ gst_cairo_time_overlay_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-cairorender</FILE>
+<TITLE>cairorender</TITLE>
+GstCairoRender
+<SUBSECTION Standard>
+GstCairoRenderClass
+GST_TYPE_CAIRO_RENDER
+GST_CAIRO_RENDER
+GST_CAIRO_RENDER_CLASS
+GST_IS_CAIRO_RENDER
+GST_IS_CAIRO_RENDER_CLASS
+gst_cairo_render_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-cmmldec</FILE>
 <TITLE>cmmldec</TITLE>
 GstCmmlDec
index ba6655b..4ecd245 100644 (file)
 </ARG>
 
 <ARG>
+<NAME>GstFlacEnc::padding</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rwx</FLAGS>
+<NICK>Padding</NICK>
+<BLURB>Write a PADDING block with this length in bytes.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstOssSink::device</NAME>
 <TYPE>gchar*</TYPE>
 <RANGE></RANGE>
index f39fa3f..669801b 100644 (file)
@@ -78,6 +78,7 @@ GObject
         GstRgAnalysis
         GstRgLimiter
         GstVideoCrop
+      GstCairoRender
       GstBaseSrc
         GstPushSrc
           GstSoupHTTPSrc
index dad5908..efa2224 100644 (file)
@@ -1,6 +1,6 @@
 <plugin>
   <name>cairo</name>
-  <description>Cairo-based overlaying</description>
+  <description>Cairo-based elements</description>
   <filename>../../ext/cairo/.libs/libgstcairo.so</filename>
   <basename>libgstcairo.so</basename>
   <version>0.10.15.1</version>
   <origin>Unknown package origin</origin>
   <elements>
     <element>
+      <name>cairorender</name>
+      <longname>Cairo encoder</longname>
+      <class>Codec/Encoder</class>
+      <description>Encodes streams using Cairo</description>
+      <author>Lutz Mueller &lt;lutz@topfrose.de&gt;</author>
+      <pads>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>application/pdf, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]; application/postscript, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]; image/svg+xml, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]; image/png, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]</details>
+        </caps>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]; video/x-raw-yuv, format=(fourcc)Y800, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]; video/x-raw-gray, bpp=(int)8, depth=(int)8, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]; image/png, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
       <name>cairotextoverlay</name>
       <longname>Text overlay</longname>
       <class>Filter/Editor/Video</class>
index 060ec90..4e329ea 100644 (file)
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+/**
+ * SECTION:element-cairorender
+ *
+ * cairorender encodes a video stream into PDF, SVG, PNG or Postscript
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch videotestsrc num-buffers=3 ! cairorender ! "application/pdf" ! filesink location=test.pdf
+ * ]|
+ * </refsect2>
+ */
+
 #include "gstcairorender.h"
 
 #include <cairo.h>