gstcontrol

gstcontrol —

Synopsis


#include <libs/control/control.h>


void        gst_control_init                (int *argc,
                                             char **argv[]);

GstDParamManager* gst_dpman_new             (gchar *name,
                                             GstElement *parent);
gboolean    gst_dpman_add_required_dparam_callback
                                            (GstDParamManager *dpman,
                                             GParamSpec *param_spec,
                                             gchar *unit_name,
                                             GstDPMUpdateFunction update_func,
                                             gpointer update_data);
gboolean    gst_dpman_add_required_dparam_direct
                                            (GstDParamManager *dpman,
                                             GParamSpec *param_spec,
                                             gchar *unit_name,
                                             gpointer update_data);
gboolean    gst_dpman_add_required_dparam_array
                                            (GstDParamManager *dpman,
                                             GParamSpec *param_spec,
                                             gchar *unit_name,
                                             gpointer update_data);
void        gst_dpman_remove_required_dparam
                                            (GstDParamManager *dpman,
                                             gchar *dparam_name);
gboolean    gst_dpman_attach_dparam         (GstDParamManager *dpman,
                                             gchar *dparam_name,
                                             GstDParam *dparam);
void        gst_dpman_detach_dparam         (GstDParamManager *dpman,
                                             gchar *dparam_name);
GstDParam*  gst_dpman_get_dparam            (GstDParamManager *dpman,
                                             gchar *name);
GType       gst_dpman_get_dparam_type       (GstDParamManager *dpman,
                                             gchar *name);
void        gst_dpman_register_mode         (GstDParamManagerClass *klass,
                                             gchar *modename,
                                             GstDPMModePreProcessFunction preprocessfunc,
                                             GstDPMModeProcessFunction processfunc,
                                             GstDPMModeSetupFunction setupfunc,
                                             GstDPMModeTeardownFunction teardownfunc);
gboolean    gst_dpman_set_mode              (GstDParamManager *dpman,
                                             gchar *modename);
void        gst_dpman_set_parent            (GstDParamManager *dpman,
                                             GstElement *parent);
GstDParamManager* gst_dpman_get_manager     (GstElement *parent);
void        gst_dpman_bypass_dparam         (GstDParamManager *dpman,
                                             gchar *dparam_name);

GstDParam*  gst_dparam_new                  (GType type);
void        gst_dparam_attach               (GstDParam *dparam,
                                             GstDParamManager *manager,
                                             GParamSpec *param_spec,
                                             gchar *unit_name);
void        gst_dparam_detach               (GstDParam *dparam);
void        gst_dparam_do_update_default    (GstDParam *dparam,
                                             gint64 timestamp,
                                             GValue *value,
                                             GstDParamUpdateInfo update_info);

Description

Details

gst_control_init ()

void        gst_control_init                (int *argc,
                                             char **argv[]);

argc :
argv :

gst_dpman_new ()

GstDParamManager* gst_dpman_new             (gchar *name,
                                             GstElement *parent);

name : name of the GstDParamManager instance
parent : element which created this instance
Returns : a new instance of GstDParamManager

gst_dpman_add_required_dparam_callback ()

gboolean    gst_dpman_add_required_dparam_callback
                                            (GstDParamManager *dpman,
                                             GParamSpec *param_spec,
                                             gchar *unit_name,
                                             GstDPMUpdateFunction update_func,
                                             gpointer update_data);

dpman : GstDParamManager instance
param_spec :
unit_name :
update_func : callback to update the element with the new value
update_data : will be included in the call to update_func
Returns : true if it was successfully added

gst_dpman_add_required_dparam_direct ()

gboolean    gst_dpman_add_required_dparam_direct
                                            (GstDParamManager *dpman,
                                             GParamSpec *param_spec,
                                             gchar *unit_name,
                                             gpointer update_data);

dpman : GstDParamManager instance
param_spec :
unit_name :
update_data : pointer to the member to be updated
Returns : true if it was successfully added

gst_dpman_add_required_dparam_array ()

gboolean    gst_dpman_add_required_dparam_array
                                            (GstDParamManager *dpman,
                                             GParamSpec *param_spec,
                                             gchar *unit_name,
                                             gpointer update_data);

