BSE Interface Reference

/opt/src/beast/bse/bseprocedure.h

SYNOPSIS

struct  _BseProcedureClass;
   
BseErrorType  bse_procedure_collect_input_args  (proc, first_value, var_args, ivalues);
BseErrorType  bse_procedure_exec  (proc_name, ...);
BseErrorType  bse_procedure_exec_void  (proc_name, ...);
BseErrorType  bse_procedure_execvl  (proc, in_value_list, out_value_list, marshal, marshal_data);
GType  bse_procedure_lookup  (proc_name);
BseErrorType  bse_procedure_marshal  (proc_type, ivalues, ovalues, marshal, marshal_data);
BseErrorType  bse_procedure_marshal_valist  (proc_type, first_value, marshal, marshal_data, skip_ovalues, var_args);
const gchar*  bse_procedure_type_register  (name, plugin, ret_type);

DESCRIPTION

_BseProcedureClass

 /opt/src/beast/bse/bseprocedure.h:43
struct _BseProcedureClass
{
  GTypeClass       bse_class;
  guint            private_id;
  guint            n_in_pspecs;
  GParamSpec     **in_pspecs;
  guint            n_out_pspecs;
  GParamSpec     **out_pspecs;
  GTypeClass     **class_refs;
  guint            cache_stamp;
  gpointer         cache_next;
  BseProcedureExec execute;
};

bse_procedure_collect_input_args

 /opt/src/beast/bse/bseprocedure.h:96
BseErrorType  bse_procedure_collect_input_args  
(BseProcedureClass *proc,
 const GValue      *first_value,
 va_list            var_args,
 GValue             ivalues);
Collect input arguments for a procedure call from a va_list. The first value may be supplied as first_value and will then not be collected. ivalues must be at least proc->n_in_pspecs elements long and all elements will be initialized after the function returns (even in error cases). first_value may be the same adress as ivalues, in whic hcase the first argument is entirely ignored and collection simply starts out with the second argument.
proc: valid BseProcedureClass
first_value: the first input argument if not to be collected
var_args: va_list to collect input args from
ivalues: uninitialized GValue array with at least proc->n_in_pspecs members
RETURNS: BseErrorType value of error if any occoured during collection

bse_procedure_exec

 /opt/src/beast/bse/bseprocedure.h:78
BseErrorType  bse_procedure_exec  
(const gchar *proc_name,
 ...);

bse_procedure_exec_void

 /opt/src/beast/bse/bseprocedure.h:80
BseErrorType  bse_procedure_exec_void  
(const gchar *proc_name,
 ...);

bse_procedure_execvl

 /opt/src/beast/bse/bseprocedure.h:101
BseErrorType  bse_procedure_execvl  
(BseProcedureClass  *proc,
 GSList             *in_value_list,
 GSList             *out_value_list,
 BseProcedureMarshal marshal,
 gpointer            marshal_data);

bse_procedure_lookup

 /opt/src/beast/bse/bseprocedure.h:81
GType  bse_procedure_lookup  
(const gchar *proc_name);

bse_procedure_marshal

 /opt/src/beast/bse/bseprocedure.h:92
BseErrorType  bse_procedure_marshal  
(GType               proc_type,
 const GValue       *ivalues,
 GValue             *ovalues,
 BseProcedureMarshal marshal,
 gpointer            marshal_data);

bse_procedure_marshal_valist

 /opt/src/beast/bse/bseprocedure.h:87
BseErrorType  bse_procedure_marshal_valist  
(GType               proc_type,
 const GValue       *first_value,
 BseProcedureMarshal marshal,
 gpointer            marshal_data,
 gboolean            skip_ovalues,
 va_list             var_args);
Collect input arguments for a procedure call from a va_list and call the procedure, optionally via marshal. If skip_ovalues is FALSE, the procedure return values will be stored in return value locations also collected from var_args.
proc_type: a type derived from BSE_TYPE_PROCEDURE
first_value: the first input argument if not to be collected
marshal: function marshalling the procedure call or NULL
marshal_data: data passed in to marshal
skip_ovalues: whether return value locations should be collected and filled in
var_args: va_list to collect input args from
RETURNS: BseErrorType value of error if any occoured

bse_procedure_type_register

 /opt/src/beast/bse/bseprocedure.h:107
const gchar*  bse_procedure_type_register  
(const gchar *name,
 BsePlugin   *plugin,
 GType       *ret_type);