Struct vapoursynth::node::Node

pub struct Node<'core> { /* fields omitted */ }

A reference to a node in the constructed filter graph.

Methods

impl<'core> Node<'core>

pub fn info(&self) -> VideoInfo<'core>

Returns the video info associated with this Node.

pub fn get_frame<'error>(
    &self,
    n: usize
) -> Result<FrameRef<'core>, GetFrameError<'error>>

Generates a frame directly.

The 'error lifetime is unbounded because this function always returns owned data.

Panics

Panics is n is greater than i32::max_value().

pub fn get_frame_async<F>(&self, n: usize, callback: F) where
    F: FnOnce(Result<FrameRef<'core>, GetFrameError>, usize, Node<'core>) + Send + 'core, 

Requests the generation of a frame. When the frame is ready, a user-provided function is called.

If multiple frames were requested, they can be returned in any order.

The callback arguments are:

• the generated frame or an error message if the generation failed,
• the frame number (equal to n),
• the node that generated the frame (the same as self).

If the callback panics, the process is aborted.

Panics

Panics is n is greater than i32::max_value().

pub fn request_frame_filter(&self, context: FrameContext, n: usize)

Requests a frame from a node and returns immediately.

This is only used in filters' "get frame" functions.

A filter usually calls this function from get_frame_initial(). The requested frame can then be retrieved using get_frame_filter() from within filter's get_frame() function.

It is safe to request a frame more than once. An unimportant consequence of requesting a frame more than once is that the filter's get_frame() function may be called more than once for the same frame.

It is best to request frames in ascending order, i.e. n, n+1, n+2, etc.

Panics

Panics is n is greater than i32::max_value().

pub fn get_frame_filter(
    &self,
    context: FrameContext,
    n: usize
) -> Option<FrameRef<'core>>

Retrieves a frame that was previously requested with request_frame_filter().

A filter usually calls this function from get_frame(). It is safe to retrieve a frame more than once.

Panics

Panics is n is greater than i32::max_value().

Trait Implementations

impl<'map, 'elem: 'map> Value<'map, 'elem> for Node<'elem>

fn get_from_map(map: &Map<'elem>, key: &str) -> Result<Self>

Retrieves the value from the map.

fn get_iter_from_map(
    map: &'map Map<'elem>,
    key: &str
) -> Result<ValueIter<'map, 'elem, Self>>

Retrieves an iterator over the values from the map.

fn store_in_map(map: &mut Map<'elem>, key: &str, x: &Self) -> Result<()>

Sets the property value in the map.

fn append_to_map(map: &mut Map<'elem>, key: &str, x: &Self) -> Result<()>

Appends the value to the map.

impl<'map, 'elem: 'map> FilterArgument<'map, 'elem> for Node<'elem>

fn type_name() -> &'static str

Returns the VapourSynth type name for this argument type.

impl<'core> Send for Node<'core>

impl<'core> Sync for Node<'core>

impl<'core> Drop for Node<'core>

fn drop(&mut self)

Executes the destructor for this type.

impl<'core> Clone for Node<'core>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'core> Debug for Node<'core>

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

Formats the value using the given formatter.