enum GrlMediaSourceChangeType

typedef enum {
  GRL_CONTENT_CHANGED,
  GRL_CONTENT_ADDED,
  GRL_CONTENT_REMOVED,
} GrlMediaSourceChangeType;

Specifies which kind of change has happened in the plugin

struct GrlMediaSource

struct GrlMediaSource;

GrlMediaSourceResultCb ()

void                (*GrlMediaSourceResultCb)           (GrlMediaSource *source,
                                                         guint operation_id,
                                                         GrlMedia *media,
                                                         guint remaining,
                                                         gpointer user_data,
                                                         const GError *error);

Prototype for the callback passed to the media sources' methods

GrlMediaSourceMetadataCb ()

void                (*GrlMediaSourceMetadataCb)         (GrlMediaSource *source,
                                                         guint operation_id,
                                                         GrlMedia *media,
                                                         gpointer user_data,
                                                         const GError *error);

Prototype for the callback passed to grl_media_source_metadata()

GrlMediaSourceStoreCb ()

void                (*GrlMediaSourceStoreCb)            (GrlMediaSource *source,
                                                         GrlMediaBox *parent,
                                                         GrlMedia *media,
                                                         gpointer user_data,
                                                         const GError *error);

Prototype for the callback passed to grl_media_source_store()

GrlMediaSourceRemoveCb ()

void                (*GrlMediaSourceRemoveCb)           (GrlMediaSource *source,
                                                         GrlMedia *media,
                                                         gpointer user_data,
                                                         const GError *error);

Prototype for the callback passed to grl_media_source_remove()

GrlMediaSourceBrowseSpec

typedef struct {
  GrlMediaSource *source;
  guint browse_id;
  GrlMedia *container;
  GList *keys;
  guint skip;
  guint count;
  GrlMetadataResolutionFlags flags;
  GrlMediaSourceResultCb callback;
  gpointer user_data;
} GrlMediaSourceBrowseSpec;

Data transport structure used internally by the plugins which support browse vmethod.

GrlMediaSourceSearchSpec

typedef struct {
  GrlMediaSource *source;
  guint search_id;
  gchar *text;
  GList *keys;
  guint skip;
  guint count;
  GrlMetadataResolutionFlags flags;
  GrlMediaSourceResultCb callback;
  gpointer user_data;
} GrlMediaSourceSearchSpec;

Data transport structure used internally by the plugins which support search vmethod.

GrlMediaSourceQuerySpec

typedef struct {
  GrlMediaSource *source;
  guint query_id;
  gchar *query;
  GList *keys;
  guint skip;
  guint count;
  GrlMetadataResolutionFlags flags;
  GrlMediaSourceResultCb callback;
  gpointer user_data;
} GrlMediaSourceQuerySpec;

Data transport structure used internally by the plugins which support query vmethod.

GrlMediaSourceMetadataSpec

typedef struct {
  GrlMediaSource *source;
  guint metadata_id;
  GrlMedia *media;
  GList *keys;
  GrlMetadataResolutionFlags flags;
  GrlMediaSourceMetadataCb callback;
  gpointer user_data;
} GrlMediaSourceMetadataSpec;

Data transport structure used internally by the plugins which support metadata vmethod.

GrlMediaSourceStoreSpec

typedef struct {
  GrlMediaSource *source;
  GrlMediaBox *parent;
  GrlMedia *media;
  GrlMediaSourceStoreCb callback;
  gpointer user_data;
} GrlMediaSourceStoreSpec;

Data transport structure used internally by the plugins which support store vmethod.

GrlMediaSourceRemoveSpec

typedef struct {
  GrlMediaSource *source;
  gchar *media_id;
  GrlMedia *media;
  GrlMediaSourceRemoveCb callback;
  gpointer user_data;
} GrlMediaSourceRemoveSpec;

Data transport structure used internally by the plugins which support store vmethod.

GrlMediaSourceMediaFromUriSpec

typedef struct {
  GrlMediaSource *source;
  guint media_from_uri_id;
  gchar *uri;
  GList *keys;
  GrlMetadataResolutionFlags flags;
  GrlMediaSourceMetadataCb callback;
  gpointer user_data;
} GrlMediaSourceMediaFromUriSpec;

Data transport structure used internally by the plugins which support media_from_uri vmethod.

struct GrlMediaSourceClass

struct GrlMediaSourceClass {
  GrlMetadataSourceClass parent_class;

  void (*browse) (GrlMediaSource *source, GrlMediaSourceBrowseSpec *bs);

  void (*search) (GrlMediaSource *source, GrlMediaSourceSearchSpec *ss);

  void (*query) (GrlMediaSource *source, GrlMediaSourceQuerySpec *qs);

  void (*cancel) (GrlMediaSource *source, guint operation_id);

  void (*metadata) (GrlMediaSource *source, GrlMediaSourceMetadataSpec *ms);

  void (*store) (GrlMediaSource *source, GrlMediaSourceStoreSpec *ss);

  void (*remove) (GrlMediaSource *source, GrlMediaSourceRemoveSpec *ss);

  gboolean (*test_media_from_uri) (GrlMediaSource *source,
				   const gchar *uri);

  void (*media_from_uri) (GrlMediaSource *source,
			  GrlMediaSourceMediaFromUriSpec *mfss);

  gboolean (*notify_change_start) (GrlMediaSource *source,
                                    GError **error);

  gboolean (*notify_change_stop) (GrlMediaSource *source,
                                  GError **error);
};

Grilo MediaSource class. Override the vmethods to implement the source functionality.

grl_media_source_browse ()

guint               grl_media_source_browse             (GrlMediaSource *source,
                                                         GrlMedia *container,
                                                         const GList *keys,
                                                         guint skip,
                                                         guint count,
                                                         GrlMetadataResolutionFlags flags,
                                                         GrlMediaSourceResultCb callback,
                                                         gpointer user_data);

Browse from skip, a count number of media elements through an available list.

This method is asynchronous.

Since 0.1.4

grl_media_source_browse_sync ()

GList *             grl_media_source_browse_sync        (GrlMediaSource *source,
                                                         GrlMedia *container,
                                                         const GList *keys,
                                                         guint skip,
                                                         guint count,
                                                         GrlMetadataResolutionFlags flags,
                                                         GError **error);

Browse from skip, a count number of media elements through an available list.

This method is synchronous.

Since 0.1.6

grl_media_source_search ()

guint               grl_media_source_search             (GrlMediaSource *source,
                                                         const gchar *text,
                                                         const GList *keys,
                                                         guint skip,
                                                         guint count,
                                                         GrlMetadataResolutionFlags flags,
                                                         GrlMediaSourceResultCb callback,
                                                         gpointer user_data);

Search for the text string in a media source for data identified with that string.

If text is NULL then no text filter will be applied, and thus, no media items from source will be filtered. If source does not support NULL-text search operations it should notiy the client by setting GRL_CORE_ERROR_SEARCH_NULL_UNSUPPORTED in callback's error parameter.

This method is asynchronous.

Since 0.1.1

grl_media_source_search_sync ()

GList *             grl_media_source_search_sync        (GrlMediaSource *source,
                                                         const gchar *text,
                                                         const GList *keys,
                                                         guint skip,
                                                         guint count,
                                                         GrlMetadataResolutionFlags flags,
                                                         GError **error);

Search for the text string in a media source for data identified with that string.

If text is NULL then no text filter will be applied, and thus, no media items from source will be filtered. If source does not support NULL-text search operations it should notiy the client by setting GRL_CORE_ERROR_SEARCH_NULL_UNSUPPORTED in the error parameter.

This method is synchronous.

Since 0.1.6

grl_media_source_query ()

guint               grl_media_source_query              (GrlMediaSource *source,
                                                         const gchar *query,
                                                         const GList *keys,
                                                         guint skip,
                                                         guint count,
                                                         GrlMetadataResolutionFlags flags,
                                                         GrlMediaSourceResultCb callback,
                                                         gpointer user_data);

Execute a specialized query (specific for each provider) on a media repository.

It is different from grl_media_source_search() semantically, because the query implies a carefully crafted string, rather than a simple string to search.

This method is asynchronous.

Since 0.1.1

grl_media_source_query_sync ()

GList *             grl_media_source_query_sync         (GrlMediaSource *source,
                                                         const gchar *query,
                                                         const GList *keys,
                                                         guint skip,
                                                         guint count,
                                                         GrlMetadataResolutionFlags flags,
                                                         GError **error);

Execute a specialized query (specific for each provider) on a media repository.

This method is synchronous.

Since 0.1.6

grl_media_source_metadata ()

guint               grl_media_source_metadata           (GrlMediaSource *source,
                                                         GrlMedia *media,
                                                         const GList *keys,
                                                         GrlMetadataResolutionFlags flags,
                                                         GrlMediaSourceMetadataCb callback,
                                                         gpointer user_data);

This method is intended to fetch the requested keys of metadata of a given media to the media source.

This method is asynchronous.

Since 0.1.6

grl_media_source_metadata_sync ()

GrlMedia *          grl_media_source_metadata_sync      (GrlMediaSource *source,
                                                         GrlMedia *media,
                                                         const GList *keys,
                                                         GrlMetadataResolutionFlags flags,
                                                         GError **error);

This method is intended to fetch the requested keys of metadata of a given media to the media source.

This method is synchronous.

Since 0.1.6

grl_media_source_store ()

void                grl_media_source_store              (GrlMediaSource *source,
                                                         GrlMediaBox *parent,
                                                         GrlMedia *media,
                                                         GrlMediaSourceStoreCb callback,
                                                         gpointer user_data);

Store the media into the parent container

This method is asynchronous.

Since 0.1.4

grl_media_source_store_sync ()

