grl_registry_add_config ()

gboolean
grl_registry_add_config (GrlRegistry *registry,
                         GrlConfig *config,
                         GError **error);

Add a configuration for a plugin/source.

Since: 0.2.0

grl_registry_add_config_from_file ()

gboolean
grl_registry_add_config_from_file (GrlRegistry *registry,
                                   const gchar *config_file,
                                   GError **error);

Load plugin configurations from a .ini-like config file.

Since: 0.2.0

grl_registry_add_config_from_resource ()

gboolean
grl_registry_add_config_from_resource (GrlRegistry *registry,
                                       const gchar *resource_path,
                                       GError **error);

Load plugin configurations from a .ini-like resource file.

Since: 0.2.8

grl_registry_add_directory ()

void
grl_registry_add_directory (GrlRegistry *registry,
                            const gchar *path);

Set this path as part of default paths to load plugins.

Since: 0.2.0

grl_registry_get_default ()

GrlRegistry *
grl_registry_get_default (void);

As the registry is designed to work as a singleton, this method is in charge of creating the only instance or returned it if it is already in memory.

Since: 0.2.0

grl_registry_get_metadata_keys ()

GList *
grl_registry_get_metadata_keys (GrlRegistry *registry);

Returns a list with all registered keys in system.

Since: 0.2.0

grl_registry_get_plugins ()

GList *
grl_registry_get_plugins (GrlRegistry *registry,
                          gboolean only_loaded);

This function will return all the available plugins in the registry .

If only_loaded is TRUE, the plugin list will contain only plugins that are loaded.

Since: 0.2.0

grl_registry_get_sources ()

GList *
grl_registry_get_sources (GrlRegistry *registry,
                          gboolean ranked);

This function will return all the available sources in the registry .

If ranked is TRUE, the source list will be ordered by rank.

Since: 0.2.0

grl_registry_get_sources_by_operations ()

GList *
grl_registry_get_sources_by_operations
                               (GrlRegistry *registry,
                                GrlSupportedOps ops,
                                gboolean ranked);

Give an array of all the available sources in the registry capable of perform the operations requested in ops .

If ranked is TRUE, the source list will be ordered by rank.

Since: 0.2.0

grl_registry_load_all_plugins ()

gboolean
grl_registry_load_all_plugins (GrlRegistry *registry,
                               gboolean activate,
                               GError **error);

Load all the modules available in the default directory path.

The default directory path can be changed through the environment variable GRL_PLUGIN_PATH and it can contain several paths separated by ":"

Since: 0.2.0

grl_registry_load_plugin ()

gboolean
grl_registry_load_plugin (GrlRegistry *registry,
                          const gchar *library_filename,
                          GError **error);

Loads a module from shared object file stored in path

Since: 0.2.0

grl_registry_load_plugin_directory ()

gboolean
grl_registry_load_plugin_directory (GrlRegistry *registry,
                                    const gchar *path,
                                    GError **error);

Loads a set of modules from directory in path which contains a group shared object files.

Since: 0.2.0

grl_registry_load_plugin_from_desc ()

gboolean
grl_registry_load_plugin_from_desc (GrlRegistry *registry,
                                    GrlPluginDescriptor *plugin_desc,
                                    GError **error);

Loads the grilo plugin defined by plugin_desc . This is used to load plugins that aren't shared libraries, and are built into applications.

    static GrlPluginDescriptor descriptor = {
      .plugin_id = "grl-example",
      .plugin_init = grl_example_plugin_init,
    };

    grl_registry_load_plugin_from_desc (registry, &descriptor, &error);
  

[skip]

Since: 0.3.0

grl_registry_lookup_metadata_key ()

GrlKeyID
grl_registry_lookup_metadata_key (GrlRegistry *registry,
                                  const gchar *key_name);

Look up for the metadata key with name key_name .

Since: 0.2.0

grl_registry_lookup_metadata_key_desc ()

const gchar *
grl_registry_lookup_metadata_key_desc (GrlRegistry *registry,
                                       GrlKeyID key);

Returns key description.

Since: 0.2.0

grl_registry_lookup_metadata_key_name ()

const gchar *
grl_registry_lookup_metadata_key_name (GrlRegistry *registry,
                                       GrlKeyID key);

Returns key name.

Since: 0.2.0

grl_registry_lookup_metadata_key_relation ()

const GList *
grl_registry_lookup_metadata_key_relation
                               (GrlRegistry *registry,
                                GrlKeyID key);

