Namespace

Grl – 0.3

A framework for browsing and searching media content from various sources using a single API.

Version0.3.16
AuthorsGrilo developers
LicenseLGPL-2.1-or-later
Websitehttps://wiki.gnome.org/Projects/Grilo
Sourcehttps://gitlab.gnome.org/GNOME/grilo/

Build

C headersgrilo.h

Dependencies

GModule—2.0 Portable API for dynamically loading modules
Browse documentation
GObject—2.0 The base type system library
Browse documentation

Structs

LogDomain

PluginDescriptor

This structure is used for the module loader.

since: 0.3.0

RangeValue

SourceBrowseSpec

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

SourceMediaFromUriSpec

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

SourceQuerySpec

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

SourceRemoveSpec

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

SourceResolveSpec

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

SourceSearchSpec

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

SourceStoreMetadataSpec

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

SourceStoreSpec

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

Aliases

Enumerations

CoreError

These constants identify all the available core errors.

LogLevel

Grilo log levels. Defines the level of verbosity selected in Grilo.

MediaSerializeType

GrlMedia serialize type.

since: 0.2.3

MediaType

Rank

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.

SourceChangeType

Specifies which kind of change has happened in the plugin.

Bitfields

ResolutionFlags

Resolution flags.

SupportedMedia

SupportedOps

Bitwise flags which reflect the kind of operations that a GrlSource supports.

TypeFilter

Type of media to allow.

WriteFlags

Flags for writing operations.

Callbacks

PluginDeinitFunc

PluginInitFunc

PluginRegisterKeysFunc

SourceRemoveCb

Prototype for the callback passed to grl_source_remove()

SourceResolveCb

Prototype for the callback passed to grl_source_resolve(). If the URI did not resolve to a valid media record, media will be NULL. If there was an error during resolution, error will be set.

SourceResultCb

Prototype for the callback passed to the media sources’ methods.

SourceStoreCb

Prototype for the callback passed to grl_source_store_foo functions.

Functions

date_time_from_iso8601

since: 0.2.0

deinit

Deinitializes the Grilo library.

since: 0.2.8

g_value_dup

g_value_free

g_value_hashtable_new

g_value_hashtable_new_direct

g_value_new

init

Initializes the Grilo library.

since: 0.1.6

init_get_option_group

Returns a GOptionGroup with Grilo’s argument specifications.

since: 0.1.6

list_from_va

Returns a GList containing the va_list pointers. Use NULL to finalize them,

since: 0.1.6

log

Send a log message.

since: 0.1.7

log_configure

Configure a set of log domains. The default configuration is to display warning and error messages only for all the log domains.

since: 0.1.7

metadata_key_get_desc

Retrieves the description associated with the key.

since: 0.1.6

metadata_key_get_name

Retrieves the name associated with the key.

since: 0.1.6

metadata_key_get_type

Retrieves the expected type for values associated with this key.

since: 0.2.0

metadata_key_list_new

Returns a GList containing the va_list keys. Use #GRL_METADATA_KEY_INVALID to finalize them.

since: 0.2.0

multiple_get_media_from_uri

Goes though all available media sources until it finds one capable of constructing a GrlMedia object representing the media resource exposed by uri.

since: 0.2.0

multiple_search

Search for text in all the sources specified in sources.

since: 0.2.0

multiple_search_sync

Search for text in all the sources specified in sources.

since: 0.2.0

operation_cancel

Cancel an operation.

operation_get_data

Obtains the previously attached data.

operation_set_data

Attach a pointer to the specific operation.

operation_set_data_full

Attach a pointer to the specific operation.

since: 0.2.7

paging_translate

Grilo browsing implements a paging mechanism through skip and count values.

since: 0.1.6

Function Macros

DEBUG

Output a debugging message in the default log domain.

ERROR

Output an error message in the default log domain.

INFO

Output an informational message in the default log domain.

LOG

Outputs a debugging message. This is the most general macro for outputting debugging messages. You will probably want to use one of the ones described below.

LOG_DOMAIN_EXTERN

Declares a GrlLogDomain variable as extern. Use in header files.

LOG_DOMAIN_FREE

