From 77767e0cb73a1f561de4374ddd2f8a3161991908 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 14 Jul 2004 14:57:53 +0000 Subject: [PATCH] added some long description to gstcontrol Original commit message from CVS: added some long description to gstcontrol --- docs/libs/gstreamer-libs-docs.sgml | 3 +- docs/libs/gstreamer-libs-sections.txt | 3 ++ docs/libs/tmpl/gstcontrol.sgml | 55 ++++++++++++++++++++++++++- 3 files changed, 57 insertions(+), 4 deletions(-) diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml index 6f00a392e5..ac1f4d6683 100644 --- a/docs/libs/gstreamer-libs-docs.sgml +++ b/docs/libs/gstreamer-libs-docs.sgml @@ -10,9 +10,8 @@ + ]> - - GStreamer Library &GST_MAJORMINOR; API Reference (&GST_VERSION;) diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index 14da64b650..cbe531b004 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -115,6 +115,9 @@ gst_dpman_attach_dparam gst_dpman_detach_dparam gst_dpman_get_dparam 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_set_mode gst_dpman_set_parent diff --git a/docs/libs/tmpl/gstcontrol.sgml b/docs/libs/tmpl/gstcontrol.sgml index abb4e2e3db..534e257ad4 100644 --- a/docs/libs/tmpl/gstcontrol.sgml +++ b/docs/libs/tmpl/gstcontrol.sgml @@ -6,7 +6,26 @@ Dynamic parameter functionality +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. + + +To use this library one needs to add some code to initialize it. + +Adding the control library to a project + +... +&hash;include <gst/gst.h> +&hash;include <gst/control/control.h> +... +gst_init(&argc,&argv); +gst_control_init(&argc,&argv); +... + + +The next step is to get hold of the GstDParamManager instance of a GstElement. @@ -105,8 +124,10 @@ Dynamic parameter functionality @dpman: -@name: +@dparam_name: @Returns: + +@name: @@ -115,8 +136,38 @@ Dynamic parameter functionality @dpman: -@name: +@dparam_name: @Returns: + +@name: + + + + + + + +@dpman: +@Returns: + + + + + + + +@dpman: +@dparam_name: +@Returns: + + + + + + + +@dpman: +@rate: