Struct VitalModel 

pub struct VitalModel { /* private fields */ }

A decoded .vital preset.

Duplicate keys in one object keep the first position and the last value, as the JSON reader does.

Implementations

impl VitalModel

pub fn root(&self) -> &Map<String, Value>

The JSON tree as read, in file order.

impl VitalModel

pub fn route( &mut self, source: &str, destination: &str, amount: f64, polarity: Option<RoutePolarity>, power: Option<f64>, ) -> Result<usize, FormatError>

Adds a route, or updates the slot that joins the same source and destination, so a route never fires twice. It writes the amount, the bipolar flag and, when given, the curve power. An update keeps the slot’s power when none is given, and always keeps its stereo and bypass flags. A new route starts them from their defaults: power 0, stereo and bypass off.

Errors

A FormatError for an unknown source (it lists the 32 names), a destination outside the registry (it lists close names), an amount outside -1 to 1, a power outside -10 to 10, or a full matrix (it names the 64-slot limit).

pub fn clear_route(&mut self, slot: usize) -> Result<(), FormatError>

Empties a slot and resets its five controls to their defaults.

Errors

A FormatError for a slot outside 0 to 63.

pub fn set_wavetable( &mut self, index: usize, table: &Wavetable, ) -> Result<(), FormatError>

Writes the wavetable of oscillator index (0 to 2), one Wave Source component with the keyframes sorted by position. The table asks the synth not to remove DC or normalise, so the frames stay as written.

Errors

A FormatError for an index above 2, no keyframe, a position above 256 or used twice, a frame that is not 2048 samples, or a sample that is not finite.

pub fn wavetable(&self, index: usize) -> Result<Wavetable, FormatError>

Reads back the Wave Source keyframes of oscillator index.

Errors

A FormatError when the table is missing, holds another component first, or a wave_data text has the wrong length or is not base64. The length is checked before decoding.

pub fn set_lfo_shape( &mut self, index: usize, shape: &LfoShape, ) -> Result<(), FormatError>

Writes the shape of LFO index (0 to 7).

Errors

A FormatError for an index above 7, fewer than 2 or more than 100 points, a power count that differs from the point count, x that falls or leaves 0 to 1, y outside 0 to 1, or a value that is not finite.

pub fn set_effect_on( &mut self, effect: EffectFamily, on: bool, ) -> Result<(), FormatError>

Switches an effect on or off.

Errors

A FormatError if the model has no settings.

pub fn set_effect_order( &mut self, order: &[EffectFamily; 9], ) -> Result<u32, FormatError>

Sets the order of the effect list, top to bottom, and returns its code.

Errors

A FormatError when the list does not hold each effect once.

pub fn set_macro_label( &mut self, number: usize, label: &str, ) -> Result<(), FormatError>

Sets the label of macro number (1 to 4).

Errors

A FormatError for a number outside 1 to 4.

Trait Implementations

impl Clone for VitalModel

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VitalModel

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

Formats the value using the given formatter.

impl PartialEq for VitalModel

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

Equality operator ==.

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

Inequality operator !=.

impl PresetModel for VitalModel

fn header(&self) -> Header

The header fields.

fn get(&self, key: &str) -> Option<Stored>

The value of a control as the file holds it, or None when the key is absent. An explicit default is Some.

fn set(&mut self, key: &str, value: Stored) -> Result<(), FormatError>

Sets a control.

fn reset(&mut self, key: &str)

Removes a control, or writes its default where the format needs one.

fn routes(&self) -> Vec<Option<Route>>

The modulation slots in order. An empty slot is None.

fn set_route( &mut self, slot: usize, route: Option<Route>, ) -> Result<(), FormatError>

Sets or clears a modulation slot.

fn set_name(&mut self, name: &str) -> Result<(), FormatError>

Sets the preset name.

fn set_author(&mut self, author: &str) -> Result<(), FormatError>

Sets the author.

fn set_description(&mut self, description: &str) -> Result<(), FormatError>

Sets the description.

fn set_tags(&mut self, tags: &[String]) -> Result<(), FormatError>

Sets the tags or the style.

fn describe(&self, opts: &DescribeOptions) -> Description

The ordered tree that preset inspect prints.

fn unknown_keys(&self) -> Vec<String>

Keys in the file that the registry does not cover, as paths such as settings.custom_warps. They stay in the model and survive a write.

fn as_any(&self) -> &dyn Any

The model as Any, so its format can take it back for writing.

impl StructuralPartialEq for VitalModel