// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use glib;
use glib::translate::*;
use glib::GString;
use gst_sys;
use DeviceProvider;
use Object;
use PluginFeature;
use Rank;

glib_wrapper! {
    /// `DeviceProviderFactory` is used to create instances of device providers. A
    /// GstDeviceProviderfactory can be added to a `Plugin` as it is also a
    /// `PluginFeature`.
    ///
    /// Use the `DeviceProviderFactory::find` and
    /// `DeviceProviderFactory::get` functions to create device
    /// provider instances or use `DeviceProviderFactory::get_by_name` as a
    /// convenient shortcut.
    ///
    /// # Implements
    ///
    /// [`PluginFeatureExt`](trait.PluginFeatureExt.html), [`GstObjectExt`](trait.GstObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`PluginFeatureExtManual`](prelude/trait.PluginFeatureExtManual.html)
    pub struct DeviceProviderFactory(Object<gst_sys::GstDeviceProviderFactory, gst_sys::GstDeviceProviderFactoryClass, DeviceProviderFactoryClass>) @extends PluginFeature, Object;

    match fn {
        get_type => || gst_sys::gst_device_provider_factory_get_type(),
    }
}

impl DeviceProviderFactory {
    /// Returns the device provider of the type defined by the given device
    /// providerfactory.
    ///
    /// # Returns
    ///
    /// the `DeviceProvider` or `None`
    /// if the device provider couldn't be created
    pub fn get(&self) -> Option<DeviceProvider> {
        unsafe {
            from_glib_full(gst_sys::gst_device_provider_factory_get(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the `glib::Type` for device providers managed by this factory. The type can
    /// only be retrieved if the device provider factory is loaded, which can be
    /// assured with `PluginFeatureExt::load`.
    ///
    /// # Returns
    ///
    /// the `glib::Type` for device providers managed by this factory.
    pub fn get_device_provider_type(&self) -> glib::types::Type {
        unsafe {
            from_glib(
                gst_sys::gst_device_provider_factory_get_device_provider_type(
                    self.to_glib_none().0,
                ),
            )
        }
    }

    /// 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(&self, key: &str) -> Option<GString> {
        unsafe {
            from_glib_none(gst_sys::gst_device_provider_factory_get_metadata(
                self.to_glib_none().0,
                key.to_glib_none().0,
            ))
        }
    }

    /// 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_metadata_keys(&self) -> Vec<GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(
                gst_sys::gst_device_provider_factory_get_metadata_keys(self.to_glib_none().0),
            )
        }
    }

    /// Check if `self` matches all of the given `classes`
    /// ## `classes`
    /// a "/" separate list of classes to match, only match
    ///  if all classes are matched
    ///
    /// # Returns
    ///
    /// `true` if `self` matches or if `classes` is `None`.
    pub fn has_classes(&self, classes: Option<&str>) -> bool {
        unsafe {
            from_glib(gst_sys::gst_device_provider_factory_has_classes(
                self.to_glib_none().0,
                classes.to_glib_none().0,
            ))
        }
    }

    /// Check if `self` matches all of the given classes
    /// ## `classes`
    /// a `None` terminated array
    ///  of classes to match, only match if all classes are matched
    ///
    /// # Returns
    ///
    /// `true` if `self` matches.
    pub fn has_classesv(&self, classes: &[&str]) -> bool {
        unsafe {
            from_glib(gst_sys::gst_device_provider_factory_has_classesv(
                self.to_glib_none().0,
                classes.to_glib_none().0,
            ))
        }
    }

    /// Search for an device provider factory of the given name. Refs the returned
    /// device provider factory; caller is responsible for unreffing.
    /// ## `name`
    /// name of factory to find
    ///
    /// # Returns
    ///
    /// `DeviceProviderFactory` if
    /// found, `None` otherwise
    pub fn find(name: &str) -> Option<DeviceProviderFactory> {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(gst_sys::gst_device_provider_factory_find(
                name.to_glib_none().0,
            ))
        }
    }

    /// Returns the device provider of the type defined by the given device
    /// provider factory.
    /// ## `factoryname`
    /// a named factory to instantiate
    ///
    /// # Returns
    ///
    /// a `DeviceProvider` or `None`
    /// if unable to create device provider
    pub fn get_by_name(factoryname: &str) -> Option<DeviceProvider> {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(gst_sys::gst_device_provider_factory_get_by_name(
                factoryname.to_glib_none().0,
            ))
        }
    }

    /// Get a list of factories with a rank greater or equal to `minrank`.
    /// The list of factories is returned by decreasing rank.
    /// ## `minrank`
    /// Minimum rank
    ///
    /// # Returns
    ///
    ///
    /// a `glib::List` of `DeviceProviderFactory` device providers. Use
    /// `PluginFeature::list_free` after usage.
    pub fn list_get_device_providers(minrank: Rank) -> Vec<DeviceProviderFactory> {
        assert_initialized_main_thread!();
        unsafe {
            FromGlibPtrContainer::from_glib_full(
                gst_sys::gst_device_provider_factory_list_get_device_providers(minrank.to_glib()),
            )
        }
    }
}

unsafe impl Send for DeviceProviderFactory {}
unsafe impl Sync for DeviceProviderFactory {}