Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

gTypeInstance: TypeInstance
parent: MediaPlugin
sourceDesc: string

A description of the source

sourceId: string

The identifier of the source.

sourceName: string

The name of the source.

name: string

Methods

  • 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.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • cancel(operationId: number): void
  • 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.

    Parameters

    • operationId: number

      the identifier of the running operation, as returned by the function that started it

    Returns void

  • connect(sigName: "notify::source-desc", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::source-id", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::source-name", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: "notify::source-desc"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::source-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::source-name"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • emit(sigName: "notify::source-desc", ...args: any[]): void
  • emit(sigName: "notify::source-id", ...args: any[]): void
  • emit(sigName: "notify::source-name", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • 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

    Parameters

    • keys: ParamSpec[]

      the list of keys to filter out

    • returnFiltered: boolean

      if %TRUE the return value shall be a new list with the slow keys

    Returns [ParamSpec[], ParamSpec[]]

  • 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

    Parameters

    • keys: ParamSpec[]

      the list of keys to filter out

    • returnFiltered: boolean

      if %TRUE the return value shall be a new list with the unsupported keys

    Returns [ParamSpec[], ParamSpec[]]

  • 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

    Parameters

    • keys: ParamSpec[]

      the list of keys to filter out

    • returnFiltered: boolean

      if %TRUE the return value shall be a new list with the non-writable keys

    Returns [ParamSpec[], ParamSpec[]]

  • forceFloating(): void
  • 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().

    Returns void

  • freezeNotify(): void
  • 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.

    Returns void

  • genOperationId(): number
  • getAuthor(): string
  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getDescription(): string
  • getFilename(): string
  • getId(): string
  • getInfo(key: string): string
  • Get the information of the plugin that is associated with the given key

    Parameters

    • key: string

      a key representing information about this plugin

    Returns string

  • getInfoKeys(): string[]
  • 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.

    Returns string[]

  • getLicense(): string
  • getName(): string
  • getOperationData(operationId: number): object
  • Obtains the previously attached data

    Parameters

    • operationId: number

      the identifier of a running operation

    Returns object

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    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.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getRank(): number
  • getSite(): string
  • getVersion(): string
  • getv(names: string[], values: any[]): void
  • 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.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • isFloating(): boolean
  • Get the list of #GrlKeyID which are needed a priori, in order to fetch and store the requested key_id

    a #GList with the keys, or NULL if it can not resolve key_id

    Parameters

    Returns ParamSpec[]

  • mayResolve(media: Grl.Media, keyId: object): [boolean, object[]]
  • 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.

    Parameters

    • media: Grl.Media

      a media on which we want more metadata

    • keyId: object

      the key corresponding to a metadata we might want

    Returns [boolean, object[]]

  • notify(propertyName: string): void
  • 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.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • 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]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "notify::source-desc", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::source-id", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::source-name", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: "notify::source-desc"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source-name"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "notify::source-desc", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::source-id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::source-name", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::source-desc"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source-name"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "notify::source-desc", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::source-id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::source-name", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::source-desc"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source-id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source-name"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • operationIsCancelled(operationId: number): boolean
  • operationIsCompleted(operationId: number): boolean
  • operationIsFinished(operationId: number): boolean
  • operationIsOngoing(operationId: number): boolean
  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • 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().

    Returns GObject.Object

  • This is the main method of the #GrlMetadataSource class. It will fetch the metadata of the requested keys.

    This function is asynchronous.

    Parameters

    • keys: ParamSpec[]

      the #GList of #GrlKeyID to retrieve

    • media: Grl.Media

      Transfer object where all the metadata is stored.

    • flags: MetadataResolutionFlags

      bitwise mask of #GrlMetadataResolutionFlags with the resolution strategy

    • callback: MetadataSourceResolveCb

      the callback to execute when the media metadata is filled up

    Returns number

  • This is the main method of the #GrlMetadataSource class. It will fetch the metadata of the requested keys.

    This function is synchronous.

    Parameters

    • keys: ParamSpec[]

      the #GList of #GrlKeyID to retrieve

    • media: Grl.Media

      Transfer object where all the metadata is stored

    • flags: MetadataResolutionFlags

      bitwise mask of #GrlMetadataResolutionFlags with the resolution strategy

    Returns Grl.Media

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • setData(key: string, data?: object): void
  • 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.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • 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.

    Parameters

    Returns void

  • 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

    Parameters

    • media: Grl.Media

      the #GrlMedia object that we want to operate on

    • keys: ParamSpec[]

      a list of #GrlKeyID whose values we want to change

    • flags: MetadataWritingFlags

      Flags to configure specific behaviors of the operation.

    Returns ParamSpec[]

  • setOperationCancelled(operationId: number): void
  • setOperationCompleted(operationId: number): void
  • setOperationData(operationId: number, data: object): void
  • Attach a pointer to the specific operation.

    Parameters

    • operationId: number

      the identifier of a running operation

    • data: object

      the data to attach

    Returns void

  • setOperationFinished(operationId: number): void
  • setOperationOngoing(operationId: number): void
  • setProperty(propertyName: string, value?: any): void
  • 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.

    Returns ParamSpec[]

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • 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().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • Get a list of #GrlKeyID, which describe a metadata types that this source can fetch and store.

    Returns ParamSpec[]

  • supportedOperations(): number
  • By default the derived objects of #GrlMetadataSource can only resolve.

    the source

    Returns number

  • thawNotify(): void
  • 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.

    Returns void

  • unref(): void
  • 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.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • 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.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • 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

    Returns ParamSpec[]

  • compatControl(what: number, data: object): number
  • 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • 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.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • 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.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method