A description of the source
The identifier of the source.
The name of the source.
Creates a binding between source_property
on source
and target_property
on target
.
Whenever the source_property
is changed the target_property
is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags
contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property
on target
changes then the source_property
on source
will be updated as well.
The binding will automatically be removed when either the source
or the
target
instances are finalized. To remove the binding without affecting the
source
and the target
you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source
and target
are only used from a single thread and it
is clear that both source
and target
outlive the binding. Especially it
is not safe to rely on this if the binding, source
or target
can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
Creates a binding between source_property
on source
and target_property
on target,
allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source
to the target,
or %NULL to use the default
a #GClosure wrapping the transformation function from the target
to the source,
or %NULL to use the default
Browse from skip,
a count
number of media elements through an available list.
This method is asynchronous.
a container of data transfer objects
the #GList of #GrlKeyIDs to request
the number if elements to skip in the browse operation
the number of elements to retrieve in the browse operation
the resolution mode
the user defined callback
Browse from skip,
a count
number of media elements through an available
list.
This method is synchronous.
elements. After use g_object_unref() every element and g_list_free() the list.
a container of data transfer objects
the #GList of #GrlKeyIDs to request
the number if elements to skip in the browse operation
the number of elements to retrieve in the browse operation
the resolution mode
Cancel a running method.
The derived class must implement the cancel vmethod in order to honour the request correctly. Otherwise, the operation will not be interrupted.
In all cases, if this function is called on an ongoing operation, the
corresponding callback will be called with the
GRL_CORE_ERROR_OPERATION_CANCELLED
error set, and no more action will be
taken for that operation after the said callback with error has been called.
the identifier of the running operation, as returned by the function that started it
This function does the opposite of other filter functions: removes the slow
keys from keys
. If return_filtered
is %TRUE the removed slow keys are
returned in a new list.
return_filtered
is %TRUE will return the list of slow keys; otherwise
%NULL
the list of keys to filter out
if %TRUE the return value shall be a new list with the slow keys
Compares the received keys
list with the supported key list by the
metadata source,
and deletes those keys which are not supported.
if return_filtered
is %TRUE will return the list of removed keys;
otherwise %NULL
the list of keys to filter out
if %TRUE the return value shall be a new list with the unsupported keys
Similar to grl_metadata_source_filter_supported() but applied to the writable keys in grl_metadata_source_writable_keys().
Filter the keys
list keeping only those keys that are writtable in
source
. If return_filtered
is %TRUE then the removed keys are returned in a
new list.
if return_filtered
is %TRUE will return the list of non-writtable keys;
otherwise %NULL
the list of keys to filter out
if %TRUE the return value shall be a new list with the non-writable keys
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object
. If the freeze count is
non-zero, the emission of "notify" signals on object
is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Get the author of the plugin
TBD
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Get the description of the plugin
Get the filename containing the plugin
Get the id of the plugin
Get the information of the plugin
that is associated with the given key
a key representing information about this plugin
Returns a list of keys that can be queried to retrieve information about the plugin.
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.
Get the license of the plugin
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.
A URI that can be used to identify a media resource
A list of keys to resolve
the resolution mode
the user defined callback
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.
A URI that can be used to identify a media resource
A list of keys to resolve
the resolution mode
Get the name of the plugin
Obtains the previously attached data
the identifier of a running operation
Gets a property of an object.
The value
can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Get the #GrlPluginRank of the plugin
Get the site of the plugin
Get the version of the plugin
Gets n_properties
properties for an object
.
Obtained properties will be set to values
. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object
has a [floating][floating-ref] reference.
Checks whether key_id
may be resolved with source
for media,
so that the
caller can avoid calling grl_metadata_source_resolve() if it can be known in
advance it will fail.
If the resolution is known to be impossible because more keys are needed in
media,
and missing_keys
is not NULL,
it is populated with the list of
GrlKeyID that would be needed.
This function is synchronous and should not block.
media,
FALSE
otherwise.
a media on which we want more metadata
the key corresponding to a metadata we might want
This method is intended to fetch the requested keys of metadata of
a given media
to the media source.
This method is asynchronous.
a data transfer object
the #GList of #GrlKeyIDs to request
the resolution mode
the user defined callback
This method is intended to fetch the requested keys of metadata of
a given media
to the media source.
This method is synchronous.
a data transfer object
the #GList of #GrlKeyIDs to request
the resolution mode
Emits a "notify" signal for the property property_name
on object
.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object
.
Emits a "notify" signal for the property specified by pspec
on object
.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object
.
Emits "content-changed" signal to notify subscribers that a change ocurred
in source
.
See #grl_media_source_notify_change_list() function.
the media which has changed, or NULL
to use the root box.
the type of change
if change has happened in media
or any descendant
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.
: the list of medias that have changed
the type of change
if change has happpened in media
or any descendant
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.
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.
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.
the query to process
the #GList of #GrlKeyIDs to request
the number if elements to skip in the query operation
the number of elements to retrieve in the query operation
the resolution mode
the user defined callback
Execute a specialized query (specific for each provider) on a media repository.
This method is synchronous.
elements. After use g_object_unref() every element and g_list_free() the list.
the query to process
the #GList of #GrlKeyIDs to request
the number if elements to skip in the query operation
the number of elements to retrieve in the query operation
the resolution mode
Increase the reference count of object,
and possibly remove the
[floating][floating-ref] reference, if object
has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object
will be propagated to the return type
under the same conditions as for g_object_ref().
Remove a media
from the source
repository.
This method is asynchronous.
a data transfer object
the user defined callback
This is the main method of the #GrlMetadataSource class. It will fetch the metadata of the requested keys.
This function is asynchronous.
the #GList of #GrlKeyID to retrieve
Transfer object where all the metadata is stored.
bitwise mask of #GrlMetadataResolutionFlags with the resolution strategy
the callback to execute when the media
metadata is filled up
This is the main method of the #GrlMetadataSource class. It will fetch the metadata of the requested keys.
This function is synchronous.
the #GList of #GrlKeyID to retrieve
Transfer object where all the metadata is stored
bitwise mask of #GrlMetadataResolutionFlags with the resolution strategy
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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.
the text to search
the #GList of #GrlKeyIDs to request
the number if elements to skip in the search operation
the number of elements to retrieve in the search operation
the resolution mode
the user defined callback
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.
elements. After use g_object_unref() every element and g_list_free() the list.
the text to search
the #GList of #GrlKeyIDs to request
the number if elements to skip in the search operation
the number of elements to retrieve in the search operation
the resolution mode
TBD
the threshold to request
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key
is converted to a #GQuark using g_quark_from_string().
This means a copy of key
is kept permanently (even after object
has been
finalized) — so it is recommended to only use a small, bounded set of values
for key
in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
This is the main method of the #GrlMetadataSource class. It will
get the values for keys
from media
and store it permanently. After
calling this method, future queries that return this media object
shall return this new values for the selected keys.
This function is asynchronous and uses the Glib's main loop.
the #GrlMedia object that we want to operate on.
a list of #GrlKeyID whose values we want to change.
Flags to configure specific behaviors of the operation.
the callback to execute when the operation is finished.
This is the main method of the #GrlMetadataSource class. It will
get the value for key
from media
and store it permanently. After
calling this method, future queries that return this media object
shall return this new value for the selected key.
This function is synchronous.
a #GList of keys that could not be updated, or NULL
the #GrlMedia object that we want to operate on
a list of #GrlKeyID whose values we want to change
Flags to configure specific behaviors of the operation.
Attach a pointer to the specific operation.
the identifier of a running operation
the data to attach
Sets a property on an object.
the name of the property to set
the value
Similar to grl_metadata_source_supported_keys(), but this keys are marked as slow because of the amount of traffic/processing needed to fetch them.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data
from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Store the media
into the parent
container
This method is asynchronous.
a parent to store the data transfer objects
a data transfer object
the user defined callback
Get a list of #GrlKeyID, which describe a metadata types that this source can fetch and store.
By default the derived objects of #GrlMetadataSource can only resolve.
the source
Tests whether source
can instantiate a #GrlMedia object representing
the media resource exposed at uri
.
This method is synchronous.
A URI that can be used to identify a media resource
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Decreases the reference count of object
. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Cancel a running method.
The derived class must implement the cancel vmethod in order to honour the request correctly. Otherwise, the operation will not be interrupted.
In all cases, if this function is called on an ongoing operation, the
corresponding callback will be called with the
GRL_CORE_ERROR_OPERATION_CANCELLED
error set, and no more action will be
taken for that operation after the said callback with error has been called.
the identifier of the running operation, as returned by the function that started it
Checks whether key_id
may be resolved with source
for media,
so that the
caller can avoid calling grl_metadata_source_resolve() if it can be known in
advance it will fail.
If the resolution is known to be impossible because more keys are needed in
media,
and missing_keys
is not NULL,
it is populated with the list of
GrlKeyID that would be needed.
This function is synchronous and should not block.
media,
FALSE
otherwise.
a media on which we want more metadata
the key corresponding to a metadata we might want
Emits a "notify" signal for the property property_name
on object
.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
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.
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.
Similar to grl_metadata_source_supported_keys(), but this keys are marked as slow because of the amount of traffic/processing needed to fetch them.
Get a list of #GrlKeyID, which describe a metadata types that this source can fetch and store.
Tests whether source
can instantiate a #GrlMedia object representing
the media resource exposed at uri
.
This method is synchronous.
A URI that can be used to identify a media resource
Similar to grl_metadata_source_supported_keys(), but these keys are marked as writable, meaning the source allows the client to provide new values for these keys that will be stored permanently.
a #GList with the keys
This function essentially limits the life time of the closure
to
the life time of the object. That is, when the object is finalized,
the closure
is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure,
to ensure that an extra
reference count is held on object
during invocation of the
closure
. Usually, this function will be called on closures that
use this object
as closure data.
#GClosure to watch
Similar to grl_metadata_source_supported_keys(), but these keys are marked as writable, meaning the source allows the client to provide new values for these keys that will be stored permanently.
a #GList with the keys
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init
member of
#GTypeInfo.) It must not be called after after class_init
has
been called for any object types implementing this interface.
If pspec
is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface
will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Transparently split queries with count requests bigger than a certain threshold into smaller queries.