mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-03 14:08:56 +00:00
Code Issues 1 Projects Releases Wiki Activity

added some long description to gstcontrol

Browse source 
Original commit message from CVS:
added some long description to gstcontrol
This commit is contained in:
Stefan Kost 2004-07-14 14:57:53 +00:00
parent 3866e28ab6
commit 77767e0cb7
3 changed files with 57 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/libs/gstreamer-libs-docs.sgml
View file

@ -10,9 +10,8 @@
<!ENTITY GstControl SYSTEM "xml/gstcontrol.xml"> <!ENTITY GstControl SYSTEM "xml/gstcontrol.xml">
<!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml"> <!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
<!ENTITY hash "#">
]> ]>
<book> <book>
<bookinfo> <bookinfo>
<title>GStreamer Library &GST_MAJORMINOR; API Reference (&GST_VERSION;)</title> <title>GStreamer Library &GST_MAJORMINOR; API Reference (&GST_VERSION;)</title>

3
docs/libs/gstreamer-libs-sections.txt
View file

@ -115,6 +115,9 @@ gst_dpman_attach_dparam
gst_dpman_detach_dparam gst_dpman_detach_dparam
gst_dpman_get_dparam gst_dpman_get_dparam
gst_dpman_get_dparam_type gst_dpman_get_dparam_type
gst_dpman_list_dparam_specs
gst_dpman_get_param_spec
gst_dpman_set_rate
gst_dpman_register_mode gst_dpman_register_mode
gst_dpman_set_mode gst_dpman_set_mode
gst_dpman_set_parent gst_dpman_set_parent

55
docs/libs/tmpl/gstcontrol.sgml
View file

@ -6,7 +6,26 @@ Dynamic parameter functionality
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <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> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
@ -105,8 +124,10 @@ Dynamic parameter functionality
</para> </para>
@dpman: @dpman:
@name: @dparam_name:
@Returns: @Returns:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gst_dpman_get_dparam_type ##### --> <!-- ##### FUNCTION gst_dpman_get_dparam_type ##### -->
@ -115,8 +136,38 @@ Dynamic parameter functionality
</para> </para>
@dpman: @dpman:
@name: @dparam_name:
@Returns: @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 ##### --> <!-- ##### FUNCTION gst_dpman_register_mode ##### -->