diff options
| author | Ole André Vadla Ravnås <ole.andre.ravnas@tandberg.com> | 2008-08-24 16:55:48 +0000 |
|---|---|---|
| committer | Ole André Vadla Ravnås <ole.andre.ravnas@tandberg.com> | 2008-08-24 16:55:48 +0000 |
| commit | 4c75dffedcbeb67fac21655493fa726b2ad90294 (patch) | |
| tree | d27b24cfaee25136e9288e039b14a0d73c714ee2 /sys | |
| parent | 65062ed750828b054234e0ce96a18556bc2f9696 (diff) | |
| download | gst-plugins-bad-4c75dffedcbeb67fac21655493fa726b2ad90294.tar.gz gst-plugins-bad-4c75dffedcbeb67fac21655493fa726b2ad90294.tar.bz2 gst-plugins-bad-4c75dffedcbeb67fac21655493fa726b2ad90294.zip | |
Added documentation blobs. Thanks to Stefan for noticing!
Original commit message from CVS:
* gst/pcapparse/gstpcapparse.c:
* sys/winscreencap/gstdx9screencapsrc.c:
* sys/winscreencap/gstgdiscreencapsrc.c:
Added documentation blobs. Thanks to Stefan for noticing!
Diffstat (limited to 'sys')
| -rw-r--r-- | sys/winscreencap/gstdx9screencapsrc.c | 22 | ||||
| -rw-r--r-- | sys/winscreencap/gstgdiscreencapsrc.c | 25 |
2 files changed, 47 insertions, 0 deletions
diff --git a/sys/winscreencap/gstdx9screencapsrc.c b/sys/winscreencap/gstdx9screencapsrc.c index e35cb485..c14f8d94 100644 --- a/sys/winscreencap/gstdx9screencapsrc.c +++ b/sys/winscreencap/gstdx9screencapsrc.c @@ -17,6 +17,28 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-dx9screencapsrc + * + * This element uses DirectX to capture the desktop or a portion of it. + * The default is capturing the whole desktop, but #GstDX9ScreenCapSrc:x, + * #GstDX9ScreenCapSrc:y, #GstDX9ScreenCapSrc:width and + * #GstDX9ScreenCapSrc:height can be used to select a particular region. + * Use #GstDX9ScreenCapSrc:monitor for changing which monitor to capture + * from. + * + * <refsect2> + * <title>Example pipelines</title> + * |[ + * gst-launch dx9screencapsrc ! ffmpegcolorspace ! dshowvideosink + * ]| Capture the desktop and display it. + * |[ + * gst-launch dx9screencapsrc x=100 y=100 width=320 height=240 ! + * ffmpegcolorspace ! dshowvideosink + * ]| Capture a portion of the desktop and display it. + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/sys/winscreencap/gstgdiscreencapsrc.c b/sys/winscreencap/gstgdiscreencapsrc.c index 86a3d576..b0109fbd 100644 --- a/sys/winscreencap/gstgdiscreencapsrc.c +++ b/sys/winscreencap/gstgdiscreencapsrc.c @@ -17,6 +17,31 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-gdiscreencapsrc + * + * This element uses GDI to capture the desktop or a portion of it. + * The default is capturing the whole desktop, but #GstGDIScreenCapSrc:x, + * #GstGDIScreenCapSrc:y, #GstGDIScreenCapSrc:width and + * #GstGDIScreenCapSrc:height can be used to select a particular region. + * Use #GstGDIScreenCapSrc:monitor for changing which monitor to capture + * from. + * + * Set #GstGDIScreenCapSrc:cursor to TRUE to include the mouse cursor. + * + * <refsect2> + * <title>Example pipelines</title> + * |[ + * gst-launch gdiscreencapsrc ! ffmpegcolorspace ! dshowvideosink + * ]| Capture the desktop and display it. + * |[ + * gst-launch gdiscreencapsrc x=100 y=100 width=320 height=240 cursor=TRUE + * ! ffmpegcolorspace ! dshowvideosink + * ]| Capture a portion of the desktop, including the mouse cursor, and + * display it. + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif |