Back to Seed Clases

Gst

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gst.Object
Gst.Plugin

Class Gst.Plugin

Import line:	Gst = imports.gi.Gst;
GIR File:	Gst-0.10.gir
C documentation:	GstPlugin
Class :	Plugin
Extends:	Gst.Object
	Show / Hide Inherited methods, properties and signals

The plugin object

Properties
Properties		Defined By
	_gst_reserved : Array read only	Gst.Plugin
	basename : String read only	Gst.Plugin
	desc : Gst.PluginDesc read only	Gst.Plugin
	file_mtime : Number read only	Gst.Plugin
	file_size : Number read only	Gst.Plugin
	filename : String read only	Gst.Plugin
	flags : Number read only	Gst.Plugin
	lock : GLib.Mutex read only	Gst.Object
	module : GModule.Module read only	Gst.Plugin
	name : String	Gst.Object
	name_prefix : String read only	Gst.Object
	object : Gst.Object read only	Gst.Plugin
	orig_desc : Gst.PluginDesc read only	Gst.Plugin
	parent : Gst.Object read only	Gst.Object
	priv : Gst.PluginPrivate read only	Gst.Plugin
	refcount : Number read only	Gst.Object
	registered : Boolean read only	Gst.Plugin

Methods / Constructors
Method / Constructor		Defined By
	new Gst.Plugin (Object *properties) Create a new Gst.Plugin Create a new Gst.Plugin Parameters: Object properties*
	Gst.Plugin.list_free (Array *list) : none Unrefs each member of list, then frees the list. Unrefs each member of list, then frees the list. Parameters: Array list* Required (not null) Returns: none	Gst.Plugin
	Gst.Plugin.load_by_name (String *name) : Gst.Plugin Load the named plugin. Load the named plugin. Refs the plugin. Parameters: String name* Required (not null) Returns: Gst.Plugin	Gst.Plugin
	Gst.Plugin.load_file (String *filename) : Gst.Plugin Loads the given plugin and refs it. Loads the given plugin and refs it. Caller needs to unref after use. newly-loaded GstPlugin, or NULL if an error occurred. Parameters: String filename* Required (not null) Returns: Gst.Plugin	Gst.Plugin
	Gst.Plugin.register_static (Number *major_version, Number minor_version, String name, String description, Function init_func, String version, String license, String source, String package, String origin) : Boolean Registers a static plugin, ie. 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: Number major_version* Required (not null) plugin was compiled for, you can just use GST_VERSION_MAJOR here Number minor_version Required (not null) plugin was compiled for, you can just use GST_VERSION_MINOR here String name Required (not null) library-specific namespace prefix in order to avoid name conflicts in case a similar plugin with the same name ever gets added to GStreamer) String description Required (not null) Function (Plugin *plugin) : Boolean Required (not null) String version* Required (not null) String license Required (not null) (see GstPluginDesc above) or the plugin will not be registered. String source Required (not null) String package Required (not null) String origin Required (not null) Returns: Boolean	Gst.Plugin
	Gst.Plugin.register_static_full (Number *major_version, Number minor_version, String name, String description, Function init_full_func, String version, String license, String source, String package, String origin, void *user_data) : Boolean Registers a static plugin, ie. 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 GstPluginInitFullFunc* 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: Number major_version Required (not null) plugin was compiled for, you can just use GST_VERSION_MAJOR here Number minor_version Required (not null) plugin was compiled for, you can just use GST_VERSION_MINOR here String name Required (not null) library-specific namespace prefix in order to avoid name conflicts in case a similar plugin with the same name ever gets added to GStreamer) String description Required (not null) Function (Plugin *plugin, void *user_data) : Boolean Required (not null) String version* Required (not null) String license Required (not null) (see GstPluginDesc above) or the plugin will not be registered. String source Required (not null) String package Required (not null) String origin Required (not null) void* user_data Required (not null) Returns: Boolean	Gst.Plugin
	add_dependency (Array *env_vars, Array paths, Array names, PluginDependencyFlags flags) : none Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie. 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: Array env_vars* Required (not null) 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". Array paths Required (not null) may be. Array names Required (not null) depending on flags) to be used in combination with the paths from Gst.PluginDependencyFlags flags Required (not null) Returns: none	Gst.Plugin
	add_dependency_simple (String *env_vars, String paths, String names, PluginDependencyFlags flags) : none Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie. 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: String env_vars* Required (not null) 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" String paths Required (not null) String names Required (not null) or NULL Gst.PluginDependencyFlags flags Required (not null) Returns: none	Gst.Plugin
	default_error (Object *error, String debug) : none A default error function. A default error function. The default handler will simply print the error string using g_print. Parameters: Object error* Required (not null) String debug Required (not null) Returns: none	Gst.Object
	get_cache_data () : Gst.Structure Gets the plugin specific data cache. Gets the plugin specific data cache. If it is NULL there is no cached data stored. This is the case when the registry is getting rebuilt. Returns: Gst.Structure	Gst.Plugin
	get_description () : String Get the long descriptive name of the plugin Get the long descriptive name of the plugin Returns: String	Gst.Plugin
	get_filename () : String get the filename of the plugin get the filename of the plugin Returns: String	Gst.Plugin
	get_license () : String get the license of the plugin get the license of the plugin Returns: String	Gst.Plugin
	get_module () : GModule.Module Gets the GModule of the plugin. Gets the GModule of the plugin. If the plugin isn't loaded yet, NULL is returned. Returns: GModule.Module loaded yet.	Gst.Plugin
	get_name () : String Get the short name of the plugin Get the short name of the plugin Returns: String	Gst.Plugin
	get_name_prefix () : String Returns a copy of the name prefix of object. Returns a copy of the name prefix of object. Caller should g_free() the return value after usage. For a prefixless object, this returns NULL, which you can safely g_free() as well. MT safe. This function grabs and releases object's LOCK. Returns: String after usage.	Gst.Object
	get_origin () : String get the URL where the plugin comes from get the URL where the plugin comes from Returns: String	Gst.Plugin
	get_package () : String get the package the plugin belongs to. get the package the plugin belongs to. Returns: String	Gst.Plugin
	get_parent () : Gst.Object Returns the parent of object. Returns the parent of object. This function increases the refcount of the parent object so you should gst_object_unref() it after usage. MT safe. Grabs and releases object's LOCK. Returns: Gst.Object parent. unref after usage.	Gst.Object
	get_path_string () : String Generates a string describing the path of object in the object hierarchy. Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging. MT safe. Grabs and releases the GstObject's LOCK for all objects in the hierarchy. Returns: String g_free() the string after usage.	Gst.Object
	get_source () : String get the source module the plugin belongs to. get the source module the plugin belongs to. Returns: String	Gst.Plugin
	get_version () : String get the version of the plugin get the version of the plugin Returns: String	Gst.Plugin
	has_ancestor (Object *ancestor) : Boolean Check if object* has an ancestor ancestor somewhere up in the hierarchy. Check if object has an ancestor ancestor somewhere up in the hierarchy. MT safe. Grabs and releases object's locks. Parameters: Gst.Object ancestor Required (not null) Returns: Boolean	Gst.Object
	is_loaded () : Boolean queries if the plugin is loaded into memory queries if the plugin is loaded into memory Returns: Boolean	Gst.Plugin
	load () : Gst.Plugin Loads plugin. 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	Gst.Plugin
	name_filter (String *name) : Boolean A standard filter that returns TRUE when the plugin is of the given name. A standard filter that returns TRUE when the plugin is of the given name. Parameters: String name* Required (not null) Returns: Boolean	Gst.Plugin
	replace (Object *newobj) : none Unrefs the GstObject* pointed to by oldobj, refs newobj and puts newobj in *oldobj. Unrefs the GstObject pointed to by oldobj, refs newobj and puts newobj in *oldobj. Be carefull when calling this function, it does not take any locks. You might want to lock the object owning oldobj pointer before calling this function. Make sure not to LOCK oldobj because it might be unreffed which could cause a deadlock when it is disposed. Parameters: Gst.Object newobj Required (not null) Returns: none	Gst.Object
	restore_thyself (Node *self) : none Restores object* with the data from the parent XML node. Restores object with the data from the parent XML node. Parameters: libxml2.Node self Required (not null) Returns: none	Gst.Object
	save_thyself (Node *parent) : libxml2.Node Saves object* into the parent XML node. Saves object into the parent XML node. Parameters: libxml2.Node parent Required (not null) Returns: libxml2.Node	Gst.Object
	set_cache_data (Structure *cache_data) : none Adds plugin specific data to cache. 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: Gst.Structure cache_data* Required (not null) Returns: none	Gst.Plugin
	set_name (String *name) : Boolean Sets the name of object, or gives object* a guaranteed unique name (if name is NULL). 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. a parent cannot be renamed, this function returns FALSE in those cases. MT safe. This function grabs and releases object's LOCK. Parameters: String name Required (not null) Returns: Boolean	Gst.Object
	set_name_prefix (String *name_prefix) : none Sets the name prefix of object* to name_prefix. Sets the name prefix of object to name_prefix. This function makes a copy of the provided name prefix, so the caller retains ownership of the name prefix it sent. MT safe. This function grabs and releases object's LOCK. Parameters: String name_prefix Required (not null) Returns: none	Gst.Object
	set_parent (Object *parent) : Boolean Sets the parent of object* to parent. 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_sink()). This function causes the parent-set signal to be emitted when the parent was successfully set. already had a parent or object and parent are the same. MT safe. Grabs and releases object's LOCK. Parameters: Gst.Object parent Required (not null) Returns: Boolean	Gst.Object
	unparent () : none Clear the parent of object, removing the associated reference. 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: none	Gst.Object

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	deep_notify (Object *self, Object prop_object, ParamSpec prop) : none The deep notify signal is used to be notified of property changes. The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin. Parameters: Gst.Object self* Gst.Object prop_object GObject.ParamSpec prop Returns: {none}	Gst.Object
	object_saved (Object *self, void *xml_node) : none Trigered whenever a new object is saved to XML. Trigered whenever a new object is saved to XML. You can connect to this signal to insert custom XML tags into the core XML. Parameters: Gst.Object self* void* xml_node Returns: {none}	Gst.Object
	parent_set (Object *self, Object parent) : none Emitted when the parent of an object is set. Emitted when the parent of an object is set. Parameters: Gst.Object self* Gst.Object parent Returns: {none}	Gst.Object
	parent_unset (Object *self, Object parent) : none Emitted when the parent of an object is unset. Emitted when the parent of an object is unset. Parameters: Gst.Object self* Gst.Object parent Returns: {none}	Gst.Object

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gst Method	Gst.type_find_register (Plugin *plugin, String name, Number rank, Function func, Array extensions, Caps possible_caps, void *data, Function data_notify*) : Boolean Registers a new typefind function to be used for typefinding.
Gst.Element Method	Gst.Element.register (Plugin *plugin, String name, Number rank, Number type*) : Boolean element (note that passing NULL only works in GStreamer 0.10.13 and later) Create a new elementfactory capable of instantiating objects of the
Gst.Registry Method	add_plugin (Plugin *plugin*) : Boolean Add the plugin to the registry.
Gst.Registry Method	remove_plugin (Plugin *plugin*) : none Remove the plugin from the registry.
Gst.Registry Method	find_plugin (String *name*) : Gst.Plugin Find the plugin with the given name in the registry.
Gst.Registry Method	lookup (String *filename*) : Gst.Plugin Look up a plugin in the given registry with the given filename.

Un-official Seed Documentation

Gst

Classes

Interfaces

Structs

Unions

Enums

Class Gst.Plugin