summaryrefslogtreecommitdiffstats
path: root/gst/pcapparse/gstpcapparse.c
diff options
context:
space:
mode:
authorOle André Vadla Ravnås <ole.andre.ravnas@tandberg.com>2008-08-24 16:55:48 +0000
committerOle André Vadla Ravnås <ole.andre.ravnas@tandberg.com>2008-08-24 16:55:48 +0000
commit4c75dffedcbeb67fac21655493fa726b2ad90294 (patch)
treed27b24cfaee25136e9288e039b14a0d73c714ee2 /gst/pcapparse/gstpcapparse.c
parent65062ed750828b054234e0ce96a18556bc2f9696 (diff)
downloadgst-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 'gst/pcapparse/gstpcapparse.c')
-rw-r--r--gst/pcapparse/gstpcapparse.c17
1 files changed, 11 insertions, 6 deletions
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>
*/