Struct rytm_rs::object::settings::Settings

pub struct Settings { /* private fields */ }

Represents settings in the analog rytm.

It does not map identically to the relevant structure in the firmware.

Settings may not be a familiar structure for all, to understand what kind of settings are available, please check the methods of this struct.

Implementations

impl Settings

pub fn set_bpm(&mut self, bpm: f32) -> Result<(), RytmError>

Sets the BPM for the entire project.

Range 30.0..=300.0

This is only effective when project level bpm is enabled.

pub fn set_selected_track( &mut self, track_index: usize ) -> Result<(), RytmError>

Sets the selected track.

Range 0..=11

pub fn set_selected_parameter_menu_item( &mut self, parameter_menu_item: ParameterMenuItem )

Sets the selected parameter menu item.

The six sequential square buttons on the right side of the Analog Rytm MKII.

pub fn set_selected_fx_menu_item(&mut self, fx_menu_item: FxParameterMenuItem)

Sets the selected fx menu item.

The six sequential square buttons on the right side of the Analog Rytm MKII.

The fx menu is only available when the FX button is pressed.

pub fn set_selected_page(&mut self, page_index: usize) -> Result<(), RytmError>

Sets the selected page.

The [PAGE] button on the Analog Rytm MKII.

Range 0..=3

pub fn set_selected_mode(&mut self, sequencer_mode: SequencerMode)

Sets the selected sequencer mode.

pub fn set_selected_pattern_mode(&mut self, pattern_mode: PatternMode)

Sets the selected pattern mode.

pub fn set_mute_flags(&mut self, mute_flags: u16) -> Result<(), RytmError>

Sets the mute flags for sounds.

Range 0..=0b1111_1111_1111

pub fn mute_sound(&mut self, sound_index: usize) -> Result<(), RytmError>

Mutes a sound by sound index.

Range 0..=11

pub fn unmute_sound(&mut self, sound_index: usize) -> Result<(), RytmError>

Unmute a sound by sound index.

Range 0..=11

pub fn toggle_mute_sound(&mut self, sound_index: usize) -> Result<(), RytmError>

Toggles the mute state of a sound by sound index.

Range 0..=11

pub fn mute_range_of_sounds( &mut self, range: Range<usize> ) -> Result<(), RytmError>

Mutes a range of sounds.

Maximum range 0..=11

Errors

Returns an error if the range is out of bounds.

pub fn unmute_range_of_sounds( &mut self, range: Range<usize> ) -> Result<(), RytmError>

Unmute a range of sounds.

Maximum range 0..=11

Errors

Returns an error if the range is out of bounds.

pub fn toggle_mute_range_of_sounds( &mut self, range: Range<usize> ) -> Result<(), RytmError>

Toggles the mute state of a range of sounds.

Maximum range 0..=11

Errors

Returns an error if the range is out of bounds.

pub fn set_fixed_velocity_enable(&mut self, fixed_velocity_enable: bool)

Sets the fixed velocity enable state.

pub fn set_fixed_velocity_amount( &mut self, fixed_velocity_amount: usize ) -> Result<(), RytmError>

Sets the fixed velocity amount.

Range 0..=127

pub fn set_sample_recorder_source( &mut self, sample_recorder_source: SampleRecorderSource )

Sets the sample recorder source.

pub fn set_sample_recorder_threshold( &mut self, sample_recorder_threshold: usize ) -> Result<(), RytmError>

Sets the sample recorder threshold.

Range 0..=127

pub fn set_sample_recorder_monitor_enable( &mut self, set_sample_recorder_monitor_enable: bool )

Sets the sample recorder monitor state.

pub fn set_sample_recorder_recording_length( &mut self, sample_recorder_recording_length: SampleRecorderRecordingLength )

Sets the sample recorder recording length.

pub const fn bpm(&self) -> f32

Returns the BPM for the entire project.

Range 30.0..=300.0

This is only effective when project level bpm is enabled.

pub const fn selected_track(&self) -> usize

Returns the selected track.

Range 0..=11

pub const fn selected_parameter_menu_item(&self) -> ParameterMenuItem

Returns the selected parameter menu item.

pub const fn selected_fx_menu_item(&self) -> FxParameterMenuItem

Returns the selected fx menu item.

pub const fn selected_page(&self) -> usize

Returns the selected page.

Range 0..=3

pub const fn selected_mode(&self) -> SequencerMode

Returns the selected sequencer mode.

pub const fn selected_pattern_mode(&self) -> PatternMode

Returns the selected pattern mode.

pub const fn raw_mute_flags(&self) -> u16

Returns the raw mute flags for sounds.

pub fn muted_sound_indexes(&self) -> Vec<usize>

Returns the collection of muted sound indexes.

pub fn unmuted_sound_indexes(&self) -> Vec<usize>

Returns the collection of unmuted sound indexes.

pub fn is_sound_muted(&self, sound_index: usize) -> Result<bool, RytmError>

Returns if a sound is muted by sound index.

pub const fn fixed_velocity_enabled(&self) -> bool

Returns the fixed velocity enable state.

pub const fn fixed_velocity_amount(&self) -> usize

Returns the fixed velocity amount.

Range 0..=127

pub const fn sample_recorder_source(&self) -> SampleRecorderSource

Returns the sample recorder source.

pub const fn sample_recorder_threshold(&self) -> usize

Returns the sample recorder threshold.

Range 0..=127

pub const fn sample_recorder_monitor_enabled(&self) -> bool

Returns the sample recorder monitor state.

pub const fn sample_recorder_recording_length( &self ) -> SampleRecorderRecordingLength

Returns the sample recorder recording length.

pub const fn structure_version(&self) -> u32

Returns the version of the settings structure.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Settings> for ar_settings_t

fn from(settings: &Settings) -> Self

Converts to this type from the input type.

impl Serialize for Settings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SysexCompatible for Settings

fn as_sysex(&self) -> Result<Vec<u8>, RytmError>

Serializes the object to a sysex message.

fn sysex_type(&self) -> AnySysexType

Returns the sysex type of the object.

impl Copy for Settings