|  |  |  | librygel-core Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
#define RYGEL_TYPE_PLUGIN void rygel_plugin_add_resource (RygelPlugin *self,RygelResourceInfo *resource_info); void rygel_plugin_add_icon (RygelPlugin *self,RygelIconInfo *icon_info); void rygel_plugin_apply_hacks (RygelPlugin *self,RygelRootDevice *device,const gchar *description_path,GError **error); RygelPlugin * rygel_plugin_new (const gchar *desc_path,const gchar *name,const gchar *title,const gchar *description,RygelPluginCapabilities capabilities); RygelPluginCapabilities rygel_plugin_get_capabilities (RygelPlugin *self); void rygel_plugin_set_capabilities (RygelPlugin *self,RygelPluginCapabilities value); const gchar * rygel_plugin_get_name (RygelPlugin *self); const gchar * rygel_plugin_get_title (RygelPlugin *self); void rygel_plugin_set_title (RygelPlugin *self,const gchar *value); const gchar * rygel_plugin_get_description (RygelPlugin *self); const gchar * rygel_plugin_get_desc_path (RygelPlugin *self); gboolean rygel_plugin_get_active (RygelPlugin *self); void rygel_plugin_set_active (RygelPlugin *self,gboolean value); GeeArrayList * rygel_plugin_get_resource_infos (RygelPlugin *self); GeeArrayList * rygel_plugin_get_icon_infos (RygelPlugin *self); GeeArrayList * rygel_plugin_get_default_icons (RygelPlugin *self); struct RygelPlugin; struct RygelPluginClass; enum RygelPluginCapabilities;
GObject +----GUPnPResourceFactory +----RygelPlugin
GFlags +----RygelPluginCapabilities
"active" gboolean : Read / Write "capabilities" RygelPluginCapabilities : Read / Write / Construct "default-icons" GeeArrayList* : Read "desc-path" gchar* : Read / Write / Construct Only "description" gchar* : Read / Write / Construct Only "icon-infos" GeeArrayList* : Read "name" gchar* : Read / Write / Construct Only "resource-infos" GeeArrayList* : Read "title" gchar* : Read / Write / Construct
Plugin libraries should provide an object of this class or a subclass in their module_init() function.
It is generally convenient to derive from RygelMediaRendererPlugin from librygel-renderer, or from RygelMediaServerPlugin from librygel-server.
Plugins may change their behaviour based on their configuration. See rygel_meta_config_get_default().
void rygel_plugin_add_resource (RygelPlugin *self,RygelResourceInfo *resource_info);
| 
 | the RygelPlugin instance | 
void rygel_plugin_add_icon (RygelPlugin *self,RygelIconInfo *icon_info);
| 
 | the RygelPlugin instance | 
void rygel_plugin_apply_hacks (RygelPlugin *self,RygelRootDevice *device,const gchar *description_path,GError **error);
| 
 | the RygelPlugin instance | 
| 
 | location to store the error occuring, or NULLto ignore | 
RygelPlugin * rygel_plugin_new (const gchar *desc_path,const gchar *name,const gchar *title,const gchar *description,RygelPluginCapabilities capabilities);
Create an instance of the plugin.
| 
 | The path of a template file for an XML description of the UPnP service. [in] | 
| 
 | The non-human-readable name for the plugin and its service, used in UPnP messages and in the Rygel configuration file. [in] | 
| 
 | An optional human-readable name (friendlyName) of the UPnP service provided by the plugin. If the title is empty then the name will be used. [in][allow-none] | 
| 
 | An optional human-readable description (modelDescription) of the UPnP service provided by the plugin. [in][allow-none] | 
RygelPluginCapabilities rygel_plugin_get_capabilities   (RygelPlugin *self);
Get and return the current value of the "capabilities" property.
| 
 | the RygelPlugin instance to query | 
| Returns : | the value of the "capabilities" property | 
void rygel_plugin_set_capabilities (RygelPlugin *self,RygelPluginCapabilities value);
Set the value of the "capabilities" property to value.
| 
 | the RygelPlugin instance to modify | 
| 
 | the new value of the "capabilities" property | 
const gchar *       rygel_plugin_get_name               (RygelPlugin *self);
Get and return the current value of the "name" property.
| 
 | the RygelPlugin instance to query | 
