gstreamer_pbutils/auto/

encoding_target.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::{ffi, EncodingProfile};
use glib::translate::*;

glib::wrapper! {
    /// Collection of [`EncodingProfile`][crate::EncodingProfile] for a specific target or use-case.
    ///
    /// When being stored/loaded, targets come from a specific category, like
    /// `GST_ENCODING_CATEGORY_DEVICE`.
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GstEncodingTarget")]
    pub struct EncodingTarget(Object<ffi::GstEncodingTarget>);

    match fn {
        type_ => || ffi::gst_encoding_target_get_type(),
    }
}

impl EncodingTarget {
    /// Creates a new [`EncodingTarget`][crate::EncodingTarget].
    ///
    /// The name and category can only consist of lowercase ASCII letters for the
    /// first character, followed by either lowercase ASCII letters, digits or
    /// hyphens ('-').
    ///
    /// The `category` *should* be one of the existing
    /// well-defined categories, like `GST_ENCODING_CATEGORY_DEVICE`, but it
    /// *can* be a application or user specific category if
    /// needed.
    /// ## `name`
    /// The name of the target.
    /// ## `category`
    /// The name of the category to which this `target`
    /// belongs. For example: `GST_ENCODING_CATEGORY_DEVICE`.
    /// ## `description`
    /// A description of [`EncodingTarget`][crate::EncodingTarget] in the
    /// current locale.
    /// ## `profiles`
    /// A `GList` of
    /// [`EncodingProfile`][crate::EncodingProfile].
    ///
    /// # Returns
    ///
    /// The newly created [`EncodingTarget`][crate::EncodingTarget] or [`None`] if
    /// there was an error.
    #[doc(alias = "gst_encoding_target_new")]
    pub fn new(
        name: &str,
        category: &str,
        description: &str,
        profiles: &[EncodingProfile],
    ) -> Result<EncodingTarget, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_encoding_target_new(
                name.to_glib_none().0,
                category.to_glib_none().0,
                description.to_glib_none().0,
                profiles.to_glib_none().0,
            ))
            .ok_or_else(|| glib::bool_error!("Failed to create EncodingTarget"))
        }
    }

    ///
    /// # Returns
    ///
    /// The category of the `self`. For example:
    /// `GST_ENCODING_CATEGORY_DEVICE`.
    #[doc(alias = "gst_encoding_target_get_category")]
    #[doc(alias = "get_category")]
    pub fn category(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gst_encoding_target_get_category(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// The description of the `self`.
    #[doc(alias = "gst_encoding_target_get_description")]
    #[doc(alias = "get_description")]
    pub fn description(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gst_encoding_target_get_description(
                self.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// The name of the `self`.
    #[doc(alias = "gst_encoding_target_get_name")]
    #[doc(alias = "get_name")]
    pub fn name(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gst_encoding_target_get_name(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// The path to the `self` file.
    #[cfg(feature = "v1_18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_18")))]
    #[doc(alias = "gst_encoding_target_get_path")]
    #[doc(alias = "get_path")]
    pub fn path(&self) -> Option<std::path::PathBuf> {
        unsafe { from_glib_none(ffi::gst_encoding_target_get_path(self.to_glib_none().0)) }
    }

    /// ## `name`
    /// the name of the profile to retrieve
    ///
    /// # Returns
    ///
    /// The matching [`EncodingProfile`][crate::EncodingProfile], or [`None`].
    #[doc(alias = "gst_encoding_target_get_profile")]
    #[doc(alias = "get_profile")]
    pub fn profile(&self, name: &str) -> Option<EncodingProfile> {
        unsafe {
            from_glib_full(ffi::gst_encoding_target_get_profile(
                self.to_glib_none().0,
                name.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// A list of
    /// [`EncodingProfile`][crate::EncodingProfile](s) this `self` handles.
    #[doc(alias = "gst_encoding_target_get_profiles")]
    #[doc(alias = "get_profiles")]
    pub fn profiles(&self) -> Vec<EncodingProfile> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::gst_encoding_target_get_profiles(
                self.to_glib_none().0,
            ))
        }
    }

    /// Saves the `self` to a default user-local directory.
    ///
    /// # Returns
    ///
    /// [`true`] if the target was correctly saved, else [`false`].
    #[doc(alias = "gst_encoding_target_save")]
    pub fn save(&self) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_encoding_target_save(self.to_glib_none().0, &mut error);
            debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Saves the `self` to the provided file location.
    /// ## `filepath`
    /// the location to store the `self` at.
    ///
    /// # Returns
    ///
    /// [`true`] if the target was correctly saved, else [`false`].
    #[doc(alias = "gst_encoding_target_save_to_file")]
    pub fn save_to_file(&self, filepath: impl AsRef<std::path::Path>) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_encoding_target_save_to_file(
                self.to_glib_none().0,
                filepath.as_ref().to_glib_none().0,
                &mut error,
            );
            debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Searches for the [`EncodingTarget`][crate::EncodingTarget] with the given name, loads it
    /// and returns it.
    ///
    /// If the category name is specified only targets from that category will be
    /// searched for.
    /// ## `name`
    /// the name of the [`EncodingTarget`][crate::EncodingTarget] to load (automatically
    /// converted to lower case internally as capital letters are not
    /// valid for target names).
    /// ## `category`
    /// the name of the target category, like
    /// `GST_ENCODING_CATEGORY_DEVICE`. Can be [`None`]
    ///
    /// # Returns
    ///
    /// The [`EncodingTarget`][crate::EncodingTarget] if available, else [`None`].
    #[doc(alias = "gst_encoding_target_load")]
    pub fn load(name: &str, category: Option<&str>) -> Result<EncodingTarget, glib::Error> {
        assert_initialized_main_thread!();
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::gst_encoding_target_load(
                name.to_glib_none().0,
                category.to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Opens the provided file and returns the contained [`EncodingTarget`][crate::EncodingTarget].
    /// ## `filepath`
    /// The file location to load the [`EncodingTarget`][crate::EncodingTarget] from
    ///
    /// # Returns
    ///
    /// The [`EncodingTarget`][crate::EncodingTarget] contained in the file, else
    /// [`None`]
    #[doc(alias = "gst_encoding_target_load_from_file")]
    pub fn load_from_file(
        filepath: impl AsRef<std::path::Path>,
    ) -> Result<EncodingTarget, glib::Error> {
        assert_initialized_main_thread!();
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::gst_encoding_target_load_from_file(
                filepath.as_ref().to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }
}

impl std::fmt::Display for EncodingTarget {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.write_str(&self.name())
    }
}

unsafe impl Send for EncodingTarget {}
unsafe impl Sync for EncodingTarget {}