summaryrefslogtreecommitdiff
path: root/docs/plugins
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.net>2005-12-27 21:58:28 +0000
committerTim-Philipp Müller <tim@centricular.net>2005-12-27 21:58:28 +0000
commit0eb4eff8aa499eb3e5a8c220b192d2c48e450b21 (patch)
tree22ac3c786bb90d8a1c70646e9174b301076862fd /docs/plugins
parentae2ff9972868210217e0d20b4d229e1b319e9a1f (diff)
docs/plugins/: Add docs stuff for gnomevfssrc and gnomevfssink.
Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * docs/plugins/gst-plugins-base-plugins.args: * docs/plugins/gst-plugins-base-plugins.hierarchy: * docs/plugins/gst-plugins-base-plugins.signals: Add docs stuff for gnomevfssrc and gnomevfssink. * ext/gnomevfs/gstgnomevfssrc.c: Fix example pipeline in gtk-doc blurb.
Diffstat (limited to 'docs/plugins')
-rw-r--r--docs/plugins/Makefile.am5
-rw-r--r--docs/plugins/gst-plugins-base-plugins-docs.sgml3
-rw-r--r--docs/plugins/gst-plugins-base-plugins-sections.txt31
-rw-r--r--docs/plugins/gst-plugins-base-plugins.args32
-rw-r--r--docs/plugins/gst-plugins-base-plugins.hierarchy1
-rw-r--r--docs/plugins/gst-plugins-base-plugins.signals7
6 files changed, 61 insertions, 18 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index da3b90e7..95d9c51f 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -73,10 +73,9 @@ IGNORE_CFILES = utils.c mem.c imgconvert.c
# but I'm not sure about that - it might be this Just Works given that
# the registry won't have the element
-# FIXME: not ported yet
-# $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c
-
EXTRA_HFILES = \
+ $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.h \
+ $(top_srcdir)/ext/gnomevfs/gstgnomevfssrc.h \
$(top_srcdir)/ext/pango/gstclockoverlay.h \
$(top_srcdir)/ext/pango/gsttextoverlay.h \
$(top_srcdir)/ext/pango/gsttextrender.h \
diff --git a/docs/plugins/gst-plugins-base-plugins-docs.sgml b/docs/plugins/gst-plugins-base-plugins-docs.sgml
index 8235b30f..f0ace7a0 100644
--- a/docs/plugins/gst-plugins-base-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-base-plugins-docs.sgml
@@ -16,9 +16,8 @@
<xi:include href="xml/element-audiotestsrc.xml" />
<xi:include href="xml/element-clockoverlay.xml" />
<xi:include href="xml/element-ffmpegcolorspace.xml" />
-<!--
<xi:include href="xml/element-gnomevfssink.xml" />
--->
+ <xi:include href="xml/element-gnomevfssrc.xml" />
<xi:include href="xml/element-multifdsink.xml" />
<xi:include href="xml/element-tcpserversink.xml" />
<xi:include href="xml/element-theoraenc.xml" />
diff --git a/docs/plugins/gst-plugins-base-plugins-sections.txt b/docs/plugins/gst-plugins-base-plugins-sections.txt
index 4641f139..efcf1b4e 100644
--- a/docs/plugins/gst-plugins-base-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-base-plugins-sections.txt
@@ -54,6 +54,14 @@ GstGnomeVFSSinkClass
</SECTION>
<SECTION>
+<FILE>element-gnomevfssrc</FILE>
+<TITLE>gnomevfssrc</TITLE>
+GstGnomeVFSSrc
+<SUBSECTION Standard>
+GstGnomeVFSSrcClass
+</SECTION>
+
+<SECTION>
<FILE>element-tcpserversink</FILE>
<TITLE>tcpserversink</TITLE>
GstTCPServerSink
@@ -143,17 +151,17 @@ CLIENTS_LOCK_INIT
GST_MULTI_FD_SINK_GET_CLASS
CLIENTS_LOCK_FREE
GST_IS_MULTI_FD_SINK_CLASS
-gst_multi_fd_sinkget_type
-gst_multi_fd_sinkremove
+gst_multi_fd_sink_get_type
+gst_multi_fd_sink_remove
GST_IS_MULTI_FD_SINK
CLIENTS_LOCK
GST_TYPE_MULTI_FD_SINK
-gst_multi_fd_sinkclear
+gst_multi_fd_sink_clear
GstTCPClient
GST_MULTI_FD_SINK_CLASS
-gst_multi_fd_sinkget_stats
+gst_multi_fd_sink_get_stats
GST_MULTI_FD_SINK
-gst_multi_fd_sinkadd
+gst_multi_fd_sink_add
GST_TCP_SERVER_SINK
GstTCPServerSinkFlags
@@ -162,14 +170,13 @@ gst_tcp_server_sink_get_type
GST_IS_TCP_SERVER_SINK_CLASS
GST_IS_TCP_SERVER_SINK
-GST_GNOMEVFSSINK_CLASS
-GST_TYPE_GNOMEVFSSINK
-GST_IS_GNOMEVFSSINK
-gst_gnomevfssink_get_type
-GST_IS_GNOMEVFSSINK_CLASS
+GST_GNOME_VFS_SINK_CLASS
+GST_TYPE_GNOME_VFS_SINK
+GST_IS_GNOME_VFS_SINK
+gst_gnome_vfs_sink_get_type
+GST_IS_GNOME_VFS_SINK_CLASS
GST_ELEMENT_CLASS
-GstGnomeVFSSinkFlags
-GST_GNOMEVFSSINK
+GST_GNOME_VFS_SINK
GST_IS_VORBISENC
GST_VORBISENC_CLASS
diff --git a/docs/plugins/gst-plugins-base-plugins.args b/docs/plugins/gst-plugins-base-plugins.args
index ffe9ecda..ca2768c9 100644
--- a/docs/plugins/gst-plugins-base-plugins.args
+++ b/docs/plugins/gst-plugins-base-plugins.args
@@ -820,7 +820,7 @@
<ARG>
<NAME>GstGnomeVFSSrc::handle</NAME>
-<TYPE>gpointer</TYPE>
+<TYPE>GnomeVFSHandle</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>GnomeVFSHandle</NICK>
@@ -1378,3 +1378,33 @@
<DEFAULT>""</DEFAULT>
</ARG>
+<ARG>
+<NAME>GstGnomeVFSSink::handle</NAME>
+<TYPE>GnomeVFSHandle</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>GnomeVFSHandle</NICK>
+<BLURB>Handle for GnomeVFS.</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstGnomeVFSSink::location</NAME>
+<TYPE>gchararray</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>File Location</NICK>
+<BLURB>Location of the file to read.</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstGnomeVFSSink::uri</NAME>
+<TYPE>GnomeVFSURI</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>GnomeVFSURI</NICK>
+<BLURB>URI for GnomeVFS.</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/gst-plugins-base-plugins.hierarchy b/docs/plugins/gst-plugins-base-plugins.hierarchy
index 1e839a9d..d11d6df1 100644
--- a/docs/plugins/gst-plugins-base-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-base-plugins.hierarchy
@@ -14,6 +14,7 @@ GObject
GstVideoSink
GstXvImageSink
GstXImageSink
+ GstGnomeVFSSink
GstMultiFdSink
GstTCPServerSink
GstBaseAudioSink
diff --git a/docs/plugins/gst-plugins-base-plugins.signals b/docs/plugins/gst-plugins-base-plugins.signals
index 7876bb4e..84deaa0d 100644
--- a/docs/plugins/gst-plugins-base-plugins.signals
+++ b/docs/plugins/gst-plugins-base-plugins.signals
@@ -84,3 +84,10 @@ CDParanoia *cdparanoia
gint arg1
</SIGNAL>
+<SIGNAL>
+<NAME>GstGnomeVFSSink::allow-overwrite</NAME>
+<RETURNS>gboolean</RETURNS>
+GstGnomeVFSSink *gstgnomevfssink
+GnomeVFSURI *arg1
+</SIGNAL>
+