mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-25 09:40:37 +00:00
646ca1edbe
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
270 lines
3.3 KiB
Text
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 <gst/gst.h>
|
|
&hash;include <gst/control/control.h>
|
|
...
|
|
gst_init(&argc,&argv);
|
|
gst_control_init(&argc,&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:
|
|
|
|
|