diff options
| -rw-r--r-- | ChangeLog | 7 | ||||
| -rw-r--r-- | gst/pcapparse/gstpcapparse.c | 17 | ||||
| -rw-r--r-- | sys/winscreencap/gstdx9screencapsrc.c | 22 | ||||
| -rw-r--r-- | sys/winscreencap/gstgdiscreencapsrc.c | 25 |
4 files changed, 65 insertions, 6 deletions
@@ -1,5 +1,12 @@ 2008-08-24 Ole André Vadla Ravnås <ole.andre.ravnas@tandberg.com> + * gst/pcapparse/gstpcapparse.c: + * sys/winscreencap/gstdx9screencapsrc.c: + * sys/winscreencap/gstgdiscreencapsrc.c: + Added documentation blobs. Thanks to Stefan for noticing! + +2008-08-24 Ole André Vadla Ravnås <ole.andre.ravnas@tandberg.com> + * configure.ac: * gst/pcapparse/Makefile.am: * gst/pcapparse/gstpcapparse.c: diff --git a/gst/pcapparse/gstpcapparse.c b/gst/pcapparse/gstpcapparse.c index cef19182..f2674ea6 100644 --- a/gst/pcapparse/gstpcapparse.c +++ b/gst/pcapparse/gstpcapparse.c @@ -20,13 +20,18 @@ /** * SECTION:element-pcapparse * + * Extracts payloads from Ethernet-encapsulated IP packets, currently limited + * to UDP. Use #GstPcapParse:src-ip, #GstPcapParse:dst-ip, + * #GstPcapParse:src-port and #GstPcapParse:dst-port to restrict which packets + * should be included. + * * <refsect2> - * <title>Example launch line</title> - * <para> - * <programlisting> - * gst-launch-0.10 -v filesrc location=h264crasher.pcap ! pcapparse ! rtph264depay ! ffdec_h264 ! fakesink - * </programlisting> - * </para> + * <title>Example pipelines</title> + * |[ + * gst-launch-0.10 filesrc location=h264crasher.pcap ! pcapparse ! rtph264depay + * ! ffdec_h264 ! fakesink + * ]| Read from a pcap dump file using filesrc, extract the raw UDP packets, + * depayload and decode them. * </refsect2> */ 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 |