#[repr(transparent)]pub struct Plugin { /* private fields */ }
Expand description
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 GstPluginDesc
.
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
GstPluginInitFunc
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.
Implements
Implementations
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.
env_vars
None
-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 None
. 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
None
-terminated array of directories/paths where dependent files
may be, or None
.
names
None
-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 None
.
flags
optional flags, or GST_PLUGIN_DEPENDENCY_FLAG_NONE
pub fn add_dependency_simple(
&self,
env_vars: Option<&str>,
paths: Option<&str>,
names: Option<&str>,
flags: PluginDependencyFlags
)
pub fn add_dependency_simple(
&self,
env_vars: Option<&str>,
paths: Option<&str>,
names: Option<&str>,
flags: PluginDependencyFlags
)
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 add_dependency()
which
takes simple strings as arguments instead of string arrays, with multiple
arguments separated by predefined delimiters (see above).
env_vars
one or more environment variables (separated by ‘:’, ‘;’ or ‘,’),
or None
. 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
one ore more directory paths (separated by ‘:’ or ‘;’ or ‘,’),
or None
. Example: “/usr/lib/mystuff/plugins”
names
one or more file names or file name suffixes (separated by commas),
or None
flags
optional flags, or GST_PLUGIN_DEPENDENCY_FLAG_NONE
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
the date string of the plugin, or None
if not
available.
Loads self
. Note that the return value is the loaded plugin; self
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
a reference to a loaded plugin, or
None
on error.
Adds plugin specific data to cache. Passes the ownership of the structure to
the self
.
The cache is flushed every time the registry is rebuilt.
cache_data
a structure containing the data to cache
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Returns the type identifier of Self
.
Auto Trait Implementations
Blanket Implementations
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T
. Read more
Upcasts an object to a reference of its superclass or interface T
. Read more
Tries to downcast to a subclass or interface implementor T
. Read more
Tries to downcast to a reference of its subclass or interface implementor T
. Read more
Tries to cast to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
Tries to cast to reference to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
Casts to T
unconditionally. Read more
Casts to &T
unconditionally. Read more
pub fn parent_class_init<T>(class: &mut Class<U>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,
pub fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,
Returns true
if the object is an instance of (can be cast to) T
.
Returns the ObjectClass
of the object. Read more
Returns the class of the object in the given type T
. Read more
Returns the interface T
of the object. Read more
Similar to Self::set_property
but fails instead of panicking.
Sets the property property_name
of the object to value value
. Read more
Similar to Self::set_property
but fails instead of panicking.
Sets the property property_name
of the object to value value
. Read more
Similar to Self::set_properties
but fails instead of panicking.
Sets multiple properties of the object at once. Read more
Similar to Self::set_properties_from_value
but fails instead of panicking.
Sets multiple properties of the object at once. Read more
Similar to Self::property
but fails instead of panicking.
Gets the property property_name
of the object and cast it to the type V. Read more
Similar to Self::property_value
but fails instead of panicking.
Gets the property property_name
of the object. Read more
Check if the object has a property property_name
of the given type_
. Read more
Get the type of the property property_name
of this object. Read more
Get the ParamSpec
of the property property_name
of this object.
Return all ParamSpec
of the properties of this object.
Freeze all property notifications until the return guard object is dropped. Read more
Set arbitrary data on this object with the given key
. Read more
Return previously set arbitrary data of this object with the given key
. Read more
Retrieve previously set arbitrary data of this object with the given key
. Read more
Set arbitrary data on this object with the given key
. Read more
Return previously set arbitrary data of this object with the given key
. Read more
Retrieve previously set arbitrary data of this object with the given key
. Read more
Block a given signal handler. Read more
Unblock a given signal handler.
Stop emission of the currently emitted signal.
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
Similar to Self::connect
but fails instead of panicking.
Connect to the signal signal_name
on this object. Read more
Similar to Self::connect_id
but fails instead of panicking.
Connect to the signal signal_id
on this object. Read more
Similar to Self::connect_local
but fails instead of panicking.
Connect to the signal signal_name
on this object. Read more
Similar to Self::connect_local_id
but fails instead of panicking.
Connect to the signal signal_id
on this object. Read more
Similar to Self::connect_unsafe
but fails instead of panicking.
Connect to the signal signal_name
on this object. Read more
Similar to Self::connect_unsafe_id
but fails instead of panicking.
pub fn try_connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
pub fn try_connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
Similar to Self::connect_closure
but fails instead of panicking.
pub fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId
pub fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId
Connect a closure to the signal signal_name
on this object. Read more
pub fn try_connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
pub fn try_connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
Similar to Self::connect_closure_id
but fails instead of panicking.
pub fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId
pub fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId
Connect a closure to the signal signal_id
on this object. Read more
Limits the lifetime of closure
to the lifetime of the object. When
the object’s reference count drops to zero, the closure will be
invalidated. An invalidated closure will ignore any calls to
Closure::invoke
. Read more
Connect to the signal signal_id
on this object. Read more
Similar to Self::emit
but fails instead of panicking.
Emit signal by signal id. Read more
Similar to Self::emit_with_values
but fails instead of panicking.
Same as Self::emit
but takes Value
for the arguments.
pub fn try_emit_by_name<R>(
&self,
signal_name: &str,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
pub fn try_emit_by_name<R>(
&self,
signal_name: &str,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
Similar to Self::emit_by_name
but fails instead of panicking.
pub fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R where
R: TryFromClosureReturnValue,
pub fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R where
R: TryFromClosureReturnValue,
Emit signal by its name. Read more
Similar to Self::emit_by_name_with_values
but fails instead of panicking.
Emit signal by its name. Read more
pub fn try_emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
pub fn try_emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
Similar to Self::emit_with_details
but fails instead of panicking.
pub fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> R where
R: TryFromClosureReturnValue,
pub fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> R where
R: TryFromClosureReturnValue,
Emit signal by signal id with details. Read more
Similar to Self::emit_with_details_and_values
but fails instead of panicking.
Emit signal by signal id with details. Read more
Disconnect a previously connected signal handler.
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
Connect to the notify
signal of the object. Read more
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
Connect to the notify
signal of the object. Read more
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
Connect to the notify
signal of the object. Read more
Notify that the given property has changed its value. Read more
Notify that the given property has changed its value. Read more
pub fn bind_property<O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a> where
O: ObjectType,
pub fn bind_property<O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a> where
O: ObjectType,
Bind property source_property
on this object to the target_property
on the target
object. Read more
Ensures that the type has been registered with the type system.
Returns a SendValue
clone of self
.