[][src]Struct gstreamer::ElementFactory

pub struct ElementFactory(_, _);

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

Use the ElementFactory::find and ElementFactory::create functions to create element instances or use ElementFactory::make as a convenient shortcut.

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

Using an element factory

  #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, glib::object::ObjectExt, PluginFeatureExtManual

Methods

impl ElementFactory[src]

pub fn can_sink_all_caps(&self, caps: &Caps) -> bool[src]

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: &Caps) -> bool[src]

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: &Caps) -> bool[src]

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: &Caps) -> bool[src]

Checks if the factory can src any possible capability.

caps

the caps to check

Returns

true if the caps have a common subset.

pub fn create(&self, name: Option<&str>) -> Result<Element, BoolError>[src]

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 get_element_type(&self) -> Type[src]

Get the glib::Type for elements managed by this factory. The type can only be retrieved if the element factory is loaded, which can be assured with PluginFeatureExt::load.

Returns

the glib::Type for elements managed by this factory or 0 if the factory is not loaded.

pub fn get_metadata(&self, key: &str) -> Option<GString>[src]

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 get_metadata_keys(&self) -> Vec<GString>[src]

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 get_num_pad_templates(&self) -> u32[src]

Gets the number of pad_templates in this factory.

Returns

the number of pad_templates

pub fn get_static_pad_templates(&self) -> Vec<StaticPadTemplate>[src]

Gets the glib::List of StaticPadTemplate for this factory.

Returns

the static pad templates

pub fn get_uri_protocols(&self) -> Vec<GString>[src]

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 get_uri_type(&self) -> URIType[src]

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[src]

Check if self implements the interface with name interfacename.

interfacename

an interface name

Returns

true when self implement the interface.

pub fn list_is_type(&self, type_: ElementFactoryListType) -> bool[src]

Check if self is of the given types.

type_

a ElementFactoryListType

Returns

true if self is of type_.

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

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

pub fn list_filter(
    list: &[ElementFactory],
    caps: &Caps,
    direction: PadDirection,
    subsetonly: bool
) -> Vec<ElementFactory>
[src]

Filter out all the elementfactories in list that can handle caps in the given direction.

If subsetonly is true, then only the elements whose pads templates are a complete superset of caps will be returned. Else any element whose pad templates caps can intersect with caps will be returned.

list

a glib::List of ElementFactory to filter

caps

a Caps

direction

a PadDirection to filter on

subsetonly

whether to filter on caps subsets or not.

Returns

a glib::List of ElementFactory elements that match the given requisites. Use PluginFeature::list_free after usage.

pub fn list_get_elements(
    type_: ElementFactoryListType,
    minrank: Rank
) -> Vec<ElementFactory>
[src]

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 ElementFactoryListType

minrank

Minimum rank

Returns

a glib::List of ElementFactory elements. Use PluginFeature::list_free after usage.

pub fn make(factoryname: &str, name: Option<&str>) -> Result<Element, BoolError>[src]

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

Trait Implementations

impl Clone for ElementFactory[src]

impl Debug for ElementFactory[src]

impl Eq for ElementFactory[src]

impl Hash for ElementFactory[src]

impl IsA<Object> for ElementFactory[src]

impl IsA<PluginFeature> for ElementFactory[src]

impl Ord for ElementFactory[src]

impl<T: ObjectType> PartialEq<T> for ElementFactory[src]

impl<T: ObjectType> PartialOrd<T> for ElementFactory[src]

impl Send for ElementFactory[src]

impl StaticType for ElementFactory[src]

impl Sync for ElementFactory[src]

Auto Trait Implementations

impl RefUnwindSafe for ElementFactory

impl Unpin for ElementFactory

impl UnwindSafe for ElementFactory

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<Super, Sub> CanDowncast<Sub> for Super where
    Sub: IsA<Super>,
    Super: IsA<Super>, 
[src]

impl<T> Cast for T where
    T: ObjectType
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ObjectExt for T where
    T: ObjectType
[src]

impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 
[src]

impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 
[src]

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 
[src]

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 
[src]

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToSendValue for T where
    T: ToValue + SetValue + Send + ?Sized
[src]

impl<T> ToValue for T where
    T: SetValue + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.