|  |  |  | Farsight2 Reference Manual | |
|---|---|---|---|---|
| Top | Description | ||||
#include <gst/farsight/fs-plugin.h> struct FsPlugin; GObject * fs_plugin_create_valist (const gchar *name,const gchar *type_suffix,GError **error,const gchar *first_property_name,va_list var_args); GObject * fs_plugin_create (const gchar *name,const gchar *type_suffix,GError **error,const gchar *first_property_name,...); #define FS_INIT_PLUGIN (type_register_func) gchar ** fs_plugin_list_available (const gchar *type_suffix);
This class is a generic class to load GType plugins based on their name. With this simple class, you can only have one type per plugin.
struct FsPlugin {
  GTypeModule parent;
};
This structure represents a plugin, it is opaque.
| GTypeModule  | the parent object | 
GObject * fs_plugin_create_valist (const gchar *name,const gchar *type_suffix,GError **error,const gchar *first_property_name,va_list var_args);
Loads the appropriate plugin if necessary and creates a GObject of the requested type
| 
 | The name of the plugin to load | 
| 
 | The type of plugin to load (normally "transmitter") | 
| 
 | location of a GError, or NULL if no error occured | 
| 
 | The name of the first property to be set on the object | 
| 
 | The rest of the arguments | 
| Returns : | The object created (or NULL if there is an error) | 
GObject * fs_plugin_create (const gchar *name,const gchar *type_suffix,GError **error,const gchar *first_property_name,...);
Loads the appropriate plugin if necessary and creates a GObject of the requested type
| 
 | The name of the plugin to load | 
| 
 | The type of plugin to load (normally "transmitter") | 
| 
 | location of a GError, or NULL if no error occured | 
| 
 | The name of the first property to be set on the object | 
| 
 | The NULL-terminated list of properties to set on the transmitter | 
| Returns : | The object created (or NULL if there is an error) | 
#define FS_INIT_PLUGIN(type_register_func)
This macro is used to declare Farsight plugins and must be used once in any farsight plugin.
| 
 | A function that register a GType and returns it | 
gchar **            fs_plugin_list_available            (const gchar *type_suffix);
Gets the list of all available plugins of a certain type
| 
 | Get list of plugins with this type suffix | 
| Returns : | a newly allocated NULL terminated array of strings or NULLif no
strings were found. It should be freed withg_strfreev(). |