void                grl_media_source_store_sync         (GrlMediaSource *source,
                                                         GrlMediaBox *parent,
                                                         GrlMedia *media,
                                                         GError **error);

Store the media into the parent container.

This method is synchronous.

Since 0.1.6

grl_media_source_remove ()

void                grl_media_source_remove             (GrlMediaSource *source,
                                                         GrlMedia *media,
                                                         GrlMediaSourceRemoveCb callback,
                                                         gpointer user_data);

Remove a media from the source repository.

This method is asynchronous.

Since 0.1.4

grl_media_source_remove_sync ()

void                grl_media_source_remove_sync        (GrlMediaSource *source,
                                                         GrlMedia *media,
                                                         GError **error);

Remove a media from the source repository.

This method is synchronous.

Since 0.1.6

grl_media_source_set_auto_split_threshold ()

void                grl_media_source_set_auto_split_threshold
                                                        (GrlMediaSource *source,
                                                         guint threshold);

TBD

Since 0.1.1

grl_media_source_get_auto_split_threshold ()

guint               grl_media_source_get_auto_split_threshold
                                                        (GrlMediaSource *source);

TBD

Since 0.1.1

grl_media_source_test_media_from_uri ()

gboolean            grl_media_source_test_media_from_uri
                                                        (GrlMediaSource *source,
                                                         const gchar *uri);

Tests whether source can instantiate a GrlMedia object representing the media resource exposed at uri.

Since 0.1.7

grl_media_source_get_media_from_uri ()

guint               grl_media_source_get_media_from_uri (GrlMediaSource *source,
                                                         const gchar *uri,
                                                         const GList *keys,
                                                         GrlMetadataResolutionFlags flags,
                                                         GrlMediaSourceMetadataCb callback,
                                                         gpointer user_data);

Creates an instance of GrlMedia representing the media resource exposed at uri.

It is recommended to call grl_media_source_test_media_from_uri() before invoking this to check whether the target source can theoretically do the resolution.

This method is asynchronous.

Since 0.1.14

grl_media_source_get_media_from_uri_sync ()

GrlMedia *          grl_media_source_get_media_from_uri_sync
                                                        (GrlMediaSource *source,
                                                         const gchar *uri,
                                                         const GList *keys,
                                                         GrlMetadataResolutionFlags flags,
                                                         GError **error);

Creates an instance of GrlMedia representing the media resource exposed at uri.

It is recommended to call grl_media_source_test_media_from_uri() before invoking this to check whether the target source can theoretically do the resolution.

This method is synchronous.

Since 0.1.8

grl_media_source_notify_change_start ()

gboolean            grl_media_source_notify_change_start
                                                        (GrlMediaSource *source,
                                                         GError **error);

Starts emitting ::content-changed signals when source discovers changes in the content. This instructs source to setup the machinery needed to be aware of changes in the content.

Since 0.1.9

grl_media_source_notify_change_stop ()

gboolean            grl_media_source_notify_change_stop (GrlMediaSource *source,
                                                         GError **error);

This will drop emission of ::content-changed signals from source. When this is done source should stop the machinery required for it to track changes in the content.

Since 0.1.9

grl_media_source_notify_change_list ()

void                grl_media_source_notify_change_list (GrlMediaSource *source,
                                                         GPtrArray *changed_medias,
                                                         GrlMediaSourceChangeType change_type,
                                                         gboolean location_unknown);

Emits "content-changed" signal to notify subscribers that a change ocurred in source.

The function will take ownership of changed medias and it should not be manipulated in any way by the caller after invoking this function. If that is needed, the caller must ref the array in advance.

See GrlMediaSource::content-changed signal.

Since 0.1.14

grl_media_source_notify_change ()

void                grl_media_source_notify_change      (GrlMediaSource *source,
                                                         GrlMedia *media,
                                                         GrlMediaSourceChangeType change_type,
                                                         gboolean location_unknown);

Emits "content-changed" signal to notify subscribers that a change ocurred in source.

See #grl_media_source_notify_change_list() function.

Since 0.1.9

The "auto-split-threshold" property

  "auto-split-threshold"     guint                 : Read / Write

Transparently split queries with count requests bigger than a certain threshold into smaller queries.

Default value: 0

The "content-changed" signal

void                user_function                      (GrlMediaSource          *source,
                                                        GPtrArray               *changed_medias,
                                                        GrlMediaSourceChangeType change_type,
                                                        gboolean                 location_unknown,
                                                        gpointer                 user_data)             : Action

Signals that the content in the source has changed. changed_medias is the list of elements that have changed. Usually these medias are of type GrlMediaBox, meaning that the content of that box has changed.

If location_unknown is TRUE it means the source cannot establish where the change happened: could be either in the box, in any child, or in any other descendant of the box in the hierarchy.

Both change_type and location_unknown are applied to all elements in the list.

For the cases where the source can only signal that a change happened, but not where, it would use a list with the the root box (NULL id) and set location_unknown as TRUE.

Since 0.1.9