gstreamer/docs/libs/gstreamer-libs-docs.sgml
Sebastian Dröge 286cd75855 libs/gst/controller/: API: Refactor GstController into the core controller which can take a GstControlSource for prov...
Original commit message from CVS:
Reviewed by: Stefan Kost <ensonic@users.sf.net>
* libs/gst/controller/Makefile.am:
* libs/gst/controller/gstcontroller.c:
(gst_controlled_property_add_interpolation_control_source),
(gst_controlled_property_new), (gst_controlled_property_free),
(gst_controller_find_controlled_property),
(gst_controller_new_valist), (gst_controller_new_list),
(gst_controller_new), (gst_controller_remove_properties_valist),
(gst_controller_remove_properties_list),
(gst_controller_remove_properties),
(gst_controller_set_property_disabled),
(gst_controller_set_disabled), (gst_controller_set_control_source),
(gst_controller_get_control_source), (gst_controller_get),
(gst_controller_sync_values), (gst_controller_get_value_array),
(_gst_controller_dispose), (gst_controller_get_type),
(gst_controlled_property_set_interpolation_mode),
(gst_controller_set), (gst_controller_set_from_list),
(gst_controller_unset), (gst_controller_unset_all),
(gst_controller_get_all), (gst_controller_set_interpolation_mode):
* libs/gst/controller/gstcontroller.h:
* libs/gst/controller/gstcontrollerprivate.h:
* libs/gst/controller/gstcontrolsource.c:
(gst_control_source_class_init), (gst_control_source_init),
(gst_control_source_get_value),
(gst_control_source_get_value_array), (gst_control_source_bind):
* libs/gst/controller/gstcontrolsource.h:
* libs/gst/controller/gsthelper.c: (gst_object_set_control_source),
(gst_object_get_control_source):
* libs/gst/controller/gstinterpolation.c:
(gst_interpolation_control_source_find_control_point_node),
(gst_interpolation_control_source_get_first_value),
(_interpolate_none_get), (interpolate_none_get),
(interpolate_none_get_boolean_value_array),
(interpolate_none_get_enum_value_array),
(interpolate_none_get_string_value_array),
(_interpolate_trigger_get), (interpolate_trigger_get),
(interpolate_trigger_get_boolean_value_array),
(interpolate_trigger_get_enum_value_array),
(interpolate_trigger_get_string_value_array):
* libs/gst/controller/gstinterpolationcontrolsource.c:
(gst_control_point_free), (gst_interpolation_control_source_reset),
(gst_interpolation_control_source_new),
(gst_interpolation_control_source_set_interpolation_mode),
(gst_interpolation_control_source_bind),
(gst_control_point_compare), (gst_control_point_find),
(gst_interpolation_control_source_set_internal),
(gst_interpolation_control_source_set),
(gst_interpolation_control_source_set_from_list),
(gst_interpolation_control_source_unset),
(gst_interpolation_control_source_unset_all),
(gst_interpolation_control_source_get_all),
(gst_interpolation_control_source_get_count),
(gst_interpolation_control_source_init),
(gst_interpolation_control_source_finalize),
(gst_interpolation_control_source_dispose),
(gst_interpolation_control_source_class_init):
* libs/gst/controller/gstinterpolationcontrolsource.h:
* libs/gst/controller/gstinterpolationcontrolsourceprivate.h:
API: Refactor GstController into the core controller which can take
a GstControlSource for providing actual values for timestamps.
Implement a interpolation control source and use this for backward
compatibility, deprecate a bunch of functions that are now handled
by GstControlSource or GstInterpolationControlSource.
Make it possible to disable the controller completely or only for
specific properties. Fixes #450711.
* docs/libs/gstreamer-libs-docs.sgml:
* docs/libs/gstreamer-libs-sections.txt:
* docs/libs/gstreamer-libs.types:
Add new functions and classes to the docs.
* tests/check/libs/controller.c: (GST_START_TEST),
(gst_controller_suite):
* tests/examples/controller/audio-example.c: (main):
Port unit test and example to the new API and add some new
unit tests.
2007-07-06 21:50:02 +00:00

