diff options
| author | Zaheer Abbas Merali <zaheerabbas@merali.org> | 2006-03-31 16:32:47 +0000 |
|---|---|---|
| committer | Zaheer Abbas Merali <zaheerabbas@merali.org> | 2006-03-31 16:32:47 +0000 |
| commit | 10496d32d77078782f402b8fea831f777faf7512 (patch) | |
| tree | d592a02147994b0f3233ede47feed8f6d0e4bef2 /sys/ximagesrc | |
| parent | 7b8578af9f13465c8fec1fa973b78e8f431b88c1 (diff) | |
| download | gst-plugins-bad-10496d32d77078782f402b8fea831f777faf7512.tar.gz gst-plugins-bad-10496d32d77078782f402b8fea831f777faf7512.tar.bz2 gst-plugins-bad-10496d32d77078782f402b8fea831f777faf7512.zip | |
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
Diffstat (limited to 'sys/ximagesrc')
| -rw-r--r-- | sys/ximagesrc/ximagesrc.c | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/sys/ximagesrc/ximagesrc.c b/sys/ximagesrc/ximagesrc.c index 94b131c2..2edbfd74 100644 --- a/sys/ximagesrc/ximagesrc.c +++ b/sys/ximagesrc/ximagesrc.c @@ -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 |