Struct gstreamer::ElementFactory

pub struct ElementFactory { /* private fields */ }

ElementFactory is used to create instances of elements. A GstElementFactory can be added to a Plugin as it is also a PluginFeature.

Use the find() and create_with_name() functions to create element instances or use make_with_name() as a convenient shortcut.

The following code example shows you how to create a GstFileSrc element.

Using an element factory

⚠️ The following code is in C ⚠️

  #include <gst/gst.h>

  GstElement *src;
  GstElementFactory *srcfactory;

  gst_init (&argc, &argv);

  srcfactory = gst_element_factory_find ("filesrc");
  g_return_if_fail (srcfactory != NULL);
  src = gst_element_factory_create (srcfactory, "src");
  g_return_if_fail (src != NULL);
  ...

Implements

PluginFeatureExt, GstObjectExt, [trait@glib::ObjectExt], PluginFeatureExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl ElementFactory

pub fn element_type(&self) -> Type

Get the GType for elements managed by this factory. The type can only be retrieved if the element factory is loaded, which can be assured with PluginFeatureExtManual::load().

Returns

the GType for elements managed by this factory or 0 if the factory is not loaded.

pub fn metadata_keys(&self) -> Vec<GString>

Get the available keys for the metadata on self.

Returns

a None-terminated array of key strings, or None when there is no metadata. Free with g_strfreev() when no longer needed.

pub fn num_pad_templates(&self) -> u32

Gets the number of pad_templates in this factory.

Returns

the number of pad_templates

pub fn skips_documentation(&self) -> bool

Queries whether registered element managed by self needs to be excluded from documentation system or not.

Returns

true if documentation should be skipped

pub fn uri_protocols(&self) -> Vec<GString>

Gets a None-terminated array of protocols this element supports or None if no protocols are supported. You may not change the contents of the returned array, as it is still owned by the element factory. Use g_strdupv() to make a copy of the protocol string array if you need to.

Returns

the supported protocols or None

pub fn uri_type(&self) -> URIType

Gets the type of URIs the element supports or URIType::Unknown if none.

Returns

type of URIs this element supports

pub fn has_interface(&self, interfacename: &str) -> bool

Check if self implements the interface with name interfacename.

interfacename

an interface name

Returns

true when self implement the interface.

pub fn find(name: &str) -> Option<ElementFactory>

Search for an element factory of the given name. Refs the returned element factory; caller is responsible for unreffing.

name

name of factory to find

Returns

ElementFactory if found, None otherwise

impl ElementFactory

pub fn create(&self) -> ElementBuilder<'_>

pub fn make(factoryname: &str) -> ElementBuilder<'_>

pub fn create_with_name(&self, name: Option<&str>) -> Result<Element, BoolError>

Create a new element of the type defined by the given elementfactory. It will be given the name supplied, since all elements require a name as their first argument.

name

name of new element, or None to automatically create a unique name

Returns

new Element or None if the element couldn’t be created

pub fn make_with_name( factoryname: &str, name: Option<&str>, ) -> Result<Element, BoolError>

Create a new element of the type defined by the given element factory. If name is None, then the element will receive a guaranteed unique name, consisting of the element factory name and a number. If name is given, it will be given the name supplied.

factoryname

a named factory to instantiate

name

name of new element, or None to automatically create a unique name

Returns

new Element or None if unable to create element

pub fn static_pad_templates(&self) -> List<StaticPadTemplate>

Gets the GList of StaticPadTemplate for this factory.

Returns

the static pad templates

pub fn has_type(&self, type_: ElementFactoryType) -> bool

Check if self is of the given types.

type_

a GstElementFactoryListType

Returns

true if self is of type_.

pub fn factories_with_type( type_: ElementFactoryType, minrank: Rank, ) -> List<ElementFactory>

Get a list of factories that match the given type_. Only elements with a rank greater or equal to minrank will be returned. The list of factories is returned by decreasing rank.

type_

a GstElementFactoryListType

minrank

Minimum rank

Returns

a GList of ElementFactory elements. Use gst_plugin_feature_list_free() after usage.

pub fn metadata(&self, key: &str) -> Option<&str>

Get the metadata on self with key.

key

a key

Returns

the metadata with key on self or None when there was no metadata with the given key.

pub fn longname(&self) -> &str

pub fn klass(&self) -> &str

pub fn description(&self) -> &str

pub fn author(&self) -> &str

pub fn documentation_uri(&self) -> Option<&str>

pub fn icon_name(&self) -> Option<&str>

pub fn can_sink_all_caps(&self, caps: &CapsRef) -> bool

Checks if the factory can sink all possible capabilities.

caps

the caps to check

Returns

true if the caps are fully compatible.

pub fn can_sink_any_caps(&self, caps: &CapsRef) -> bool

Checks if the factory can sink any possible capability.

caps

the caps to check

Returns

true if the caps have a common subset.

pub fn can_src_all_caps(&self, caps: &CapsRef) -> bool

Checks if the factory can src all possible capabilities.

caps

the caps to check

Returns

true if the caps are fully compatible.

pub fn can_src_any_caps(&self, caps: &CapsRef) -> bool

Checks if the factory can src any possible capability.

caps

the caps to check

Returns

true if the caps have a common subset.

Trait Implementations

impl Clone for ElementFactory

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ElementFactory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for ElementFactory

type ParamSpec = ParamSpecObject

type SetValue = ElementFactory

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ElementFactory>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ElementFactory

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ElementFactory

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for ElementFactory

type Parent = PluginFeature

impl<OT: ObjectType> PartialEq<OT> for ElementFactory

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ElementFactory

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ElementFactory

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ElementFactory

impl IsA<Object> for ElementFactory

impl IsA<PluginFeature> for ElementFactory

impl Send for ElementFactory

impl Sync for ElementFactory