summaryrefslogtreecommitdiffstats
path: root/ext/raw1394
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sourceforge.net>2008-05-28 14:31:05 +0000
committerStefan Kost <ensonic@users.sourceforge.net>2008-05-28 14:31:05 +0000
commit7ec92ddf2dceceeb688b26d45ba606eb6df29f19 (patch)
treeb846fd3a3ef2fb99ba41ae53ec73e4263d71c107 /ext/raw1394
parent9c17a6006f1d1dbe921fddbe4b7315b5a3714bcc (diff)
Document whats first shown on the fdo plugin docs page :)
Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-good-plugins-docs.sgml: * docs/plugins/gst-plugins-good-plugins-sections.txt: * ext/raw1394/gstdv1394src.c: Document whats first shown on the fdo plugin docs page :)
Diffstat (limited to 'ext/raw1394')
-rw-r--r--ext/raw1394/gstdv1394src.c17
1 files changed, 17 insertions, 0 deletions
diff --git a/ext/raw1394/gstdv1394src.c b/ext/raw1394/gstdv1394src.c
index 34a354f3..e5ea2889 100644
--- a/ext/raw1394/gstdv1394src.c
+++ b/ext/raw1394/gstdv1394src.c
@@ -19,6 +19,23 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-dv1394src
+ *
+ * <refsect2>
+ * <para>
+ * Read DV (digital video) data from firewire port.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch dv1394src ! dvdemux name=d ! queue ! dvdec ! xvimagesink d. ! queue ! alsasink
+ * </programlisting>
+ * This pipeline captures from the firewire port and displays it (might need
+ * format converters for audio/video).
+ * </para>
+ * </refsect2>
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"