dpman : GstDParamManager instance
param_spec :
unit_name :
update_data : pointer to where the array will be stored
Returns : true if it was successfully added

gst_dpman_remove_required_dparam ()

void        gst_dpman_remove_required_dparam
                                            (GstDParamManager *dpman,
                                             gchar *dparam_name);

dpman : GstDParamManager instance
dparam_name : the name of an existing parameter

gst_dpman_attach_dparam ()

gboolean    gst_dpman_attach_dparam         (GstDParamManager *dpman,
                                             gchar *dparam_name,
                                             GstDParam *dparam);

dpman : GstDParamManager instance
dparam_name : a name previously added with gst_dpman_add_required_dparam
dparam : GstDParam instance to attach
Returns : true if it was successfully attached

gst_dpman_detach_dparam ()

void        gst_dpman_detach_dparam         (GstDParamManager *dpman,
                                             gchar *dparam_name);

dpman : GstDParamManager instance
dparam_name : the name of a parameter with a previously attached GstDParam

gst_dpman_get_dparam ()

GstDParam*  gst_dpman_get_dparam            (GstDParamManager *dpman,
                                             gchar *name);

dpman : GstDParamManager instance
name : the name of an existing dparam instance
Returns : the dparam with the given name - or NULL otherwise

gst_dpman_get_dparam_type ()

GType       gst_dpman_get_dparam_type       (GstDParamManager *dpman,
                                             gchar *name);

dpman : GstDParamManager instance
name : the name of dparam
Returns : the type that this dparam requires/uses

gst_dpman_register_mode ()

void        gst_dpman_register_mode         (GstDParamManagerClass *klass,
                                             gchar *modename,
                                             GstDPMModePreProcessFunction preprocessfunc,
                                             GstDPMModeProcessFunction processfunc,
                                             GstDPMModeSetupFunction setupfunc,
                                             GstDPMModeTeardownFunction teardownfunc);

klass : GstDParamManagerClass class instance
modename : the unique name of the new mode
preprocessfunc : the function which will be called before each buffer is processed
processfunc : the function which may be called throughout the processing of a buffer
setupfunc : the function which initialises the mode when activated
teardownfunc : the function which frees any resources the mode uses

gst_dpman_set_mode ()

gboolean    gst_dpman_set_mode              (GstDParamManager *dpman,
                                             gchar *modename);

dpman : GstDParamManager instance
modename : the name of the mode to use
Returns : TRUE if the mode was set, FALSE otherwise

gst_dpman_set_parent ()

void        gst_dpman_set_parent            (GstDParamManager *dpman,
                                             GstElement *parent);

dpman : GstDParamManager instance
parent : the element that this GstDParamManager belongs to

gst_dpman_get_manager ()

GstDParamManager* gst_dpman_get_manager     (GstElement *parent);

parent : the element that the desired GstDParamManager belongs to
Returns : the GstDParamManager which belongs to this element or NULL if it doesn't exist

gst_dpman_bypass_dparam ()

void        gst_dpman_bypass_dparam         (GstDParamManager *dpman,
                                             gchar *dparam_name);

If a dparam is attached to this dparam_name, it will be detached and a warning will be issued. This should be called in the _set_property function of an element if the value it changes is also changed by a dparam.

dpman : GstDParamManager instance
dparam_name : the name of dparam

gst_dparam_new ()

GstDParam*  gst_dparam_new                  (GType type);

type : the type that this dparam will store
Returns : a new instance of GstDParam

gst_dparam_attach ()

void        gst_dparam_attach               (GstDParam *dparam,
                                             GstDParamManager *manager,
                                             GParamSpec *param_spec,
                                             gchar *unit_name);

dparam : GstDParam instance
manager : the GstDParamManager that this dparam belongs to
param_spec :
unit_name :

gst_dparam_detach ()

void        gst_dparam_detach               (GstDParam *dparam);

dparam : GstDParam instance

gst_dparam_do_update_default ()

void        gst_dparam_do_update_default    (GstDParam *dparam,
                                             gint64 timestamp,
                                             GValue *value,
                                             GstDParamUpdateInfo update_info);

dparam :
timestamp :
value :
update_info :