Skip to main content

InfoBuilder

Struct InfoBuilder 

Source
pub struct InfoBuilder { /* private fields */ }
Expand description

Use this to instantiate Info

Implementations§

Source§

impl InfoBuilder

Source

pub fn new_effect(long_name: &str, short_name: &str, num_params: u32) -> Self

Initializer for an effect.

This is the most basic type.

Source

pub fn new_full_gen(long_name: &str, short_name: &str, num_params: u32) -> Self

Initializer for a full standalone generator.

This is a combination of generator and note_input.

Source

pub fn new_visual(long_name: &str, short_name: &str, num_params: u32) -> Self

Initializer for a purely visual plugin, that doesn’t process any audio data.

It’s a basic plugin with no_process enabled.

Source

pub fn with_poly(self, poly: u32) -> Self

Set prefered (default) maximum polyphony.

Source

pub fn with_out_ctrls(self, out_ctrls: u32) -> Self

Set number of internal output controllers.

Source

pub fn with_out_voices(self, out_voices: u32) -> Self

Set number of internal output voices.

Source

pub fn generator(self) -> Self

The plugin is a generator (as opposed to an effect).

Source

pub fn get_chan_custom_shape(self) -> Self

The plugin will use a sample that the user loads into the plugin’s channel.

Source

pub fn get_note_input(self) -> Self

The plugin reacts to note events.

Source

pub fn want_new_tick(self) -> Self

The plugin will be notified on each tick and be able to control params (like a built-in MIDI controller).

Source

pub fn no_process(self) -> Self

The plugin won’t process buffers at all (want_new_tick, or special visual plugins (Fruity NoteBook))

Source

pub fn no_window(self) -> Self

The plugin’s editor window should be shown inside the channel properties window.

Source

pub fn interfaceless(self) -> Self

(not used yet) The plugin doesn’t provide its own interface, but relies on the host to create one.

Source

pub fn time_warp(self) -> Self

(not used yet) The plugin supports timewarps, that is can be told to change the playing position in a voice (direct from disk music tracks, …).

Source

pub fn midi_out(self) -> Self

The plugin will send MIDI out messages. Only plugins specifying this option will be enabled when rendering to a midi file.

Source

pub fn demo_version(self) -> Self

The plugin is a demo version. Practically this means the host won’t save its automation.

Source

pub fn can_send(self) -> Self

The plugin has access to the send tracks, so it can’t be dropped into a send track or into the master.

Source

pub fn loop_out(self) -> Self

The plugin will send delayed messages to itself (will require the internal sync clock to be enabled).

Source

pub fn get_chan_sample(self) -> Self

This plugin as a generator will use the sample loaded in its parent channel (see host::Message::ChanSampleChanged).

Source

pub fn want_fit_time(self) -> Self

Fit to time selector will appear in channel settings window (see host::Message::SetFitTime).

Source

pub fn cant_smart_disable(self) -> Self

Plugin can’t be smart disabled.

Source

pub fn want_settings_button(self) -> Self

Plugin wants a settings button on the titlebar (mainly for the wrapper).

Source

pub fn build(self) -> Info

Finish builder and init Info

Trait Implementations§

Source§

impl Clone for InfoBuilder

Source§

fn clone(&self) -> InfoBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InfoBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.