mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-17 05:46:36 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/libs/gstreamer-libs-docs.sgml

113 lines
4.2 KiB
Text
Raw Normal View History

converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
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" [
fix distcheck Original commit message from CVS: fix distcheck
2004-05-20 12:40:31 +00:00
<!ENTITY % version-entities SYSTEM "version.entities">
version API docs Original commit message from CVS: version API docs
2004-02-12 17:23:37 +00:00
%version-entities;
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
added some long description to gstcontrol Original commit message from CVS: added some long description to gstcontrol
2004-07-14 14:57:53 +00:00
<!ENTITY hash "#">
Documentation updates documented the libraries Original commit message from CVS: Documentation updates documented the libraries
2000-10-22 16:27:21 +00:00
]>
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
Documentation updates documented the libraries Original commit message from CVS: Documentation updates documented the libraries
2000-10-22 16:27:21 +00:00
<bookinfo>
gst: Change versioning Remove GST_MAJORMINOR and replace it by GST_API_VERSION Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely now. All versions are at 1.0.0 now for the release soon but API/ABI can still change until the 1.0.0 release. Next release versions until 1.0.0 will be 0.10.9X and these will be release candidates. GST_VERSION_* will nonetheless stay at 1.0.0.0.
2012-04-04 11:13:52 +00:00
<title>GStreamer &GST_API_VERSION; Library Reference Manual</title>
docs/: Remove cruft and do some cleanups. Original commit message from CVS: * docs/gst/Makefile.am: * docs/libs/Makefile.am: Remove cruft and do some cleanups. * docs/gst/gstreamer-docs.sgml: * docs/libs/gstreamer-libs-docs.sgml: Prepare for comming gtkdoc features (rebase against online docs).
2007-08-10 17:35:30 +00:00
<releaseinfo>
gst: Change versioning Remove GST_MAJORMINOR and replace it by GST_API_VERSION Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely now. All versions are at 1.0.0 now for the release soon but API/ABI can still change until the 1.0.0 release. Next release versions until 1.0.0 will be 0.10.9X and these will be release candidates. GST_VERSION_* will nonetheless stay at 1.0.0.0.
2012-04-04 11:13:52 +00:00
for GStreamer Library &GST_API_VERSION; (&GST_VERSION;)
Add releaseinfo with online url.
2009-01-30 20:18:17 +00:00
The latest version of this documentation can be found on-line at
docs/: Remove cruft and do some cleanups. Original commit message from CVS: * docs/gst/Makefile.am: * docs/libs/Makefile.am: Remove cruft and do some cleanups. * docs/gst/gstreamer-docs.sgml: * docs/libs/gstreamer-libs-docs.sgml: Prepare for comming gtkdoc features (rebase against online docs).
2007-08-10 17:35:30 +00:00
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/</ulink>.
</releaseinfo>
Documentation updates documented the libraries Original commit message from CVS: Documentation updates documented the libraries
2000-10-22 16:27:21 +00:00
</bookinfo>
restructured DParam docs added some thoughts about dparams ng Original commit message from CVS: restructured DParam docs added some thoughts about dparams ng
2005-01-26 15:15:26 +00:00
<part id="gstreamer-libs">
Documentation updates documented the libraries Original commit message from CVS: Documentation updates documented the libraries
2000-10-22 16:27:21 +00:00
<title>GStreamer Libraries</title>
<para>
To ease the creation of plugins, a library system was created. The most common
functions for a plugin can be found in a library.
</para>
<para>
GStreamer provides some standard libraries you can use to create plugins.
</para>
added controller code removed dparam pc files Original commit message from CVS: added controller code removed dparam pc files
2005-08-02 21:35:34 +00:00
docs/: moving documentation from core to lib Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/libs/gstreamer-libs-docs.sgml: * docs/libs/gstreamer-libs-sections.txt: moving documentation from core to lib
2005-11-29 19:34:24 +00:00
<chapter id="gstreamer-base">
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
<title>GStreamer Base and Utillity Classes</title>
<para>
gst: Change versioning Remove GST_MAJORMINOR and replace it by GST_API_VERSION Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely now. All versions are at 1.0.0 now for the release soon but API/ABI can still change until the 1.0.0 release. Next release versions until 1.0.0 will be 0.10.9X and these will be release candidates. GST_VERSION_* will nonetheless stay at 1.0.0.0.
2012-04-04 11:13:52 +00:00
libgstbase-&GST_API_VERSION;.so provides some base classes to be extended
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
by elements and utillity classes that are most useful for plugin developers.
</para>
docs/: Remove cruft and do some cleanups. Original commit message from CVS: * docs/gst/Makefile.am: * docs/libs/Makefile.am: Remove cruft and do some cleanups. * docs/gst/gstreamer-docs.sgml: * docs/libs/gstreamer-libs-docs.sgml: Prepare for comming gtkdoc features (rebase against online docs).
2007-08-10 17:35:30 +00:00
baseparse: add to docs and fix up gtk-doc markup a little And add Since markers.
2011-03-31 14:50:22 +00:00
<xi:include href="xml/gstbaseparse.xml" />
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<xi:include href="xml/gstbasesrc.xml" />
<xi:include href="xml/gstbasesink.xml" />
<xi:include href="xml/gstbasetransform.xml" />
<xi:include href="xml/gstpushsrc.xml" />
<xi:include href="xml/gstadapter.xml" />
<xi:include href="xml/gstbitreader.xml" />
<xi:include href="xml/gstbytereader.xml" />
bytewriter: Add to the docs
2009-10-07 16:37:28 +00:00
<xi:include href="xml/gstbytewriter.xml" />
collectpads2: rename to collectpads
2012-04-17 12:38:01 +00:00
<xi:include href="xml/gstcollectpads.xml" />
docs: add GstFlowCombiner
2014-05-27 09:05:51 +00:00
<xi:include href="xml/gstflowcombiner.xml" />
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<xi:include href="xml/gsttypefindhelper.xml" />
dataqueue/queuearray: Make public API again These are actually used outside of coreelements nowadays. Also hide lots of internals and add padding and documentation.
2012-10-22 08:13:20 +00:00
<xi:include href="xml/gstdataqueue.xml" />
<xi:include href="xml/gstqueuearray.xml" />
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
</chapter>
docs/: moving documentation from core to lib Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/libs/gstreamer-libs-docs.sgml: * docs/libs/gstreamer-libs-sections.txt: moving documentation from core to lib
2005-11-29 19:34:24 +00:00
added controller code removed dparam pc files Original commit message from CVS: added controller code removed dparam pc files
2005-08-02 21:35:34 +00:00
<chapter id="gstreamer-control">
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
<title>GStreamer Dynamic Parameter Control</title>
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<para>
gst: Change versioning Remove GST_MAJORMINOR and replace it by GST_API_VERSION Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely now. All versions are at 1.0.0 now for the release soon but API/ABI can still change until the 1.0.0 release. Next release versions until 1.0.0 will be 0.10.9X and these will be release candidates. GST_VERSION_* will nonetheless stay at 1.0.0.0.
2012-04-04 11:13:52 +00:00
libgstcontroller-&GST_API_VERSION;.so provides functionality to animate
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
element properties over time.
</para>
docs: update the controller docs Add the control bindings to the docs. Add a little more detail.
2013-02-01 20:59:41 +00:00
<xi:include href="xml/gstargbcontrolbinding.xml" />
<xi:include href="xml/gstdirectcontrolbinding.xml" />
controlsources: refactor interpolation control source Move most of the code to a GstTimedValueControlSource. Split out the trigger 'interpolation mode' to a new control source class. Move tests and examples to new api. Update docs. Fixes #610338
2011-12-19 10:13:45 +00:00
<xi:include href="xml/gsttimedvaluecontrolsource.xml" />
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<xi:include href="xml/gstinterpolationcontrolsource.xml" />
<xi:include href="xml/gstlfocontrolsource.xml" />
controlsources: refactor interpolation control source Move most of the code to a GstTimedValueControlSource. Split out the trigger 'interpolation mode' to a new control source class. Move tests and examples to new api. Update docs. Fixes #610338
2011-12-19 10:13:45 +00:00
<xi:include href="xml/gsttriggercontrolsource.xml" />
added controller code removed dparam pc files Original commit message from CVS: added controller code removed dparam pc files
2005-08-02 21:35:34 +00:00
</chapter>
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
<chapter id="gstreamer-net">
<title>GStreamer Network Classes</title>
<para>
gst: Change versioning Remove GST_MAJORMINOR and replace it by GST_API_VERSION Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely now. All versions are at 1.0.0 now for the release soon but API/ABI can still change until the 1.0.0 release. Next release versions until 1.0.0 will be 0.10.9X and these will be release candidates. GST_VERSION_* will nonetheless stay at 1.0.0.0.
2012-04-04 11:13:52 +00:00
libgstnet-&GST_API_VERSION;.so provides network elements and objects.
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
</para>
docs/: Remove cruft and do some cleanups. Original commit message from CVS: * docs/gst/Makefile.am: * docs/libs/Makefile.am: Remove cruft and do some cleanups. * docs/gst/gstreamer-docs.sgml: * docs/libs/gstreamer-libs-docs.sgml: Prepare for comming gtkdoc features (rebase against online docs).
2007-08-10 17:35:30 +00:00
docs: Fix documentation typos and inconsistencies * GstGlobalDeviceMonitor was renamed to GstDeviceMonitor * Expand GST_MESSAGE_DEVICE to the full enum value names * Correct the incorrect references to the GstDeviceProvider interfaces * Describe caps arguments for gstcheck interface * Add missing docs for GstNetAddressMeta and its add function * Add docs for toc helper macros * Avoid refering to GstValueList type as done elsewhere Fixes https://bugzilla.gnome.org/show_bug.cgi?id=732786
2014-07-05 16:29:29 +00:00
<xi:include href="xml/gstnetaddressmeta.xml" />
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<xi:include href="xml/gstnetclientclock.xml" />
<xi:include href="xml/gstnettimepacket.xml" />
<xi:include href="xml/gstnettimeprovider.xml" />
ptp: Initial implementation of a PTP clock GstPtpClock implements a PTP (IEEE1588:2008) ordinary clock in slave-only mode, that allows a GStreamer pipeline to synchronize to a PTP network clock in some specific domain. The PTP subsystem can be initialized with gst_ptp_init(), which then starts a helper process to do the actual communication via the PTP ports. This is required as PTP listens on ports < 1024 and thus requires special privileges. Once this helper process is started, the main process will synchronize to all PTP domains that are detected on the selected interfaces. gst_ptp_clock_new() then allows to create a GstClock that provides the PTP time from a master clock inside a specific PTP domain. This clock will only return valid timestamps once the timestamps in the PTP domain are known. To check this, the GstPtpClock::internal-clock property and the related notify::clock signal can be used. Once the internal clock is not NULL, the PTP domain's time is known. Alternatively you can wait for this with gst_ptp_clock_wait_ready(). To gather statistics about the PTP clock synchronization, gst_ptp_statistics_callback_add() can be used. This gives the application the possibility to collect all kinds of statistics from the clock synchronization. https://bugzilla.gnome.org/show_bug.cgi?id=749391
2015-05-14 10:18:25 +00:00
<xi:include href="xml/gstptpclock.xml" />
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
</chapter>
docs/: Remove cruft and do some cleanups. Original commit message from CVS: * docs/gst/Makefile.am: * docs/libs/Makefile.am: Remove cruft and do some cleanups. * docs/gst/gstreamer-docs.sgml: * docs/libs/gstreamer-libs-docs.sgml: Prepare for comming gtkdoc features (rebase against online docs).
2007-08-10 17:35:30 +00:00
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
<chapter id="gstreamer-check">
<title>GStreamer Check Unit Testing</title>
<para>
gst: Change versioning Remove GST_MAJORMINOR and replace it by GST_API_VERSION Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely now. All versions are at 1.0.0 now for the release soon but API/ABI can still change until the 1.0.0 release. Next release versions until 1.0.0 will be 0.10.9X and these will be release candidates. GST_VERSION_* will nonetheless stay at 1.0.0.0.
2012-04-04 11:13:52 +00:00
libgstcheck-&GST_API_VERSION;.so provides functionality for writing
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
unit tests that use the check framework.
</para>
docs/: Remove cruft and do some cleanups. Original commit message from CVS: * docs/gst/Makefile.am: * docs/libs/Makefile.am: Remove cruft and do some cleanups. * docs/gst/gstreamer-docs.sgml: * docs/libs/gstreamer-libs-docs.sgml: Prepare for comming gtkdoc features (rebase against online docs).
2007-08-10 17:35:30 +00:00
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<xi:include href="xml/gstcheck.xml" />
<xi:include href="xml/gstcheckbufferstraw.xml" />
docs: add missing section to libs-docs
2009-11-27 14:39:01 +00:00
<xi:include href="xml/gstcheckconsistencychecker.xml" />
check: add GstTestClock as a deterministic clock for testing API: GstTestClock API: gst_test_clock_new() API: gst_test_clock_new_with_start_time() API: gst_test_clock_set_time() API: gst_test_clock_advance_time() https://bugzilla.gnome.org/show_bug.cgi?id=683012
2012-08-29 14:11:10 +00:00
<xi:include href="xml/gsttestclock.xml" />
docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent Original commit message from CVS: * docs/libs/gstreamer-libs-docs.sgml: reorder (put dp into a chapter) and indent
2006-06-11 17:03:06 +00:00
</chapter>
restructured DParam docs added some thoughts about dparams ng Original commit message from CVS: restructured DParam docs added some thoughts about dparams ng
2005-01-26 15:15:26 +00:00
</part>
Documentation updates documented the libraries Original commit message from CVS: Documentation updates documented the libraries
2000-10-22 16:27:21 +00:00
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<chapter id="gstreamer-hierarchy">
now the api-index has a title in devhelp added more docs for the control-library added personal thoughs/todo to docs/... Original commit message from CVS: now the api-index has a title in devhelp added more docs for the control-library added personal thoughs/todo to docs/random
2004-07-15 13:20:54 +00:00
<title>Object Hierarchy</title>
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<xi:include href="xml/tree_index.sgml"/>
</chapter>
now the api-index has a title in devhelp added more docs for the control-library added personal thoughs/todo to docs/... Original commit message from CVS: now the api-index has a title in devhelp added more docs for the control-library added personal thoughs/todo to docs/random
2004-07-15 13:20:54 +00:00
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
added deprecation and since indexes added since tags Original commit message from CVS: added deprecation and since indexes added since tags
2005-08-11 17:39:48 +00:00
</index>
docs/: Change to xinclude based build - its faster and easier to maintain. Original commit message from CVS: * docs/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/running.xml: * docs/libs/gstreamer-libs-docs.sgml: Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
<index id="api-index-deprecated" role="deprecated">
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
now the api-index has a title in devhelp added more docs for the control-library added personal thoughs/todo to docs/... Original commit message from CVS: now the api-index has a title in devhelp added more docs for the control-library added personal thoughs/todo to docs/random
2004-07-15 13:20:54 +00:00
</index>
added symbol index to the libs-docs Original commit message from CVS: added symbol index to the libs-docs
2004-07-15 12:51:03 +00:00
docs: include annotation glossary to have working links.
2009-10-28 08:15:12 +00:00
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
Documentation updates documented the libraries Original commit message from CVS: Documentation updates documented the libraries
2000-10-22 16:27:21 +00:00
</book>
Reference in a new issue Copy permalink