Look up the list of keys that have a relation with key .

key is included in that list.

Since: 0.2.0

grl_registry_lookup_metadata_key_type ()

GType
grl_registry_lookup_metadata_key_type (GrlRegistry *registry,
                                       GrlKeyID key);

Returns key expected value type.

Since: 0.2.0

grl_registry_lookup_plugin ()

GrlPlugin *
grl_registry_lookup_plugin (GrlRegistry *registry,
                            const gchar *plugin_id);

This function will search and retrieve a plugin given its identifier.

Since: 0.2.0

grl_registry_lookup_source ()

GrlSource *
grl_registry_lookup_source (GrlRegistry *registry,
                            const gchar *source_id);

This function will search and retrieve a source given its identifier.

Since: 0.2.0

grl_registry_metadata_key_validate ()

gboolean
grl_registry_metadata_key_validate (GrlRegistry *registry,
                                    GrlKeyID key,
                                    GValue *value);

Validates value content complies with the key specification. That is, it has the expected type, and value are within the range specified in key (for integer values).

Since: 0.2.0

grl_registry_register_metadata_key ()

GrlKeyID
grl_registry_register_metadata_key (GrlRegistry *registry,
                                    GParamSpec *param_spec,
                                    GrlKeyID bind_key,
                                    GError **error);

Registers a new metadata key, creating a relation between the new key and bind_key .

Two keys are related when the values of both keys are somehow related.

One example of a relation would be the one between the URI of a media resource and its mime-type: they are both tied together and one does not make sense without the other.

Relations between keys allow the framework to provide all the data that is somehow related when any of the related keys are requested.

Since: 0.3.0

grl_registry_register_source ()

gboolean
grl_registry_register_source (GrlRegistry *registry,
                              GrlPlugin *plugin,
                              GrlSource *source,
                              GError **error);

Register a source in the registry with the given plugin information

Since: 0.2.0

grl_registry_unload_plugin ()

gboolean
grl_registry_unload_plugin (GrlRegistry *registry,
                            const gchar *plugin_id,
                            GError **error);

Unload from memory a module identified by plugin_id . This means call the module's deinit function.

Since: 0.2.0

grl_registry_unregister_source ()

gboolean
grl_registry_unregister_source (GrlRegistry *registry,
                                GrlSource *source,
                                GError **error);

Removes the source from the registry hash table

Since: 0.2.0

enum GrlRank

Source priority ranks. Defines the order in which the resolver (or similar rank-picking mechanisms) will choose this source over an alternative one with the same function.

These constants serve as a rough guidance for defining the rank of a GrlSource. Any value is valid, including values bigger than GRL_RANK_HIGHEST.

struct GrlRegistry

struct GrlRegistry;

struct GrlRegistryClass

struct GrlRegistryClass {
  GObjectClass parent_class;
};

Grilo Registry class. Dynamic loader of plugins.

struct GrlPluginDescriptor

struct GrlPluginDescriptor {
  gint major_version;
  gint minor_version;
  gchar *id;
  gchar *name;
  gchar *description;
  gchar *author;
  gchar *version;
  gchar *license;
  gchar *site;

  GrlPluginInitFunc init;
  GrlPluginDeinitFunc deinit;
  GrlPluginRegisterKeysFunc register_keys;
};

This structure is used for the module loader

Since: 0.3.0

GRL_PLUGIN_LIST_VAR

#define GRL_PLUGIN_LIST_VAR "GRL_PLUGIN_LIST"

GRL_PLUGIN_PATH_VAR

#define GRL_PLUGIN_PATH_VAR "GRL_PLUGIN_PATH"

GRL_PLUGIN_RANKS_VAR

#define GRL_PLUGIN_RANKS_VAR "GRL_PLUGIN_RANKS"

The “metadata-key-added” signal

void
user_function (GrlRegistry *registry,
               gchar       *key,
               gpointer     user_data)

Signals that a new metadata key has been registered.

Flags: Action

Since: 0.2.10

The “source-added” signal

void
user_function (GrlRegistry *registry,
               GrlSource   *source,
               gpointer     user_data)

Signals that a source has been added to the registry.

Flags: Action

Since: 0.2.0

The “source-removed” signal

void
user_function (GrlRegistry *registry,
               GrlSource   *source,
               gpointer     user_data)

Signals that a source has been removed from the registry.

Flags: Action

Since: 0.2.0