Free a previously allocated GrlLogDomain.

LOG_DOMAIN_INIT

Creates a new GrlLogDomain with the given name.

LOG_DOMAIN_STATIC

Defines a static GrlLogDomain variable.

MESSAGE

Output a logging message in the default log domain.

PLUGIN_DEFINE

since: 0.3.0

WARNING

Output a warning message in the default log domain.

Constants

CONFIG_KEY_APIKEY

CONFIG_KEY_APIKEY_BLOB

CONFIG_KEY_APISECRET

CONFIG_KEY_APITOKEN

CONFIG_KEY_APITOKEN_SECRET

CONFIG_KEY_PASSWORD

CONFIG_KEY_PLUGIN

CONFIG_KEY_SOURCE

CONFIG_KEY_USERNAME

CONFIG_PATH_VAR

COUNT_INFINITY

KEYID_FORMAT

METADATA_KEY_ALBUM

METADATA_KEY_ALBUM_ARTIST

METADATA_KEY_ALBUM_DISC_NUMBER

METADATA_KEY_ARTIST

METADATA_KEY_AUDIO_TRACK

METADATA_KEY_AUTHOR

METADATA_KEY_BITRATE

METADATA_KEY_CAMERA_MODEL

METADATA_KEY_CERTIFICATE

METADATA_KEY_CHILDCOUNT

METADATA_KEY_CHILDCOUNT_UNKNOWN

METADATA_KEY_COMPOSER

METADATA_KEY_CREATION_DATE

METADATA_KEY_DESCRIPTION

METADATA_KEY_DIRECTOR

METADATA_KEY_DURATION

METADATA_KEY_EPISODE

METADATA_KEY_EPISODE_TITLE

METADATA_KEY_EXPOSURE_TIME

METADATA_KEY_EXTERNAL_PLAYER

METADATA_KEY_EXTERNAL_URL

METADATA_KEY_FAVOURITE

METADATA_KEY_FLASH_USED

METADATA_KEY_FRAMERATE

METADATA_KEY_GENRE

METADATA_KEY_HEIGHT

METADATA_KEY_ID

METADATA_KEY_INVALID

METADATA_KEY_ISO_SPEED

METADATA_KEY_KEYWORD

METADATA_KEY_LAST_PLAYED

METADATA_KEY_LAST_POSITION

METADATA_KEY_LICENSE

METADATA_KEY_LYRICS

METADATA_KEY_MB_ALBUM_ID

METADATA_KEY_MB_ARTIST_ID

METADATA_KEY_MB_RECORDING_ID

METADATA_KEY_MB_RELEASE_GROUP_ID

METADATA_KEY_MB_RELEASE_ID

METADATA_KEY_MB_TRACK_ID

METADATA_KEY_MIME

METADATA_KEY_MODIFICATION_DATE

METADATA_KEY_ORIENTATION

METADATA_KEY_ORIGINAL_TITLE

METADATA_KEY_PERFORMER

METADATA_KEY_PLAY_COUNT

METADATA_KEY_PRODUCER

METADATA_KEY_PUBLICATION_DATE

METADATA_KEY_RATING

METADATA_KEY_REGION

METADATA_KEY_SEASON

METADATA_KEY_SHOW

METADATA_KEY_SITE

METADATA_KEY_SIZE

METADATA_KEY_SOURCE

METADATA_KEY_START_TIME

METADATA_KEY_STUDIO

METADATA_KEY_THUMBNAIL

METADATA_KEY_THUMBNAIL_BINARY

METADATA_KEY_TITLE

METADATA_KEY_TITLE_FROM_FILENAME

METADATA_KEY_TRACK_NUMBER

METADATA_KEY_URL

METADATA_KEY_WIDTH

PADDING

PADDING_SMALL

PLUGIN_AUTHOR

PLUGIN_DESCRIPTION

PLUGIN_LICENSE

PLUGIN_LIST_VAR

PLUGIN_NAME

PLUGIN_PATH_VAR

PLUGIN_RANKS_VAR

PLUGIN_SITE

PLUGIN_VERSION

SOURCE_REMAINING_UNKNOWN