GrlMediaPlugin

GrlMediaPlugin — Base class for Grilo Plugins

Synopsis

#include <grilo.h>

#define             GRL_MEDIA_PLUGIN_NAME
#define             GRL_MEDIA_PLUGIN_DESCRIPTION
#define             GRL_MEDIA_PLUGIN_VERSION
#define             GRL_MEDIA_PLUGIN_LICENSE
#define             GRL_MEDIA_PLUGIN_AUTHOR
#define             GRL_MEDIA_PLUGIN_SITE
struct              GrlMediaPlugin;
struct              GrlMediaPluginClass;
const gchar *       grl_media_plugin_get_name           (GrlMediaPlugin *plugin);
const gchar *       grl_media_plugin_get_description    (GrlMediaPlugin *plugin);
const gchar *       grl_media_plugin_get_version        (GrlMediaPlugin *plugin);
const gchar *       grl_media_plugin_get_license        (GrlMediaPlugin *plugin);
const gchar *       grl_media_plugin_get_author         (GrlMediaPlugin *plugin);
const gchar *       grl_media_plugin_get_site           (GrlMediaPlugin *plugin);
const gchar *       grl_media_plugin_get_id             (GrlMediaPlugin *plugin);
const gchar *       grl_media_plugin_get_filename       (GrlMediaPlugin *plugin);
gint                grl_media_plugin_get_rank           (GrlMediaPlugin *plugin);
GList *             grl_media_plugin_get_info_keys      (GrlMediaPlugin *plugin);
const gchar *       grl_media_plugin_get_info           (GrlMediaPlugin *plugin,
                                                         const gchar *key);

Object Hierarchy

  GObject
   +----GrlMediaPlugin
         +----GrlMetadataSource

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 GrlMediaPlugin subclasses.

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

Details

GRL_MEDIA_PLUGIN_NAME

#define GRL_MEDIA_PLUGIN_NAME "name"

GRL_MEDIA_PLUGIN_DESCRIPTION

#define GRL_MEDIA_PLUGIN_DESCRIPTION "description"

GRL_MEDIA_PLUGIN_VERSION

#define GRL_MEDIA_PLUGIN_VERSION "version"

GRL_MEDIA_PLUGIN_LICENSE

#define GRL_MEDIA_PLUGIN_LICENSE "license"

GRL_MEDIA_PLUGIN_AUTHOR

#define GRL_MEDIA_PLUGIN_AUTHOR "author"

GRL_MEDIA_PLUGIN_SITE

#define GRL_MEDIA_PLUGIN_SITE "site"

struct GrlMediaPlugin

struct GrlMediaPlugin;

struct GrlMediaPluginClass

struct GrlMediaPluginClass {
  GObjectClass parent_class;
};

GObjectClass parent_class;

the parent class structure

grl_media_plugin_get_name ()

const gchar *       grl_media_plugin_get_name           (GrlMediaPlugin *plugin);

Get the name of the plugin

`plugin` :	a plugin
Returns :	the name of the `plugin`

Since 0.1.1

grl_media_plugin_get_description ()

const gchar *       grl_media_plugin_get_description    (GrlMediaPlugin *plugin);

Get the description of the plugin

`plugin` :	a plugin
Returns :	the description of the `plugin`

Since 0.1.1

grl_media_plugin_get_version ()

const gchar *       grl_media_plugin_get_version        (GrlMediaPlugin *plugin);

Get the version of the plugin

`plugin` :	a plugin
Returns :	the version of the `plugin`

Since 0.1.1

grl_media_plugin_get_license ()

const gchar *       grl_media_plugin_get_license        (GrlMediaPlugin *plugin);

Get the license of the plugin

`plugin` :	a plugin
Returns :	the license of the `plugin`

Since 0.1.1

grl_media_plugin_get_author ()

const gchar *       grl_media_plugin_get_author         (GrlMediaPlugin *plugin);

Get the author of the plugin

`plugin` :	a plugin
Returns :	the author of the `plugin`

Since 0.1.1

grl_media_plugin_get_site ()

const gchar *       grl_media_plugin_get_site           (GrlMediaPlugin *plugin);

Get the site of the plugin

`plugin` :	a plugin
Returns :	the site of the `plugin`

Since 0.1.1

grl_media_plugin_get_id ()

const gchar *       grl_media_plugin_get_id             (GrlMediaPlugin *plugin);

Get the id of the plugin

`plugin` :	a plugin
Returns :	the id of the `plugin`

Since 0.1.1

grl_media_plugin_get_filename ()

const gchar *       grl_media_plugin_get_filename       (GrlMediaPlugin *plugin);

Get the filename containing the plugin

`plugin` :	a plugin
Returns :	the filename containing `plugin`

Since 0.1.6

grl_media_plugin_get_rank ()

gint                grl_media_plugin_get_rank           (GrlMediaPlugin *plugin);

Get the GrlPluginRank of the plugin

`plugin` :	a plugin
Returns :	the rank of the plugin

Since 0.1.3

grl_media_plugin_get_info_keys ()

GList *             grl_media_plugin_get_info_keys      (GrlMediaPlugin *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.1.6

grl_media_plugin_get_info ()

const gchar *       grl_media_plugin_get_info           (GrlMediaPlugin *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.1.6

GrlMediaPlugin

Synopsis

Object Hierarchy

Description

Details

GRL_MEDIA_PLUGIN_NAME

GRL_MEDIA_PLUGIN_DESCRIPTION

GRL_MEDIA_PLUGIN_VERSION

GRL_MEDIA_PLUGIN_LICENSE

GRL_MEDIA_PLUGIN_AUTHOR

GRL_MEDIA_PLUGIN_SITE

struct GrlMediaPlugin

struct GrlMediaPluginClass

grl_media_plugin_get_name ()

grl_media_plugin_get_description ()

grl_media_plugin_get_version ()

grl_media_plugin_get_license ()

grl_media_plugin_get_author ()

grl_media_plugin_get_site ()

grl_media_plugin_get_id ()

grl_media_plugin_get_filename ()

grl_media_plugin_get_rank ()

grl_media_plugin_get_info_keys ()

grl_media_plugin_get_info ()

See Also