gstreamer/docs/libs/tmpl/gstcontrol.sgml
Thomas Vander Stichele 2270883f00 various doc and style fixes, adding bytestream
Original commit message from CVS:
various doc and style fixes, adding bytestream
2004-07-28 14:39:44 +00:00

270 lines
3.3 KiB
Text

<!-- ##### SECTION Title ##### -->
gstcontrol
<!-- ##### SECTION Short_Description ##### -->
dynamic parameter functionality.
<!-- ##### SECTION Long_Description ##### -->
<para>
This library provides a Manager that maintains a list of dynamically
controlable parameters for a GstElement.
Just think of a volume slider in a mixer.
</para>
<para>
To use this library one needs to add some code to initialize it.
<example>
<title>Adding the control library to a project</title>
<programlisting>
...
&hash;include &lt;gst/gst.h&gt;
&hash;include &lt;gst/control/control.h&gt;
...
gst_init(&amp;argc,&amp;argv);
gst_control_init(&amp;argc,&amp;argv);
...
</programlisting>
</example>
The next step is to get hold of the GstDParamManager instance of a GstElement.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_control_init ##### -->
<para>
</para>
@argc:
@argv:
<!-- ##### FUNCTION gst_dpman_new ##### -->
<para>
</para>
@name:
@parent:
@Returns:
<!-- ##### FUNCTION gst_dpman_add_required_dparam_callback ##### -->
<para>
</para>
@dpman:
@param_spec:
@unit_name:
@update_func:
@update_data:
@Returns:
<!-- ##### FUNCTION gst_dpman_add_required_dparam_direct ##### -->
<para>
</para>
@dpman:
@param_spec:
@unit_name:
@update_data:
@Returns:
<!-- ##### FUNCTION gst_dpman_add_required_dparam_array ##### -->
<para>
</para>
@dpman:
@param_spec:
@unit_name:
@update_data:
@Returns:
<!-- ##### FUNCTION gst_dpman_remove_required_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
<!-- ##### FUNCTION gst_dpman_attach_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
@dparam:
@Returns:
<!-- ##### FUNCTION gst_dpman_detach_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
<!-- ##### FUNCTION gst_dpman_get_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
@Returns:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gst_dpman_get_dparam_type ##### -->
<para>
</para>
@dpman:
@dparam_name:
@Returns:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gst_dpman_list_dparam_specs ##### -->
<para>
</para>
@dpman:
@Returns:
<!-- ##### FUNCTION gst_dpman_get_param_spec ##### -->
<para>
</para>
@dpman:
@dparam_name:
@Returns:
<!-- ##### FUNCTION gst_dpman_set_rate ##### -->
<para>
</para>
@dpman:
@rate:
<!-- ##### FUNCTION gst_dpman_register_mode ##### -->
<para>
</para>
@klass:
@modename:
@preprocessfunc:
@processfunc:
@setupfunc:
@teardownfunc:
<!-- ##### FUNCTION gst_dpman_set_mode ##### -->
<para>
</para>
@dpman:
@modename:
@Returns:
<!-- ##### FUNCTION gst_dpman_set_parent ##### -->
<para>
</para>
@dpman:
@parent:
<!-- ##### FUNCTION gst_dpman_get_manager ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_dpman_bypass_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
<!-- ##### FUNCTION gst_dparam_new ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION gst_dparam_attach ##### -->
<para>
</para>
@dparam:
@manager:
@param_spec:
@unit_name:
<!-- ##### FUNCTION gst_dparam_detach ##### -->
<para>
</para>
@dparam:
<!-- ##### FUNCTION gst_dparam_do_update_default ##### -->
<para>
</para>
@dparam:
@timestamp:
@value:
@update_info:
<!-- ##### FUNCTION gst_dpsmooth_new ##### -->
<para>
</para>
@type:
@Returns: