Skip to main content

Options

Struct Options 

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

What to build around the audio.

Implementations§

Source§

impl Options

Source

pub fn new(name: impl Into<String>) -> Options

Defaults: the name given, root key C4, the editor’s own top note, the editor’s record coding, no loop, the v2 generation.

Source

pub fn layout(self, layout: Layout) -> Options

Which generation to write: .nsmp, .nsmp3 or .nsmp4. The audio is the same object in all three — what moves is the container and the stream’s units.

Source

pub fn secondary_start(self, frames: f64) -> Options

Resynchronise the stream at frames source frames from the first one — a project’s m_startSecondary, measured from its m_start. Unset, the stream resynchronises where a fresh project would put it: default_secondary_start.

Source

pub fn channels(self, channels: u16) -> Options

How many channels the PCM interleaves — 1 or 2. Anything else is refused when the instrument is built.

Source

pub fn shift(self, bits: u8) -> Options

Quantise at bits of shift instead of what the shift rule picks. Experimental: a lever for laying the same stroke out at neighbouring shifts, not a setting the editor exposes.

Source

pub fn loops(self, points: Loop) -> Options

Loop the stroke, which also truncates it at Loop::end.

Source

pub fn root_key(self, note: u8) -> Options

The MIDI note the sample plays untransposed at.

Source

pub fn top_note(self, note: u8) -> Options

The highest note the zone covers. Defaults to two octaves above the root, which is the layout the editor lays down for a single zone.

Source

pub fn predictor(self, predictor: Predictor) -> Options

Trait Implementations§

Source§

impl Clone for Options

Source§

fn clone(&self) -> Options

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Options

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.