Class (GI Class)

Gst-1.0GstPlugin

GStreamer is extensible, so Gst.Element instances can be loaded at runtime. A plugin system can provide one or more of the basic GStreamer Gst.PluginFeature subclasses.

A plugin should export a symbol gst_plugin_desc that is a struct of type Gst.PluginDesc. the plugin loader will check the version of the core library the plugin was linked against and will create a new Gst.Plugin. It will then call the Gst.PluginInitFunc function that was provided in the gst_plugin_desc.

Once you have a handle to a Gst.Plugin (e.g. from the Gst.Registry), you can add any object that subclasses Gst.PluginFeature.

Usually plugins are always automatically loaded so you don't need to call gst_plugin_load() explicitly to bring it into memory. There are options to statically link plugins to an app or even use GStreamer without a plugin repository in which case gst_plugin_load() can be needed to bring the plugin into memory.

Hierarchy (View Summary)

Index

Constructors

Properties

Properties - Inherited from Gst.Object

Accessors - Inherited from Gst.Object

Methods

Methods - Inherited from Gst.Object

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

$gtype: GType<Gst.Plugin>

Properties - Inherited from Gst.Object

flags: number

Accessors - Inherited from Gst.Object

  • get parent(): Gst.Object

    The parent of the object. Please note, that when changing the 'parent' property, we don't emit GObject.Object::notify and Gst.Object.SignalSignatures.deep_notify | Gst.Object::deep-notify signals due to locking issues. In some cases one can use Gst.Bin.SignalSignatures.element_added | Gst.Bin::element-added or Gst.Bin.SignalSignatures.element_removed | Gst.Bin::element-removed signals on the parent to achieve a similar effect.

    Returns Gst.Object

  • set parent(val: Gst.Object): void

    Parameters

    Returns void

