Commit 646ca1ed authored by Stefan Kost's avatar Stefan Kost
Browse files

now the api-index has a title in devhelp added more docs for the...

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
parent 0b2f7130
......@@ -162,6 +162,8 @@ with some more specialized elements.</para>
&gstreamer-tree-index;
</chapter>
<index id="symbol-index"/>
<index id="api-index">
<title>API Index</title>
</index>
</book>
......@@ -76,6 +76,8 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstElement::error ##### -->
......@@ -83,6 +85,11 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@:
@:
@gstelement: the object which received the signal.
@arg1:
@arg2:
......@@ -93,6 +100,10 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@:
@gstelement: the object which received the signal.
@arg1:
@arg2:
......@@ -102,6 +113,9 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@gstelement: the object which received the signal.
@arg1:
......@@ -110,6 +124,8 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
......@@ -117,6 +133,9 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@gstelement: the object which received the signal.
@arg1:
......@@ -125,6 +144,10 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@:
@gstelement: the object which received the signal.
@arg1:
@arg2:
......
......@@ -127,58 +127,58 @@ template.
</para>
@:
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstElement::error ##### -->
<para>
</para>
@:
@:
@:
@:
@gstelement: the object which received the signal.
@arg1:
@arg2:
@arg3:
<!-- ##### SIGNAL GstElement::found-tag ##### -->
<para>
</para>
@:
@:
@:
@gstelement: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GstElement::new-pad ##### -->
<para>
</para>
@:
@:
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::no-more-pads ##### -->
<para>
</para>
@:
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
<para>
</para>
@:
@:
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::state-change ##### -->
<para>
</para>
@:
@:
@:
@gstelement: the object which received the signal.
@arg1:
@arg2:
<!-- ##### STRUCT GstElementClass ##### -->
<para>
......
......@@ -10,6 +10,8 @@
<!ENTITY GstControl SYSTEM "xml/gstcontrol.xml">
<!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
<!ENTITY gstlibs-tree-index SYSTEM "xml/tree_index.sgml">
<!ENTITY hash "#">
]>
<book>
......@@ -35,6 +37,13 @@
</chapter>
<index id="symbol-index"/>
<chapter id="gstreamer-libs-hierarchy">
<title>Object Hierarchy</title>
&gstlibs-tree-index;
</chapter>
<index id="api-index">
<title>API Index</title>
</index>
</book>
......@@ -128,4 +128,5 @@ gst_dparam_new
gst_dparam_attach
gst_dparam_detach
gst_dparam_do_update_default
gst_dpsmooth_new
</SECTION>
......@@ -259,3 +259,12 @@ The next step is to get hold of the GstDParamManager instance of a GstElement.
@update_info:
<!-- ##### FUNCTION gst_dpsmooth_new ##### -->
<para>
</para>
@type:
@Returns:
$Id$
* cleanup of dparams
* resolve g_return_if_fail() into GST_WARNING and return()
in cases where the caller has to handle the problem
* rename
GST_TYPE_DPSMOOTH to GST_TYPE_DPARAM_SMOOTH
GST_TYPE_DP_LININT to GST_TYPE_DPARAM_LININT
there seems to be nobody using them, as they still look unfinished
* concept for global, voice params
......@@ -245,6 +245,17 @@ gst_dparam_set_property (GObject * object, guint prop_id, const GValue * value,
GST_DPARAM_UNLOCK (dparam);
}
/**
* gst_dparam_do_update_default:
* @dparam:
* @timestamp:
* @value:
* @update_info:
*
* Default implementation for changing a dynamic parameter.
* Subclasses might overwrite the behaviour of this.
*
*/
void
gst_dparam_do_update_default (GstDParam * dparam, gint64 timestamp,
GValue * value, GstDParamUpdateInfo update_info)
......
......@@ -134,6 +134,8 @@ gst_dpsmooth_init (GstDParamSmooth * dpsmooth)
* gst_dpsmooth_new:
* @type: the type that this dparam will store
*
* Create a new dynamic parameter controller which smoothes control changes.
*
* Returns: a new instance of GstDParam
*/
GstDParam *
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment