GrlPlugin

GrlPlugin — Base class for Grilo Plugins

Synopsis

#include <grilo.h>

struct              GrlPlugin;
struct              GrlPluginClass;
#define             GRL_PLUGIN_AUTHOR
#define             GRL_PLUGIN_DESCRIPTION
#define             GRL_PLUGIN_LICENSE
#define             GRL_PLUGIN_NAME
#define             GRL_PLUGIN_SITE
#define             GRL_PLUGIN_VERSION
const gchar *       grl_plugin_get_author               (GrlPlugin *plugin);
const gchar *       grl_plugin_get_description          (GrlPlugin *plugin);
const gchar *       grl_plugin_get_filename             (GrlPlugin *plugin);
const gchar *       grl_plugin_get_id                   (GrlPlugin *plugin);
const gchar *       grl_plugin_get_info                 (GrlPlugin *plugin,
                                                         const gchar *key);
GList *             grl_plugin_get_info_keys            (GrlPlugin *plugin);
const gchar *       grl_plugin_get_license              (GrlPlugin *plugin);
GModule *           grl_plugin_get_module               (GrlPlugin *plugin);
const gchar *       grl_plugin_get_name                 (GrlPlugin *plugin);
const gchar *       grl_plugin_get_site                 (GrlPlugin *plugin);
GList *             grl_plugin_get_sources              (GrlPlugin *plugin);
const gchar *       grl_plugin_get_version              (GrlPlugin *plugin);

Object Hierarchy

  GObject
   +----GrlPlugin

Properties

  "loaded"                   gboolean              : Read

Description

Grilo is extensible, so GrlMetadataSource or GrlMediaSource instances can be loaded at runtime. A plugin system can provide one or more of the basic Grilo GrlSource subclasses.

This is a base class for anything that can be added to a Grilo Plugin.

Details

struct GrlPlugin

struct GrlPlugin;

struct GrlPluginClass

struct GrlPluginClass {
  GObjectClass parent_class;
};

GObjectClass parent_class;

the parent class structure

GRL_PLUGIN_AUTHOR

#define GRL_PLUGIN_AUTHOR "author"

GRL_PLUGIN_DESCRIPTION

#define GRL_PLUGIN_DESCRIPTION "description"

GRL_PLUGIN_LICENSE

#define GRL_PLUGIN_LICENSE "license"

GRL_PLUGIN_NAME

#define GRL_PLUGIN_NAME "name"

GRL_PLUGIN_SITE

#define GRL_PLUGIN_SITE "site"

GRL_PLUGIN_VERSION

#define GRL_PLUGIN_VERSION "version"

grl_plugin_get_author ()

const gchar *       grl_plugin_get_author               (GrlPlugin *plugin);

Get the author of the plugin

plugin :

a plugin

Returns :

the author of the plugin

Since 0.2.0


grl_plugin_get_description ()

const gchar *       grl_plugin_get_description          (GrlPlugin *plugin);

Get the description of the plugin

plugin :

a plugin

Returns :

the description of the plugin

Since 0.2.0


grl_plugin_get_filename ()

const gchar *       grl_plugin_get_filename             (GrlPlugin *plugin);

Get the filename containing the plugin

plugin :

a plugin

Returns :

the filename containing plugin

Since 0.2.0


grl_plugin_get_id ()

const gchar *       grl_plugin_get_id                   (GrlPlugin *plugin);

Get the id of the plugin

plugin :

a plugin

Returns :

the id of the plugin

Since 0.2.0


grl_plugin_get_info ()

const gchar *       grl_plugin_get_info                 (GrlPlugin *plugin,
                                                         const gchar *key);

Get the information of the plugin that is associated with the given key

plugin :

a plugin

key :

a key representing information about this plugin

Returns :

the information assigned to the given key or NULL if there is no such information

Since 0.2.0


grl_plugin_get_info_keys ()

GList *             grl_plugin_get_info_keys            (GrlPlugin *plugin);

Returns a list of keys that can be queried to retrieve information about the plugin.

plugin :

a plugin

Returns :

a GList of strings containing the keys. The content of the list is owned by the plugin and should not be modified or freed. Use g_list_free() when done using the list. [transfer container][element-type utf8]

Since 0.2.0


grl_plugin_get_license ()

const gchar *       grl_plugin_get_license              (GrlPlugin *plugin);

Get the license of the plugin

plugin :

a plugin

Returns :

the license of the plugin

Since 0.2.0


grl_plugin_get_module ()

GModule *           grl_plugin_get_module               (GrlPlugin *plugin);

Gets the GModule containing the plugin

plugin :

a plugin

Returns :

a GModule

Since 0.2.0


grl_plugin_get_name ()

const gchar *       grl_plugin_get_name                 (GrlPlugin *plugin);

Get the name of the plugin

plugin :

a plugin

Returns :

the name of the plugin

Since 0.2.0


grl_plugin_get_site ()

const gchar *       grl_plugin_get_site                 (GrlPlugin *plugin);

Get the site of the plugin

plugin :

a plugin

Returns :

the site of the plugin

Since 0.2.0


grl_plugin_get_sources ()

GList *             grl_plugin_get_sources              (GrlPlugin *plugin);

Gets the sources belonging to plugin.

plugin :

a plugin

Returns :

a GList of GrlSources. The content of the list should not be modified or freed. Use g_list_free() when done using the list. [transfer container][element-type Grl.Source]

Since 0.2.0


grl_plugin_get_version ()

const gchar *       grl_plugin_get_version              (GrlPlugin *plugin);

Get the version of the plugin

plugin :

a plugin

Returns :

the version of the plugin

Since 0.2.0

Property Details

The "loaded" property

  "loaded"                   gboolean              : Read

TRUE if plugin is loaded.

Default value: FALSE

Since 0.2.0

See Also

GrlMetadataSource, GrlMediaSource