Commit 46ef8314 authored by Zaheer Abbas Merali's avatar Zaheer Abbas Merali
Browse files

sys/ximagesrc/ximagesrc.c: Add docs to ximagesrc

Original commit message from CVS:
2006-03-31  Zaheer Abbas Merali  <zaheerabbas at merali dot org>

* sys/ximagesrc/ximagesrc.c:
Add docs to ximagesrc
parent c03f02f5
......@@ -16,6 +16,31 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-ximagesrc
* @short_description: a source that captures your X Display
*
* <refsect2>
* <para>
* This element captures your X Display and creates raw RGB video. It uses
* the XDamage extension if available to only capture areas of the screen that
* have changed since the last frame. It uses the XFixes extension if
* available to also cpature your mouse pointer
* </para>
* <title>Example pipelines</title>
* <para>
* Encode your X display to an Ogg theora video
* </para>
* <programlisting>
* gst-launch -v ximagesrc ! ffmpegcolorspace ! theoraenc ! oggmux ! filesink location=desktop.ogg
* </programlisting>
* <para>
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment