Gst.Plugin – gstreamer-1.0 – Vala Binding Reference

Description:

[ CCode ( type_id = "gst_plugin_get_type ()" ) ]
public class Plugin : Object

GStreamer is extensible, so Element instances can be loaded at runtime.

A plugin system can provide one or more of the basic GStreamer PluginFeature subclasses.

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

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

Usually plugins are always automatically loaded so you don't need to call 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 load can be needed to bring the plugin into memory.

Namespace: Gst

Content:

Static methods:

public static void list_free (owned List<Plugin> list)

Unrefs each member of list, then frees the list.

public static Plugin? load_by_name (string name)

Load the named plugin.

public static Plugin load_file (string filename) throws Error

Loads the given plugin and refs it.

public static bool register_static (int major_version, int minor_version, string name, string description, PluginInitFunc init_func, string version, string license, string source, string package, string origin)

Registers a static plugin, ie.

public static bool register_static_full (int major_version, int minor_version, string name, string description, PluginInitFullFunc init_full_func, string version, string license, string source, string package, string origin)

Registers a static plugin, ie.

Creation methods:

protected Plugin ()

Methods:

public void add_dependency (string[]? env_vars, string[]? paths, string[]? names, PluginDependencyFlags flags)

Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie.

public void add_dependency_simple (string? env_vars, string? paths, string? names, PluginDependencyFlags flags)

Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie.

public unowned Structure? get_cache_data ()

Gets the plugin specific data cache.

public unowned string get_description ()

Get the long descriptive name of the plugin

public unowned string? get_filename ()

get the filename of the plugin

public unowned string get_license ()

get the license of the plugin

public unowned string get_name ()

Get the short name of the plugin

public unowned string get_origin ()

get the URL where the plugin comes from

public unowned string get_package ()

get the package the plugin belongs to.

public unowned string? get_release_date_string ()

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

public unowned string get_source ()

get the source module the plugin belongs to.

public unowned string get_version ()

get the version of the plugin

public bool is_loaded ()

queries if the plugin is loaded into memory

public Plugin? load ()

Loads this.

public void set_cache_data (owned Structure cache_data)

Adds plugin specific data to cache.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref