2003-05-18 15:04:26 +00:00
|
|
|
<?xml version="1.0"?>
|
|
|
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
2004-05-20 12:40:31 +00:00
|
|
|
<!ENTITY % version-entities SYSTEM "version.entities">
|
2004-02-12 17:23:37 +00:00
|
|
|
%version-entities;
|
|
|
|
|
<!ENTITY Gst SYSTEM "xml/gst.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstBin SYSTEM "xml/gstbin.xml">
|
|
|
|
|
<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
|
2005-08-23 14:25:55 +00:00
|
|
|
<!ENTITY GstBus SYSTEM "xml/gstbus.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
|
2005-08-25 23:17:18 +00:00
|
|
|
<!ENTITY GstCheck SYSTEM "xml/gstcheck.xml">
|
ported gstchildproxy over from 0.8 ported gst-inspect fixes and enhancements over from 0.8
Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* gst/Makefile.am:
* gst/gstbin.c: (gst_bin_get_type),
(gst_bin_child_proxy_get_child_by_index),
(gst_bin_child_proxy_get_children_count),
(gst_bin_child_proxy_init):
* gst/gstchildproxy.c: (gst_child_proxy_get_child_by_name),
(gst_child_proxy_get_child_by_index),
(gst_child_proxy_get_children_count), (gst_child_proxy_lookup),
(gst_child_proxy_get_property), (gst_child_proxy_get_valist),
(gst_child_proxy_get), (gst_child_proxy_set_property),
(gst_child_proxy_set_valist), (gst_child_proxy_set),
(gst_child_proxy_child_added), (gst_child_proxy_child_removed),
(gst_child_proxy_base_init), (gst_child_proxy_get_type):
* gst/gstchildproxy.h:
* gst/parse/grammar.y:
* tools/gst-inspect.c: (print_interfaces),
(print_element_properties_info), (print_element_info):
ported gstchildproxy over from 0.8
ported gst-inspect fixes and enhancements over from 0.8
2005-08-22 21:03:33 +00:00
|
|
|
<!ENTITY GstChildProxy SYSTEM "xml/gstchildproxy.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
|
2005-06-27 14:40:09 +00:00
|
|
|
<!--
|
2004-07-27 15:01:10 +00:00
|
|
|
<!ENTITY GstCompat SYSTEM "xml/gstcompat.xml">
|
2005-06-27 14:40:09 +00:00
|
|
|
-->
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
|
2004-07-23 15:38:47 +00:00
|
|
|
<!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstError SYSTEM "xml/gsterror.xml">
|
|
|
|
|
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
|
2004-07-27 15:01:10 +00:00
|
|
|
<!ENTITY GstFilter SYSTEM "xml/gstfilter.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
|
2004-07-26 16:34:35 +00:00
|
|
|
<!ENTITY GstGhostPad SYSTEM "xml/gstghostpad.xml">
|
2004-07-27 15:01:10 +00:00
|
|
|
<!ENTITY GstImplementsInterface SYSTEM "xml/gstimplementsinterface.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
|
2004-07-26 16:34:35 +00:00
|
|
|
<!ENTITY GstIndexFactory SYSTEM "xml/gstindexfactory.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
|
2005-06-27 14:40:09 +00:00
|
|
|
<!ENTITY GstIterator SYSTEM "xml/gstiterator.xml">
|
2004-07-27 15:01:10 +00:00
|
|
|
<!ENTITY GstMacros SYSTEM "xml/gstmacros.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
|
2005-08-24 21:35:43 +00:00
|
|
|
<!ENTITY GstMessage SYSTEM "xml/gstmessage.xml">
|
2005-07-11 18:41:49 +00:00
|
|
|
<!ENTITY GstMiniObject SYSTEM "xml/gstminiobject.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstObject SYSTEM "xml/gstobject.xml">
|
|
|
|
|
<!ENTITY GstPad SYSTEM "xml/gstpad.xml">
|
2004-07-26 16:34:35 +00:00
|
|
|
<!ENTITY GstPadTemplate SYSTEM "xml/gstpadtemplate.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstParse SYSTEM "xml/gstparse.xml">
|
|
|
|
|
<!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
|
|
|
|
|
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
|
|
|
|
|
<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
|
2005-08-24 21:35:43 +00:00
|
|
|
<!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
|
2004-07-27 15:01:10 +00:00
|
|
|
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
|
|
|
|
|
<!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
|
|
|
|
|
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
|
2004-07-26 16:34:35 +00:00
|
|
|
<!ENTITY GstTagList SYSTEM "xml/gsttaglist.xml">
|
2004-07-21 11:32:09 +00:00
|
|
|
<!ENTITY GstTagSetter SYSTEM "xml/gsttagsetter.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
|
2004-07-27 15:01:10 +00:00
|
|
|
<!ENTITY GstTrashStack SYSTEM "xml/gsttrashstack.xml">
|
2003-10-28 20:25:30 +00:00
|
|
|
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
|
2004-07-26 16:34:35 +00:00
|
|
|
<!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
|
2004-07-27 15:01:10 +00:00
|
|
|
<!ENTITY GstTypes SYSTEM "xml/gsttypes.xml">
|
2004-07-26 16:34:35 +00:00
|
|
|
<!ENTITY GstUriHandler SYSTEM "xml/gsturihandler.xml">
|
2004-07-27 15:01:10 +00:00
|
|
|
<!ENTITY GstUriType SYSTEM "xml/gsturitype.xml">
|
2005-09-05 09:38:38 +00:00
|
|
|
<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
|
2004-07-27 15:01:10 +00:00
|
|
|
<!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
|
2005-08-24 21:35:43 +00:00
|
|
|
<!ENTITY GstXMLRegistry SYSTEM "xml/gstxmlregistry.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
|
2005-08-05 10:02:44 +00:00
|
|
|
<!ENTITY GstAdapter SYSTEM "xml/gstadapter.xml">
|
2005-06-24 18:16:14 +00:00
|
|
|
<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
|
|
|
|
|
<!ENTITY GstBaseSink SYSTEM "xml/gstbasesink.xml">
|
2005-06-27 14:40:09 +00:00
|
|
|
<!ENTITY GstBaseTransform SYSTEM "xml/gstbasetransform.xml">
|
2005-08-05 12:59:46 +00:00
|
|
|
<!ENTITY GstCollectPads SYSTEM "xml/gstcollectpads.xml">
|
2005-08-03 13:30:18 +00:00
|
|
|
<!ENTITY GstPushSrc SYSTEM "xml/gstpushsrc.xml">
|
2005-06-24 18:16:14 +00:00
|
|
|
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
|
|
|
|
|
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
|
|
|
|
|
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
|
2005-06-24 18:16:14 +00:00
|
|
|
<!ENTITY GstFileSink SYSTEM "xml/gstfilesink.xml">
|
|
|
|
|
<!--
|
|
|
|
|
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
|
|
|
|
|
<!ENTITY GstFdSink SYSTEM "xml/gstfdsink.xml">
|
|
|
|
|
<!ENTITY GstIdentity SYSTEM "xml/gstidentity.xml">
|
|
|
|
|
<!ENTITY GstPipefilter SYSTEM "xml/gstpipefilter.xml">
|
|
|
|
|
<!ENTITY GstStatistics SYSTEM "xml/gststatistics.xml">
|
|
|
|
|
<!ENTITY GstMD5Sink SYSTEM "xml/gstmd5sink.xml">
|
|
|
|
|
<!ENTITY GstTee SYSTEM "xml/gsttee.xml">
|
2004-07-27 15:01:10 +00:00
|
|
|
-->
|
2004-07-28 11:56:19 +00:00
|
|
|
|
|
|
|
|
<!-- generated by gtkdoc-mkdb, stupid name -->
|
2004-05-14 14:00:04 +00:00
|
|
|
<!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.sgml">
|
2003-06-29 14:05:49 +00:00
|
|
|
|
|
|
|
|
<!ENTITY hash "#">
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
]>
|
2004-12-20 16:25:22 +00:00
|
|
|
<book id="index">
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
<bookinfo>
|
2004-12-20 16:25:22 +00:00
|
|
|
<title>GStreamer &GST_MAJORMINOR; Core Reference Manual</title>
|
2004-07-26 16:34:35 +00:00
|
|
|
<releaseinfo>for GStreamer Core &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
</bookinfo>
|
2002-12-14 16:22:01 +00:00
|
|
|
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
<chapter id="gstreamer">
|
|
|
|
|
<title>GStreamer Core Library</title>
|
|
|
|
|
|
2004-07-21 11:32:09 +00:00
|
|
|
<para>
|
|
|
|
|
libgstreamer-&GST_MAJORMINOR;.so provides all the core GStreamer services,
|
|
|
|
|
including initialization, plugin management and types,
|
|
|
|
|
as well as the object hierarchy that defines elements and bins,
|
|
|
|
|
along with some more specialized elements.
|
|
|
|
|
</para>
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
|
|
|
|
&Gst;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstBin;
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
&GstBuffer;
|
2005-08-23 14:25:55 +00:00
|
|
|
&GstBus;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstCaps;
|
ported gstchildproxy over from 0.8 ported gst-inspect fixes and enhancements over from 0.8
Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* gst/Makefile.am:
* gst/gstbin.c: (gst_bin_get_type),
(gst_bin_child_proxy_get_child_by_index),
(gst_bin_child_proxy_get_children_count),
(gst_bin_child_proxy_init):
* gst/gstchildproxy.c: (gst_child_proxy_get_child_by_name),
(gst_child_proxy_get_child_by_index),
(gst_child_proxy_get_children_count), (gst_child_proxy_lookup),
(gst_child_proxy_get_property), (gst_child_proxy_get_valist),
(gst_child_proxy_get), (gst_child_proxy_set_property),
(gst_child_proxy_set_valist), (gst_child_proxy_set),
(gst_child_proxy_child_added), (gst_child_proxy_child_removed),
(gst_child_proxy_base_init), (gst_child_proxy_get_type):
* gst/gstchildproxy.h:
* gst/parse/grammar.y:
* tools/gst-inspect.c: (print_interfaces),
(print_element_properties_info), (print_element_info):
ported gstchildproxy over from 0.8
ported gst-inspect fixes and enhancements over from 0.8
2005-08-22 21:03:33 +00:00
|
|
|
&GstChildProxy;
|
2001-10-19 22:49:35 +00:00
|
|
|
&GstClock;
|
2004-07-27 15:01:10 +00:00
|
|
|
&GstConfig;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstElement;
|
2004-07-23 15:38:47 +00:00
|
|
|
&GstElementFactory;
|
2004-01-30 19:06:13 +00:00
|
|
|
&GstError;
|
2001-10-19 22:49:35 +00:00
|
|
|
&GstEvent;
|
2004-07-27 15:01:10 +00:00
|
|
|
&GstFilter;
|
2002-12-14 13:02:16 +00:00
|
|
|
&GstFormat;
|
2004-07-26 16:34:35 +00:00
|
|
|
&GstGhostPad;
|
2004-07-27 15:01:10 +00:00
|
|
|
&GstImplementsInterface;
|
2003-01-02 18:56:09 +00:00
|
|
|
&GstIndex;
|
2004-07-26 16:34:35 +00:00
|
|
|
&GstIndexFactory;
|
2005-06-27 14:40:09 +00:00
|
|
|
&GstIterator;
|
2005-08-24 21:35:43 +00:00
|
|
|
&GstMessage;
|
2005-07-11 18:41:49 +00:00
|
|
|
&GstMiniObject;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstObject;
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
&GstPad;
|
2004-07-26 16:34:35 +00:00
|
|
|
&GstPadTemplate;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstParse;
|
|
|
|
|
&GstPipeline;
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
&GstPlugin;
|
2001-10-19 22:49:35 +00:00
|
|
|
&GstPluginFeature;
|
2005-08-24 21:35:43 +00:00
|
|
|
&GstProbe;
|
2002-12-30 17:54:02 +00:00
|
|
|
&GstQuery;
|
2004-05-14 14:00:04 +00:00
|
|
|
&GstQueue;
|
2002-06-12 22:27:18 +00:00
|
|
|
&GstRegistry;
|
2003-02-10 23:01:55 +00:00
|
|
|
&GstRegistryPool;
|
2004-01-30 19:06:13 +00:00
|
|
|
&GstStructure;
|
2002-03-31 14:00:33 +00:00
|
|
|
&GstSystemClock;
|
2004-07-26 16:34:35 +00:00
|
|
|
&GstTagList;
|
2004-07-21 11:32:09 +00:00
|
|
|
&GstTagSetter;
|
2003-10-28 20:25:30 +00:00
|
|
|
&GstTypeFind;
|
2004-07-26 16:34:35 +00:00
|
|
|
&GstTypeFindFactory;
|
2004-07-27 15:01:10 +00:00
|
|
|
&GstTypes;
|
2004-07-26 16:34:35 +00:00
|
|
|
&GstUriHandler;
|
2004-07-27 15:01:10 +00:00
|
|
|
&GstUriType;
|
2005-09-05 09:38:38 +00:00
|
|
|
&GstUtils;
|
2004-01-30 19:06:13 +00:00
|
|
|
&GstValue;
|
2004-07-27 15:01:10 +00:00
|
|
|
&GstVersion;
|
2001-01-31 20:27:00 +00:00
|
|
|
&GstXML;
|
2005-08-24 21:35:43 +00:00
|
|
|
&GstXMLRegistry;
|
2000-11-07 21:18:52 +00:00
|
|
|
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
</chapter>
|
|
|
|
|
|
2004-01-28 14:33:59 +00:00
|
|
|
<chapter id="gstreamer-support">
|
|
|
|
|
<title>GStreamer Core Support</title>
|
|
|
|
|
<para>
|
2005-09-02 16:17:23 +00:00
|
|
|
Theses modules support the gstreamer core and plugin development.
|
|
|
|
|
Application developers will rarely need to know about it.
|
2005-08-31 14:08:45 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
&GstCheck;
|
|
|
|
|
&GstInfo;
|
2005-09-02 16:17:23 +00:00
|
|
|
&GstMacros;
|
|
|
|
|
&GstMemChunk;
|
2005-08-31 14:08:45 +00:00
|
|
|
&GstTrace;
|
2005-09-07 13:22:16 +00:00
|
|
|
&GstTrashStack;
|
2005-08-31 14:08:45 +00:00
|
|
|
|
|
|
|
|
</chapter>
|
|
|
|
|
|
2005-06-27 14:40:09 +00:00
|
|
|
<!--
|
2004-07-27 15:01:10 +00:00
|
|
|
<chapter id="gstreamer-compat">
|
|
|
|
|
<title>GStreamer Core Compatibility</title>
|
|
|
|
|
<para>
|
2005-06-24 18:16:14 +00:00
|
|
|
These elements are defined for compatibility with older code.
|
|
|
|
|
They must not be used in new code!
|
2004-07-27 15:01:10 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
&GstCompat;
|
|
|
|
|
|
|
|
|
|
</chapter>
|
2005-06-27 14:40:09 +00:00
|
|
|
-->
|
2004-07-27 15:01:10 +00:00
|
|
|
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
<chapter id="element-types">
|
2005-06-24 18:16:14 +00:00
|
|
|
<title>GStreamer Core Elements</title>
|
2000-03-27 19:53:43 +00:00
|
|
|
|
|
|
|
|
<para>
|
2005-06-24 18:16:14 +00:00
|
|
|
libgstelements.so provide some basic elements like a file source
|
2001-10-24 21:44:48 +00:00
|
|
|
and sink. The use of these elements is strictly though the g_object_get() and
|
|
|
|
|
g_object_set() functions and the GStreamer Core Library functions.
|
2000-03-27 19:53:43 +00:00
|
|
|
</para>
|
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstFakeSrc;
|
|
|
|
|
&GstFakeSink;
|
2001-12-12 06:08:44 +00:00
|
|
|
&GstFileSrc;
|
2005-06-24 18:16:14 +00:00
|
|
|
&GstFileSink;
|
|
|
|
|
<!--
|
|
|
|
|
|
|
|
|
|
&GstAggregator;
|
2001-04-22 16:04:19 +00:00
|
|
|
|
2000-10-22 16:27:21 +00:00
|
|
|
&GstFdSrc;
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstFdSink;
|
|
|
|
|
|
2000-09-13 19:04:55 +00:00
|
|
|
&GstPipefilter;
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstIdentity;
|
2000-10-22 16:27:21 +00:00
|
|
|
|
2001-12-09 13:17:13 +00:00
|
|
|
&GstStatistics;
|
2002-03-31 14:00:33 +00:00
|
|
|
&GstMD5Sink;
|
2001-12-09 13:17:13 +00:00
|
|
|
|
2001-01-19 22:15:21 +00:00
|
|
|
&GstTee;
|
2005-06-24 18:16:14 +00:00
|
|
|
-->
|
|
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter id="gstreamer-base">
|
2005-09-07 13:22:16 +00:00
|
|
|
<title>GStreamer Base and Utillity Classes</title>
|
2005-06-24 18:16:14 +00:00
|
|
|
<para>
|
ported gstchildproxy over from 0.8 ported gst-inspect fixes and enhancements over from 0.8
Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* gst/Makefile.am:
* gst/gstbin.c: (gst_bin_get_type),
(gst_bin_child_proxy_get_child_by_index),
(gst_bin_child_proxy_get_children_count),
(gst_bin_child_proxy_init):
* gst/gstchildproxy.c: (gst_child_proxy_get_child_by_name),
(gst_child_proxy_get_child_by_index),
(gst_child_proxy_get_children_count), (gst_child_proxy_lookup),
(gst_child_proxy_get_property), (gst_child_proxy_get_valist),
(gst_child_proxy_get), (gst_child_proxy_set_property),
(gst_child_proxy_set_valist), (gst_child_proxy_set),
(gst_child_proxy_child_added), (gst_child_proxy_child_removed),
(gst_child_proxy_base_init), (gst_child_proxy_get_type):
* gst/gstchildproxy.h:
* gst/parse/grammar.y:
* tools/gst-inspect.c: (print_interfaces),
(print_element_properties_info), (print_element_info):
ported gstchildproxy over from 0.8
ported gst-inspect fixes and enhancements over from 0.8
2005-08-22 21:03:33 +00:00
|
|
|
libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
|
2005-09-07 13:22:16 +00:00
|
|
|
by elements and utillity classes that are most useful for plugin developers.
|
2005-06-24 18:16:14 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
&GstBaseSrc;
|
|
|
|
|
&GstBaseSink;
|
2005-06-27 14:40:09 +00:00
|
|
|
&GstBaseTransform;
|
2005-08-05 10:02:44 +00:00
|
|
|
&GstPushSrc;
|
2005-06-24 18:16:14 +00:00
|
|
|
|
2005-09-07 13:22:16 +00:00
|
|
|
&GstAdapter;
|
|
|
|
|
&GstCollectPads;
|
|
|
|
|
|
2000-03-27 19:53:43 +00:00
|
|
|
</chapter>
|
|
|
|
|
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2004-06-24 23:05:04 +00:00
|
|
|
<chapter id="gstreamer-hierarchy">
|
2004-05-14 14:00:04 +00:00
|
|
|
<title>Object Hierarchy</title>
|
|
|
|
|
&gstreamer-tree-index;
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
</chapter>
|
2004-05-14 14:00:04 +00:00
|
|
|
|
2004-07-15 13:20:54 +00:00
|
|
|
<index id="api-index">
|
2005-08-11 17:39:48 +00:00
|
|
|
<title>Index</title>
|
|
|
|
|
</index>
|
|
|
|
|
<index role="deprecated">
|
|
|
|
|
<title>Index of deprecated symbols</title>
|
|
|
|
|
</index>
|
2005-08-26 12:48:29 +00:00
|
|
|
<!-- disable, as
|
|
|
|
|
- index generation is extremly slow in gtk-doc
|
|
|
|
|
- we have not tagged lots of symbols thsi way anyway
|
2005-08-11 17:39:48 +00:00
|
|
|
<index role="0.8">
|
|
|
|
|
<title>Index of new symbols in 0.8</title>
|
|
|
|
|
</index>
|
|
|
|
|
<index role="0.9">
|
|
|
|
|
<title>Index of new symbols in 0.9</title>
|
2004-07-15 13:20:54 +00:00
|
|
|
</index>
|
2005-08-26 12:48:29 +00:00
|
|
|
-->
|
2004-05-14 14:00:04 +00:00
|
|
|
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
</book>
|
