Struct gstreamer::Plugin [−]
pub struct Plugin(_, _);
GStreamer is extensible, so Element
instances can be loaded at runtime.
A plugin system can provide one or more of the basic
<application>
GStreamer</application>
PluginFeature
subclasses.
A plugin should export a symbol <symbol>
gst_plugin_desc</symbol>
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
GstPluginInitFunc
function that was provided in the
<symbol>
gst_plugin_desc</symbol>
.
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
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 Plugin::load
can be needed to bring the plugin
into memory.
Implements
Methods
impl Plugin
[src]
impl Plugin
pub fn add_dependency(
&self,
env_vars: &[&str],
paths: &[&str],
names: &[&str],
flags: PluginDependencyFlags
)
[src]
pub fn add_dependency(
&self,
env_vars: &[&str],
paths: &[&str],
names: &[&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.
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 PluginDependencyFlags::None
pub fn add_dependency_simple<'a, 'b, 'c, P: Into<Option<&'a str>>, Q: Into<Option<&'b str>>, R: Into<Option<&'c str>>>(
&self,
env_vars: P,
paths: Q,
names: R,
flags: PluginDependencyFlags
)
[src]
pub fn add_dependency_simple<'a, 'b, 'c, P: Into<Option<&'a str>>, Q: Into<Option<&'b str>>, R: Into<Option<&'c str>>>(
&self,
env_vars: P,
paths: Q,
names: R,
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 Plugin::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 PluginDependencyFlags::None
pub fn get_description(&self) -> String
[src]
pub fn get_description(&self) -> String
pub fn get_filename(&self) -> Option<PathBuf>
[src]
pub fn get_filename(&self) -> Option<PathBuf>
pub fn get_license(&self) -> String
[src]
pub fn get_license(&self) -> String
pub fn get_origin(&self) -> String
[src]
pub fn get_origin(&self) -> String
pub fn get_package(&self) -> String
[src]
pub fn get_package(&self) -> String
pub fn get_release_date_string(&self) -> Option<String>
[src]
pub fn get_release_date_string(&self) -> Option<String>
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.
pub fn get_source(&self) -> String
[src]
pub fn get_source(&self) -> String
pub fn get_version(&self) -> String
[src]
pub fn get_version(&self) -> String
pub fn is_loaded(&self) -> bool
[src]
pub fn is_loaded(&self) -> bool
pub fn load(&self) -> Option<Plugin>
[src]
pub fn load(&self) -> Option<Plugin>
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.
pub fn load_by_name(name: &str) -> Option<Plugin>
[src]
pub fn load_by_name(name: &str) -> Option<Plugin>
Load the named plugin. Refs the plugin.
name
name of plugin to load
Returns
a reference to a loaded plugin, or
None
on error.
pub fn load_file<P: AsRef<Path>>(filename: P) -> Result<Plugin, Error>
[src]
pub fn load_file<P: AsRef<Path>>(filename: P) -> Result<Plugin, Error>
impl Plugin
[src]
impl Plugin
pub fn get_cache_data(&self) -> Option<&StructureRef>
[src]
pub fn get_cache_data(&self) -> Option<&StructureRef>
Gets the plugin specific data cache. If it is None
there is no cached data
stored. This is the case when the registry is getting rebuilt.
Returns
The cached data as a
Structure
or None
.
pub fn set_cache_data(&self, cache_data: Structure)
[src]
pub fn set_cache_data(&self, cache_data: Structure)
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
impl Clone for Plugin
impl Clone for Plugin
fn clone(&self) -> Plugin
fn clone(&self) -> Plugin
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Hash for Plugin
impl Hash for Plugin
fn hash<__H: Hasher>(&self, state: &mut __H)
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Ord for Plugin
impl Ord for Plugin
fn cmp(&self, other: &Plugin) -> Ordering
fn cmp(&self, other: &Plugin) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl StaticType for Plugin
impl StaticType for Plugin
fn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of Self
.
impl<T: IsA<Object>> PartialEq<T> for Plugin
impl<T: IsA<Object>> PartialEq<T> for Plugin
fn eq(&self, other: &T) -> bool
fn eq(&self, other: &T) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl Eq for Plugin
impl Eq for Plugin
impl<T: IsA<Object>> PartialOrd<T> for Plugin
impl<T: IsA<Object>> PartialOrd<T> for Plugin
fn partial_cmp(&self, other: &T) -> Option<Ordering>
fn partial_cmp(&self, other: &T) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Debug for Plugin
impl Debug for Plugin
impl IsA<Object> for Plugin
impl IsA<Object> for Plugin
impl IsA<Object> for Plugin
impl IsA<Object> for Plugin
impl Send for Plugin
[src]
impl Send for Plugin
impl Sync for Plugin
[src]
impl Sync for Plugin