Methods

  • Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie. the elements or typefinders associated with it).

    GStreamer will re-inspect plugins with external dependencies whenever any of the external dependencies change. This is useful for plugins which wrap other plugin systems, e.g. a plugin which wraps a plugin-based visualisation library and makes visualisations available as GStreamer elements, or a codec loader which exposes elements and/or caps dependent on what external codec libraries are currently installed.

    Parameters

    • env_vars: string[]

      null-terminated array of environment variables affecting the feature set of the plugin (e.g. an environment variable containing paths where to look for additional modules/plugins of a library), or null. Environment variable names may be followed by a path component which will be added to the content of the environment variable, e.g. "HOME/.mystuff/plugins".

    • paths: string[]

      null-terminated array of directories/paths where dependent files may be, or null.

    • names: string[]

      null-terminated array of file names (or file name suffixes, depending on flags) to be used in combination with the paths from paths and/or the paths extracted from the environment variables in env_vars, or null.

    • flags: Gst.PluginDependencyFlags

      optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE

    Returns void

  • Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie. the elements or typefinders associated with it).

    GStreamer will re-inspect plugins with external dependencies whenever any of the external dependencies change. This is useful for plugins which wrap other plugin systems, e.g. a plugin which wraps a plugin-based visualisation library and makes visualisations available as GStreamer elements, or a codec loader which exposes elements and/or caps dependent on what external codec libraries are currently installed.

    Convenience wrapper function for gst_plugin_add_dependency() which takes simple strings as arguments instead of string arrays, with multiple arguments separated by predefined delimiters (see above).

    Parameters

    • env_vars: string

      one or more environment variables (separated by ':', ';' or ','), or null. Environment variable names may be followed by a path component which will be added to the content of the environment variable, e.g. "HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH"

    • paths: string

      one ore more directory paths (separated by ':' or ';' or ','), or null. Example: "/usr/lib/mystuff/plugins"

    • names: string

      one or more file names or file name suffixes (separated by commas), or null

    • flags: Gst.PluginDependencyFlags

      optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE

    Returns void

  • Parameters

    • message: string

      the status error message

    Returns void

  • Parameters

    • message: string

      the status info message

    Returns void

  • Parameters

    • message: string

      the status warning message

    Returns void

  • Get the long descriptive name of the plugin

    Returns string

    the long name of the plugin

  • get the filename of the plugin

    Returns string

    the filename of the plugin

  • get the URL where the plugin comes from

    Returns string

    the origin of the plugin

  • get the package the plugin belongs to.

    Returns string

    the package of the plugin

  • Get the release date (and possibly time) in form of a string, if available.

    For normal GStreamer plugin releases this will usually just be a date in the form of "YYYY-MM-DD", while pre-releases and builds from git may contain a time component after the date as well, in which case the string will be formatted like "YYYY-MM-DDTHH:MMZ" (e.g. "2012-04-30T09:30Z").

    There may be plugins that do not have a valid release date set on them.

    Returns string

    the date string of the plugin, or null if not available.

  • get the source module the plugin belongs to.

    Returns string

    the source of the plugin

  • Returns string[]

    an array of plugin status error messages, or NULL

  • Returns string[]

    an array of plugin status info messages, or NULL

  • Returns string[]

    an array of plugin status warning messages, or NULL

  • queries if the plugin is loaded into memory

    Returns boolean

    true is loaded, false otherwise

  • Loads plugin. Note that the return value is the loaded plugin; plugin is untouched. The normal use pattern of this function goes like this:

    GstPlugin *loaded_plugin;
    loaded_plugin = gst_plugin_load (plugin);
    // presumably, we're no longer interested in the potentially-unloaded plugin
    gst_object_unref (plugin);
    plugin = loaded_plugin;

    Returns Gst.Plugin

    a reference to a loaded plugin, or null on error.

  • Adds plugin specific data to cache. Passes the ownership of the structure to the plugin.

    The cache is flushed every time the registry is rebuilt.

    Parameters

    • cache_data: Structure

      a structure containing the data to cache

    Returns void

  • Registers a static plugin, ie. a plugin which is private to an application or library and contained within the application or library (as opposed to being shipped as a separate module file).

    You must make sure that GStreamer has been initialised (with gst_init() or via gst_init_get_option_group()) before calling this function.

    Parameters

    • major_version: number

      the major version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MAJOR here

    • minor_version: number

      the minor version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MINOR here

    • name: string

      a unique name of the plugin (ideally prefixed with an application- or library-specific namespace prefix in order to avoid name conflicts in case a similar plugin with the same name ever gets added to GStreamer)

    • description: string

      description of the plugin

    • init_func: PluginInitFunc

      pointer to the init function of this plugin.

    • version: string

      version string of the plugin

    • license: string

      effective license of plugin. Must be one of the approved licenses (see Gst.PluginDesc above) or the plugin will not be registered.

    • source: string

      source module plugin belongs to

    • _package: string

      shipped package plugin belongs to

    • origin: string

      URL to provider of plugin

    Returns boolean

  • Registers a static plugin, ie. a plugin which is private to an application or library and contained within the application or library (as opposed to being shipped as a separate module file) with a Gst.PluginInitFullFunc which allows user data to be passed to the callback function (useful for bindings).

    You must make sure that GStreamer has been initialised (with gst_init() or via gst_init_get_option_group()) before calling this function.

    Parameters

    • major_version: number

      the major version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MAJOR here

    • minor_version: number

      the minor version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MINOR here

    • name: string

      a unique name of the plugin (ideally prefixed with an application- or library-specific namespace prefix in order to avoid name conflicts in case a similar plugin with the same name ever gets added to GStreamer)

    • description: string

      description of the plugin

    • init_full_func: PluginInitFullFunc

      pointer to the init function with user data of this plugin.

    • version: string

      version string of the plugin

    • license: string

      effective license of plugin. Must be one of the approved licenses (see Gst.PluginDesc above) or the plugin will not be registered.

    • source: string

      source module plugin belongs to

    • _package: string

      shipped package plugin belongs to

    • origin: string

      URL to provider of plugin

    Returns boolean

Methods - Inherited from Gst.Object

  • 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.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.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 GObject.Binding 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.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    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.

    If flags contains GObject.BindingFlags.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 transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • 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

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • A default error function that uses g_printerr() to display the error message and the optional debug string..

    The default handler will simply print the error string using g_print.

    Parameters

    • error: GLib.Error

      the GError.

    • Optionaldebug: string

      an additional debug information string, or null

    Returns void

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • This function is intended for GObject.Object implementations to re-enforce a floating 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

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

  • Obtain the control-rate for this object. Audio processing Gst.Element objects will use this rate to sub-divide their processing loop and call gst_object_sync_values() in between. The length of the processing segment should be up to control-rate nanoseconds.

    If the object is not under property control, this will return GST_CLOCK_TIME_NONE. This allows the element to avoid the sub-dividing.

    The control-rate is not expected to change if the element is in Gst.State.PAUSED or Gst.State.PLAYING.

    Returns number

    the control rate in nanoseconds

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a number of GValues for the given controlled property starting at the requested time. The array values need to hold enough space for n_values of GObject.Value.

    This function is useful if one wants to e.g. draw a graph of the control curve or apply a control curve sample by sample.

    Parameters

    • property_name: string

      the name of the property to get

    • timestamp: number

      the time that should be processed

    • interval: number

      the time spacing between subsequent values

    • values: any[]

      array to put control-values in

    Returns boolean

    true if the given array could be filled, false otherwise

  • Returns the parent of object. This function increases the refcount of the parent object so you should gst_object_unref() it after usage.

    Returns Gst.Object

    parent of object, this can be null if object has no parent. unref after usage. MT safe. Grabs and releases object's LOCK.

  • Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging.

    Free-function: g_free

    Returns string

    a string describing the path of object. You must g_free() the string after usage. MT safe. Grabs and releases the Gst.Object's LOCK for all objects in the hierarchy.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value 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 GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Returns the toplevel parent of object. This function increases the refcount of the toplevel object so you should gst_object_unref() it after usage.

    Returns Gst.Object

    toplevel of object, or object itself if it has no parent. unref after usage. MT safe. Grabs and releases object's LOCK.

  • Gets the value for the given controlled property at the requested time.

    Parameters

    • property_name: string

      the name of the property to get

    • timestamp: number

      the time the control-change should be read from

    Returns GObject.Value

    the GValue of the property at the given time, or null if the property isn't controlled.

  • 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

  • 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

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

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    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

    Returns void

  • Increments the reference count on object. This function does not take the lock on object because it relies on atomic refcounting.

    This object returns the input parameter to ease writing constructs like : result = gst_object_ref (object->parent);

    Returns Gst.Object

    A pointer to object

  • Increase the reference count of object, and possibly remove the floating 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

    object

  • 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

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • This function is used to disable the control bindings on a property for some time, i.e. gst_object_sync_values() will do nothing for the property.

    Parameters

    • property_name: string

      property to disable

    • disabled: boolean

      boolean that specifies whether to disable the controller or not.

    Returns void

  • This function is used to disable all controlled properties of the object for some time, i.e. gst_object_sync_values() will do nothing.

    Parameters

    • disabled: boolean

      boolean that specifies whether to disable the controller or not.

    Returns void

  • Change the control-rate for this object. Audio processing Gst.Element objects will use this rate to sub-divide their processing loop and call gst_object_sync_values() in between. The length of the processing segment should be up to control-rate nanoseconds.

    The control-rate should not change if the element is in Gst.State.PAUSED or Gst.State.PLAYING.

    Parameters

    • control_rate: number

      the new control-rate in nanoseconds.

    Returns 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 GLib.Quark 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 GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets the name of object, or gives object a guaranteed unique name (if name is null). This function makes a copy of the provided name, so the caller retains ownership of the name it sent.

    Parameters

    • Optionalname: string

      new name of object

    Returns boolean

    true if the name could be set. Since Objects that have a parent cannot be renamed, this function returns false in those cases. MT safe. This function grabs and releases object's LOCK.

  • Sets the parent of object to parent. The object's reference count will be incremented, and any floating reference will be removed (see gst_object_ref_sink()).

    Parameters

    Returns boolean

    true if parent could be set or false when object already had a parent or object and parent are the same. MT safe. Grabs and releases object's LOCK.

  • Sets a property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • 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 GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

    Returns void

  • Returns a suggestion for timestamps where buffers should be split to get best controller results.

    Returns number

    Returns the suggested timestamp or GST_CLOCK_TIME_NONE if no control-rate was set.

  • Sets the properties of the object, according to the GstControlSources that (maybe) handle them and for the given timestamp.

    If this function fails, it is most likely the application developers fault. Most probably the control sources are not setup correctly.

    Parameters

    • timestamp: number

      the time that should be processed

    Returns boolean

    true if the controller values could be applied to the object properties, false otherwise

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

  • Clear the parent of object, removing the associated reference. This function decreases the refcount of object.

    MT safe. Grabs and releases object's lock.

    Returns void

  • Decrements the reference count on object. If reference count hits zero, destroy object. This function does not take the lock on object as it relies on atomic refcounting.

    The unref method should never be called with the LOCK held since this might deadlock the dispose function.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

    Returns 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

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns 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

    Returns void

  • Checks to see if there is any object named name in list. This function does not do any locking of any kind. You might want to protect the provided list with the lock of the owner of the list. This function will lock each Gst.Object in the list to compare the name, so be careful when passing a list with a locked object.

    Parameters

    Returns boolean

  • A default deep_notify signal callback for an object. The user data should contain a pointer to an array of strings that should be excluded from the notify. The default handler will print the new value of the property using g_print.

    MT safe. This function grabs and releases object's LOCK for getting its path string.

    Parameters

    Returns void

  • 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 GObject.ParamSpec, 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 GObject.TypeInfo.) 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

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures