Plugin

Description GStreamer is extensible, so GstElement instances can be loaded at runtime. A plugin system can provide one or more of the basic GStreamer GstPluginFeature subclasses. A plugin should export a symbol plugin_desc that is a struct of type GstPluginDesc. the plugin loader will check the version of the core library the plugin was linked against and will create a new GstPlugin. It will then call the GstPluginInitFunc function that was provided in the plugin_desc. Once you have a handle to a GstPlugin (e.g. from the GstRegistryPool), you can add any object that subclasses GstPluginFeature. Use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin. Usually plugins are always automaticlly 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.

Constructors

this this(GstPlugin* gstPlugin): Sets our main struct and passes it to the parent class

Members

Functions

getDescription string getDescription(): Get the long descriptive name of the plugin
getFilename string getFilename(): get the filename of the plugin
getLicense string getLicense(): get the license of the plugin
getModule Module getModule(): Gets the GModule of the plugin. If the plugin isn't loaded yet, NULL is returned.
getName string getName(): Get the short name of the plugin
getOrigin string getOrigin(): get the URL where the plugin comes from
getPackage string getPackage(): get the package the plugin belongs to.
getPluginStruct GstPlugin* getPluginStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getSource string getSource(): get the source module the plugin belongs to.
getStruct void* getStruct(): the main Gtk struct as a void*
getVersion string getVersion(): get the version of the plugin
isLoaded int isLoaded(): queries if the plugin is loaded into memory
load Plugin load(): Loads plugin. Note that the *return value* is the loaded plugin; plugin is
nameFilter int nameFilter(string name): A standard filter that returns TRUE when the plugin is of the given name.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

errorQuark GQuark errorQuark(): Get the error quark.
listFree void listFree(ListG list): Unrefs each member of list, then frees the list.
loadByName Plugin loadByName(string name): Load the named plugin. Refs the plugin.
loadFile Plugin loadFile(string filename): Loads the given plugin and refs it. Caller needs to unref after use.

Variables

gstPlugin GstPlugin* gstPlugin;: the main Gtk struct

Inherited Members

From ObjectGst

gstObject GstObject* gstObject;: the main Gtk struct
getObjectGstStruct GstObject* getObjectGstStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
connectedSignals int[string] connectedSignals;
onDeepNotifyListeners void delegate(ObjectGst, ParamSpec, ObjectGst)[] onDeepNotifyListeners;: Undocumented in source.
addOnDeepNotify void addOnDeepNotify(void delegate(ObjectGst, ParamSpec, ObjectGst) dlg, ConnectFlags connectFlags): 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.
callBackDeepNotify void callBackDeepNotify(GstObject* gstobjectStruct, GstObject* propObject, GParamSpec* prop, ObjectGst _objectGst): Undocumented in source. Be warned that the author may not have intended to support it.
onObjectSavedListeners void delegate(void*, ObjectGst)[] onObjectSavedListeners;: Undocumented in source.
addOnObjectSaved void addOnObjectSaved(void delegate(void*, ObjectGst) dlg, ConnectFlags connectFlags): Trigered whenever a new object is saved to XML. You can connect to this signal to insert custom XML tags into the core XML.
callBackObjectSaved void callBackObjectSaved(GstObject* gstobjectStruct, void* xmlNode, ObjectGst _objectGst): Undocumented in source. Be warned that the author may not have intended to support it.
onParentSetListeners void delegate(ObjectG, ObjectGst)[] onParentSetListeners;: Undocumented in source.
addOnParentSet void addOnParentSet(void delegate(ObjectG, ObjectGst) dlg, ConnectFlags connectFlags): Emitted when the parent of an object is set.
callBackParentSet void callBackParentSet(GstObject* gstobjectStruct, GObject* parent, ObjectGst _objectGst): Undocumented in source. Be warned that the author may not have intended to support it.
onParentUnsetListeners void delegate(ObjectG, ObjectGst)[] onParentUnsetListeners;: Undocumented in source.
addOnParentUnset void addOnParentUnset(void delegate(ObjectG, ObjectGst) dlg, ConnectFlags connectFlags): Emitted when the parent of an object is unset.
callBackParentUnset void callBackParentUnset(GstObject* gstobjectStruct, GObject* parent, ObjectGst _objectGst): Undocumented in source. Be warned that the author may not have intended to support it.
setName int setName(string name): 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.
getName string getName(): Returns a copy of the name of object. Caller should g_free() the return value after usage. For a nameless object, this returns NULL, which you can safely g_free() as well.
setParent int setParent(ObjectGst 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.
getParent ObjectGst getParent(): Returns the parent of object. This function increases the refcount of the parent object so you should gst_object_unref() it after usage.
unparent void unparent(): Clear the parent of object, removing the associated reference. This function decreases the refcount of object. MT safe. Grabs and releases object's lock.
getNamePrefix string getNamePrefix(): 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.
setNamePrefix void setNamePrefix(string namePrefix): 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.
defaultDeepNotify void defaultDeepNotify(ObjectG object, ObjectGst orig, ParamSpec pspec, string[] excludedProps): 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.
defaultError void defaultError(ErrorG error, string dbug): A default error function. The default handler will simply print the error string using g_print.
checkUniqueness int checkUniqueness(ListG list, string name): 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 GstObject in the list to compare the name, so be carefull when passing a list with a locked object.
hasAncestor int hasAncestor(ObjectGst ancestor): Check if object has an ancestor ancestor somewhere up in the hierarchy.
doref void* doref(void* object): Increments the refence 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
unref void unref(void* object): Decrements the refence 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.
sink void sink(void* object): If object was floating, the GST_OBJECT_FLOATING flag is removed and object is unreffed. When object was not floating, this function does nothing. Any newly created object has a refcount of 1 and is floating. This function should be used when creating a new object to symbolically 'take ownership' of object. This done by first doing a gst_object_ref() to keep a reference to object and then gst_object_sink() to remove and unref any floating references to object. Use gst_object_set_parent() to have this done for you. MT safe. This function grabs and releases object lock.
replace void replace(ObjectGst oldobj, ObjectGst newobj): 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.
getPathString string getPathString(): Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging.