mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-22 08:17:01 +00:00
43a01f1a67
Original commit message from CVS: more docs for the state of dparams
217 lines
2.8 KiB
Text
217 lines
2.8 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
GstDParamManager
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
dynamic parameter manager
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
The manager provides a set of functions to work with #GstElements and their #GstDParams.
|
|
One can find out which dparams an element has, get the parameter specs and
|
|
pick a control change rate.
|
|
</para>
|
|
<para>
|
|
Some functions are meant for dparam implementor (plugin writers), where others
|
|
are for applications that use elements with dparams.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
<!-- ##### STRUCT GstDParamManager ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### SIGNAL GstDParamManager::new-required-dparam ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@gstdparammanager: the object which received the signal.
|
|
@arg1:
|
|
|
|
<!-- ##### 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:
|
|
|
|
|