Struct vapoursynth::plugin::Plugin

pub struct Plugin<'core> { /* private fields */ }

A VapourSynth plugin.

Implementations

impl<'core> Plugin<'core>

pub fn functions(&self) -> OwnedMap<'core>

Returns a map containing a list of the filters exported by a plugin.

Keys: the filter names;

Values: the filter name followed by its argument string, separated by a semicolon.

pub fn path(&self) -> Option<&'core CStr>

Returns the absolute path to the plugin, including the plugin’s file name. This is the real location of the plugin, i.e. there are no symbolic links in the path.

Path elements are always delimited with forward slashes.

pub fn invoke(
    &self,
    name: &str,
    args: &Map<'core>
) -> Result<OwnedMap<'core>, NulError>

Invokes a filter.

invoke() makes sure the filter has no compat input nodes, checks that the args passed to the filter are consistent with the argument list registered by the plugin that contains the filter, creates the filter, and checks that the filter doesn’t return any compat nodes. If everything goes smoothly, the filter will be ready to generate frames after invoke() returns.

Returns a map containing the filter’s return value(s). Use Map::error() to check if the filter was invoked successfully.

Most filters will either add an error to the map, or one or more clips with the key clip. The exception to this are functions, for example LoadPlugin, which doesn’t return any clips for obvious reasons.

pub fn register_function<F: FilterFunction>(
    &self,
    filter_function: F
) -> Result<(), NulError>

Registers a filter function to be exported by a non-readonly plugin.

Trait Implementations

impl<'core> Clone for Plugin<'core>

fn clone(&self) -> Plugin<'core>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'core> Debug for Plugin<'core>

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

Formats the value using the given formatter.

impl<'core> Copy for Plugin<'core>

impl<'core> Send for Plugin<'core>

impl<'core> Sync for Plugin<'core>