| Returns : | the value of the "name" property | 
const gchar *       rygel_plugin_get_title              (RygelPlugin *self);
Get and return the current value of the "title" property.
| 
 | the RygelPlugin instance to query | 
| Returns : | the value of the "title" property | 
void rygel_plugin_set_title (RygelPlugin *self,const gchar *value);
Set the value of the "title" property to value.
| 
 | the RygelPlugin instance to modify | 
| 
 | the new value of the "title" property | 
const gchar *       rygel_plugin_get_description        (RygelPlugin *self);
Get and return the current value of the "description" property.
| 
 | the RygelPlugin instance to query | 
| Returns : | the value of the "description" property | 
const gchar *       rygel_plugin_get_desc_path          (RygelPlugin *self);
Get and return the current value of the "desc-path" property.
| 
 | the RygelPlugin instance to query | 
| Returns : | the value of the "desc-path" property | 
gboolean            rygel_plugin_get_active             (RygelPlugin *self);
Get and return the current value of the "active" property.
| 
 | the RygelPlugin instance to query | 
| Returns : | the value of the "active" property | 
void rygel_plugin_set_active (RygelPlugin *self,gboolean value);
Set the value of the "active" property to value.
| 
 | the RygelPlugin instance to modify | 
| 
 | the new value of the "active" property | 
GeeArrayList *      rygel_plugin_get_resource_infos     (RygelPlugin *self);
Get and return the current value of the "resource-infos" property.
| 
 | the RygelPlugin instance to query | 
| Returns : | the value of the "resource-infos" property | 
GeeArrayList *      rygel_plugin_get_icon_infos         (RygelPlugin *self);
Get and return the current value of the "icon-infos" property.
| 
 | the RygelPlugin instance to query | 
| Returns : | the value of the "icon-infos" property | 
GeeArrayList *      rygel_plugin_get_default_icons      (RygelPlugin *self);
Get and return the current value of the "default-icons" property.
| 
 | the RygelPlugin instance to query | 
| Returns : | the value of the "default-icons" property | 
struct RygelPlugin;
This represents a Rygel plugin.
Plugin libraries should provide an object of this class or a subclass in their module_init() function.
It is generally convenient to derive from RygelMediaRendererPlugin from librygel-renderer, or from RygelMediaServerPlugin from librygel-server.
Plugins may change their behaviour based on their configuration. See rygel_meta_config_get_default().
struct RygelPluginClass {
	GUPnPResourceFactoryClass parent_class;
	void (*apply_hacks) (RygelPlugin* self, RygelRootDevice* device, const gchar* description_path, GError** error);
};
The class structure for RYGEL_TYPE_PLUGIN. All the fields in this structure are private and should never be accessed directly.
| the parent class structure | |
| virtual method called by  | 
typedef enum {
	RYGEL_PLUGIN_CAPABILITIES_NONE = 0,
	RYGEL_PLUGIN_CAPABILITIES_IMAGE_UPLOAD = 1 << 0,
	RYGEL_PLUGIN_CAPABILITIES_VIDEO_UPLOAD = 1 << 1,
	RYGEL_PLUGIN_CAPABILITIES_AUDIO_UPLOAD = 1 << 2,
	RYGEL_PLUGIN_CAPABILITIES_UPLOAD = (RYGEL_PLUGIN_CAPABILITIES_IMAGE_UPLOAD | RYGEL_PLUGIN_CAPABILITIES_VIDEO_UPLOAD) | RYGEL_PLUGIN_CAPABILITIES_AUDIO_UPLOAD,
	RYGEL_PLUGIN_CAPABILITIES_TRACK_CHANGES = 1 << 3,
	RYGEL_PLUGIN_CAPABILITIES_CREATE_CONTAINERS = 1 << 4
} RygelPluginCapabilities;
RygelPluginCapabilities is a set of flags that represent various capabilities of plugins.
"capabilities" property"capabilities" RygelPluginCapabilities : Read / Write / Construct
capabilities.
"desc-path" property  "desc-path"                gchar*                : Read / Write / Construct Only
desc-path.
Default value: NULL
"description" property  "description"              gchar*                : Read / Write / Construct Only
description.
Default value: NULL