PresetExt

gstreamer::prelude

Trait PresetExt 

Source 
pub trait PresetExt: IsA<Preset> + 'static {
    // Provided methods
    fn delete_preset(&self, name: &str) -> Result<(), BoolError> { ... }
    fn meta(&self, name: &str, tag: &str) -> Option<GString> { ... }
    fn preset_names(&self) -> Vec<GString> { ... }
    fn property_names(&self) -> Vec<GString> { ... }
    fn is_editable(&self) -> bool { ... }
    fn load_preset(&self, name: &str) -> Result<(), BoolError> { ... }
    fn rename_preset(
        &self,
        old_name: &str,
        new_name: &str,
    ) -> Result<(), BoolError> { ... }
    fn save_preset(&self, name: &str) -> Result<(), BoolError> { ... }
    fn set_meta(
        &self,
        name: &str,
        tag: &str,
        value: Option<&str>,
    ) -> Result<(), BoolError> { ... }
}
Expand description

Trait containing all Preset methods.

§Implementors

Preset

Provided Methods§

Source

fn delete_preset(&self, name: &str) -> Result<(), BoolError>

Delete the given preset.

§name

preset name to remove

§Returns

true for success, false if e.g. there is no preset with that name

Source

fn meta(&self, name: &str, tag: &str) -> Option<GString>

Gets the value for an existing meta data tag. Meta data tag names can be something like e.g. “comment”. Returned values need to be released when done.

§name

preset name

§tag

meta data item name

§Returns

true for success, false if e.g. there is no preset with that name or no value for the given tag

§value

value

Source

fn preset_names(&self) -> Vec<GString>

Get a copy of preset names as a None terminated string array.

§Returns

list with names, use g_strfreev() after usage.

Source

fn property_names(&self) -> Vec<GString>

Get a the names of the GObject properties that can be used for presets.

§Returns

an array of property names which should be freed with g_strfreev() after use.

Source

fn is_editable(&self) -> bool

Check if one can add new presets, change existing ones and remove presets.

§Returns

true if presets are editable or false if they are static

Source

fn load_preset(&self, name: &str) -> Result<(), BoolError>

Load the given preset.

§name

preset name to load

§Returns

true for success, false if e.g. there is no preset with that name

Source

fn rename_preset(&self, old_name: &str, new_name: &str) -> Result<(), BoolError>

Renames a preset. If there is already a preset by the new_name it will be overwritten.

§old_name

current preset name

§new_name

new preset name

§Returns

true for success, false if e.g. there is no preset with old_name

Source

fn save_preset(&self, name: &str) -> Result<(), BoolError>

Save the current object settings as a preset under the given name. If there is already a preset by this name it will be overwritten.

§name

preset name to save

§Returns

true for success, false

Source

fn set_meta( &self, name: &str, tag: &str, value: Option<&str>, ) -> Result<(), BoolError>

Sets a new value for an existing meta data item or adds a new item. Meta data tag names can be something like e.g. “comment”. Supplying None for the value will unset an existing value.

§name

preset name

§tag

meta data item name

§value

new value

§Returns

true for success, false if e.g. there is no preset with that name

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl<O: IsA<Preset>> PresetExt for O