Enum ProcessStatus 

#[repr(i32)]
pub enum ProcessStatus {
    Continue = 1,
    ContinueIfNotQuiet = 2,
    Tail = 3,
    Sleep = 4,
}

Status returned by a plugin after processing.

This is mainly used as a way for the plugin to tell the host when it can be safely put to sleep.

Note that Clack uses a Result enum for relaying a failed processing to the host, unlike the C CLAP API which uses an extra state in enum (CLAP_PROCESS_ERROR) to indicate failure.

Variants

Continue = 1

Processing should continue: the plugin has no desire to be put to sleep.

ContinueIfNotQuiet = 2

Processing should continue, unless all outputs are quiet.

Tail = 3

The plugin is currently processing its tail (e.g. release, reverb, etc.).

Use the tail extension to query the plugin for its current tail length.

Sleep = 4

No more processing is required until the next event or variation in audio input.

Implementations

impl ProcessStatus

pub fn from_raw(raw: clap_process_status) -> Option<Result<Self, ()>>

Gets a ProcessStatus from the raw, C-FFI compatible value.

In order to match Clack’s APIs, this returns Some(Err(())) if the value is CLAP_PROCESS_ERROR.

If the given integer does not match any known CLAP Processing status codes, None is returned.

pub fn combined_with(self, other: ProcessStatus) -> ProcessStatus

Combines two ProcessStatuses, returning one that meets the minimum processing requirements of both statuses.

Trait Implementations

impl Clone for ProcessStatus

fn clone(&self) -> ProcessStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProcessStatus

impl Debug for ProcessStatus

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

Formats the value using the given formatter.

impl Eq for ProcessStatus

impl PartialEq for ProcessStatus

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ProcessStatus