126 lines
3.9 KiB
XML

<?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" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
<!ENTITY GstAdapter SYSTEM "xml/gstadapter.xml">
<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
<!ENTITY GstBaseSink SYSTEM "xml/gstbasesink.xml">
<!ENTITY GstBaseTransform SYSTEM "xml/gstbasetransform.xml">
<!ENTITY GstCollectPads SYSTEM "xml/gstcollectpads.xml">
<!ENTITY GstPushSrc SYSTEM "xml/gstpushsrc.xml">
<!ENTITY GstTypeFindHelper SYSTEM "xml/gsttypefindhelper.xml">
<!ENTITY GstDataQueue SYSTEM "xml/gstdataqueue.xml">
<!ENTITY GstCheck SYSTEM "xml/gstcheck.xml">
<!ENTITY GstCheckBufferStraw SYSTEM "xml/gstcheckbufferstraw.xml">
<!ENTITY GstController SYSTEM "xml/gstcontroller.xml">
<!ENTITY GstControlSource SYSTEM "xml/gstcontrolsource.xml">
<!ENTITY GstInterpolationControlSource SYSTEM "xml/gstinterpolationcontrolsource.xml">
<!ENTITY GstControllerGObject SYSTEM "xml/gstcontrollergobject.xml">
<!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
<!ENTITY GstNetClientClock SYSTEM "xml/gstnetclientclock.xml">
<!ENTITY GstNetTimePacket SYSTEM "xml/gstnettimepacket.xml">
<!ENTITY GstNetTimeProvider SYSTEM "xml/gstnettimeprovider.xml">
<!-- generated by gtkdoc-mkdb -->
<!ENTITY gstreamer-libs-tree-index SYSTEM "xml/tree_index.sgml">
<!ENTITY hash "#">
]>
<book id="index">
<bookinfo>
<title>GStreamer &GST_MAJORMINOR; Library Reference Manual</title>
<releaseinfo>for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
</bookinfo>
<part id="gstreamer-libs">
<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>
<chapter id="gstreamer-base">
<title>GStreamer Base and Utillity Classes</title>
<para>
libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
by elements and utillity classes that are most useful for plugin developers.
</para>
&GstBaseSrc;
&GstBaseSink;
&GstBaseTransform;
&GstPushSrc;
&GstAdapter;
&GstCollectPads;
&GstTypeFindHelper;
&GstDataQueue;
</chapter>
<chapter id="gstreamer-control">
<title>GStreamer Dynamic Parameter Control</title>
&GstController;
&GstControlSource;
&GstInterpolationControlSource;
&GstControllerGObject;
</chapter>
<chapter id="gstreamer-dataprotocol">
<title>GStreamer Data Protocol</title>
&GstDataProtocol;
</chapter>
<chapter id="gstreamer-net">
<title>GStreamer Network Classes</title>
<para>
libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
</para>
&GstNetClientClock;
&GstNetTimePacket;
&GstNetTimeProvider;
</chapter>
<chapter id="gstreamer-check">
<title>GStreamer Check Unit Testing</title>
<para>
libgstcheck-&GST_MAJORMINOR;.so provides functionality for writing
unit tests that use the check framework.
</para>
&GstCheck;
&GstCheckBufferStraw;
</chapter>
</part>
<part id="gstreamer-libs-hierarchy">
<title>Object Hierarchy</title>
&gstreamer-libs-tree-index;
</part>
<index id="api-index">
<title>Index</title>
</index>
<index role="deprecated">
<title>Index of deprecated symbols</title>
</index>
<!-- disable, as
- index generation is extremly slow in gtk-doc
- we have not tagged lots of symbols thsi way anyway
<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>
</index>
-->
</book>