From 925d6f34e104ac8e64306b1e91f25ca13ced4ba0 Mon Sep 17 00:00:00 2001
From: Edward Hervey <bilboed@bilboed.com>
Date: Mon, 11 Aug 2008 15:05:13 +0000
Subject: docs/plugins/: Integrate documentation for new hdv1394src element.

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:
* docs/plugins/gst-plugins-good-plugins.args:
* docs/plugins/gst-plugins-good-plugins.hierarchy:
* docs/plugins/gst-plugins-good-plugins.interfaces:
Integrate documentation for new hdv1394src element.
---
 docs/plugins/Makefile.am                           |  1 +
 docs/plugins/gst-plugins-good-plugins-docs.sgml    |  1 +
 docs/plugins/gst-plugins-good-plugins-sections.txt | 14 ++++++
 docs/plugins/gst-plugins-good-plugins.args         | 50 ++++++++++++++++++++++
 docs/plugins/gst-plugins-good-plugins.hierarchy    |  1 +
 docs/plugins/gst-plugins-good-plugins.interfaces   |  1 +
 6 files changed, 68 insertions(+)

(limited to 'docs')

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index b5cb41af..c6ba7e85 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -97,6 +97,7 @@ EXTRA_HFILES = \
 	$(top_srcdir)/ext/libpng/gstpngdec.h \
 	$(top_srcdir)/ext/libpng/gstpngenc.h \
 	$(top_srcdir)/ext/raw1394/gstdv1394src.h \
+	$(top_srcdir)/ext/raw1394/gsthdv1394src.h \
 	$(top_srcdir)/ext/soup/gstsouphttpsrc.h \
 	$(top_srcdir)/ext/taglib/gstapev2mux.h \
 	$(top_srcdir)/ext/taglib/gstid3v2mux.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 72b54c5b..c72f2aa0 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -39,6 +39,7 @@
     <xi:include href="xml/element-directdrawsink.xml" />
     <xi:include href="xml/element-directsoundsink.xml" />
     <xi:include href="xml/element-dv1394src.xml" />
+    <xi:include href="xml/element-hdv1394src.xml" />
     <xi:include href="xml/element-dvdec.xml" />
     <xi:include href="xml/element-dvdemux.xml" />
     <xi:include href="xml/element-equalizer-10bands.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 712c0c8d..0e56bd5c 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -418,6 +418,20 @@ GST_IS_DV1394SRC_CLASS
 gst_dv1394src_get_type
 </SECTION>
 
+<SECTION>
+<FILE>element-hdv1394src</FILE>
+<TITLE>hdv1394src</TITLE>
+GstHDV1394Src
+<SUBSECTION Standard>
+GstHDV1394SrcClass
+GST_TYPE_HDV1394SRC
+GST_HDV1394SRC
+GST_HDV1394SRC_CLASS
+GST_IS_HDV1394SRC
+GST_IS_HDV1394SRC_CLASS
+gst_hdv1394src_get_type
+</SECTION>
+
 <SECTION>
 <FILE>element-dvdec</FILE>
 <TITLE>dvdec</TITLE>
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index 28697ebf..5d4d983e 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -19498,3 +19498,53 @@
 <DEFAULT>89</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstHDV1394Src::channel</NAME>
+<TYPE>gint</TYPE>
+<RANGE>[0,64]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Channel</NICK>
+<BLURB>Channel number for listening.</BLURB>
+<DEFAULT>63</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstHDV1394Src::device-name</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>device name</NICK>
+<BLURB>user-friendly name of the device.</BLURB>
+<DEFAULT>"Default"</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstHDV1394Src::guid</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>GUID</NICK>
+<BLURB>select one of multiple DV devices by its GUID. use a hexadecimal like 0xhhhhhhhhhhhhhhhh. (0 = no guid).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstHDV1394Src::port</NAME>
+<TYPE>gint</TYPE>
+<RANGE>[G_MAXULONG,16]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Port</NICK>
+<BLURB>Port number (-1 automatic).</BLURB>
+<DEFAULT>-1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstHDV1394Src::use-avc</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Use AV/C</NICK>
+<BLURB>Use AV/C VTR control.</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index 78d644e3..40300aaa 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -52,6 +52,7 @@ GObject
       GstBaseSrc
         GstPushSrc
           GstDV1394Src
+          GstHDV1394Src
           GstSoupHTTPSrc
           GstBaseAudioSrc
             GstAudioSrc
diff --git a/docs/plugins/gst-plugins-good-plugins.interfaces b/docs/plugins/gst-plugins-good-plugins.interfaces
index c431d34f..b669efec 100644
--- a/docs/plugins/gst-plugins-good-plugins.interfaces
+++ b/docs/plugins/gst-plugins-good-plugins.interfaces
@@ -14,6 +14,7 @@ GstRTSPSrc GstChildProxy GstURIHandler
 GstShout2send GstTagSetter
 GstUDPSink GstURIHandler
 GstDV1394Src GstURIHandler GstPropertyProbe
+GstHDV1394Src GstURIHandler GstPropertyProbe
 GstSoupHTTPSrc GstURIHandler
 GstPulseSrc GstImplementsInterface GstMixer
 GstOssSrc GstImplementsInterface GstMixer
-- 
cgit