Struct gstreamer_pbutils::EncodingTarget

pub struct EncodingTarget(_, _);

Collection of EncodingProfile for a specific target or use-case.

When being stored/loaded, targets come from a specific category, like GST_ENCODING_CATEGORY_DEVICE.

Implements

glib::object::ObjectExt

Methods

impl EncodingTarget

pub fn new(
    name: &str,
    category: &str,
    description: &str,
    profiles: &[EncodingProfile]
) -> EncodingTarget

Creates a new 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 <emphasis>should</emphasis> be one of the existing well-defined categories, like GST_ENCODING_CATEGORY_DEVICE, but it <emphasis>can</emphasis> 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 in the current locale.

profiles

A glib::List of EncodingProfile.

Returns

The newly created EncodingTarget or None if there was an error.

pub fn get_category(&self) -> GString

Returns

The category of the self. For example: GST_ENCODING_CATEGORY_DEVICE.

pub fn get_description(&self) -> GString

Returns

The description of the self.

pub fn get_name(&self) -> GString

Returns

The name of the self.

pub fn get_profile(&self, name: &str) -> Option<EncodingProfile>

name

the name of the profile to retrieve

Returns

The matching EncodingProfile, or None.

pub fn get_profiles(&self) -> Vec<EncodingProfile>

Returns

A list of EncodingProfile(s) this self handles.

pub fn save(&self) -> Result<(), Error>

Saves the self to a default user-local directory.

Returns

true if the target was correctly saved, else false.

pub fn save_to_file<P: AsRef<Path>>(&self, filepath: P) -> Result<(), 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.

pub fn load(name: &str, category: Option<&str>) -> Result<EncodingTarget, Error>

Searches for the 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 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 if available, else None.

pub fn load_from_file<P: AsRef<Path>>(
    filepath: P
) -> Result<EncodingTarget, Error>

Opens the provided file and returns the contained EncodingTarget.

filepath

The file location to load the EncodingTarget from

Returns

The EncodingTarget contained in the file, else None

Trait Implementations

impl Clone for EncodingTarget

fn clone(&self) -> EncodingTarget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncodingTarget

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

Formats the value using the given formatter.

impl Eq for EncodingTarget

impl Hash for EncodingTarget

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for EncodingTarget

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for EncodingTarget

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for EncodingTarget

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

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[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.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[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.

impl Send for EncodingTarget

impl StaticType for EncodingTarget

fn static_type() -> Type

Returns the type identifier of Self.

impl Sync for EncodingTarget