Struct rytm_rs::RytmProject

pub struct RytmProject { /* private fields */ }

RytmProject represents the state of the analog rytm.

It contains all structures scoped to an Analog Rytm MKII FW 1.70 project.

Implementations

impl RytmProject

pub fn update_from_sysex_response( &mut self, response: &[u8] ) -> Result<(), RytmError>

Updates the Rytm struct from a sysex response.

All encoding/decoding is done in RytmProject, so this is the only method that needs to be called to update the struct when a sysex response is received.

Important

This method will act as a no-op if the given slice does not contain a valid sysex message. The check is performed by checking the first and last byte of the slice. This behaviour is preferred to returning an error, as it is expected to be called in a midi callback which receives not just sysex messages.

Errors

This method will return an error

• If the sysex message is invalid in the context of Rytm
• If the sysex message is valid, but the object type is not supported or implemented yet. Example: [crate::error::RytmError::SysexConversionError::Unimplemented] variant.
• If the sysex message is incomplete, this sometimes happens in the initial parts of the transmission and is a behaviour of Rytm. You may check for the error [crate::error::RytmError::SysexConversionError::ShortRead] and ignore it.
• If the sysex message is valid, but the size of the expected object does not match the size of the received object. This may happen if the firmware version of Rytm is different than the one this library supports which is currently FW 1.70 only. Never happened to me in practice but a cut transmission may also cause this in theory.
• All other [crate::error::RytmError::SysexConversionError] variants are possible which are inherited from libanalogrytm.

pub fn patterns(&self) -> &[Pattern]

Get all patterns.

Total of 128 patterns.

pub fn kits(&self) -> &[Kit]

Get all kits.

Total of 128 kits.

pub const fn pool_sounds(&self) -> &[Sound]

Get all sounds in the pool.

Total of 128 sounds.

pub const fn globals(&self) -> &[Global]

Get all global slots.

Total of 4 global slots.

pub const fn settings(&self) -> &Settings

Get the settings.

pub fn patterns_mut(&mut self) -> &mut [Pattern]

Get all patterns mutably.

Total of 128 patterns.

pub fn kits_mut(&mut self) -> &mut [Kit]

Get all kits mutably.

Total of 128 kits.

pub fn pool_sounds_mut(&mut self) -> &mut [Sound]

Get all sounds in the pool mutably.

Total of 128 sounds.

pub fn globals_mut(&mut self) -> &mut [Global]

Get all global slots mutably.

Total of 4 global slots.

pub fn settings_mut(&mut self) -> &mut Settings

Get the settings mutably.

pub const fn work_buffer(&self) -> &RytmProjectWorkBuffer

Get the work buffer structures.

pub fn work_buffer_mut(&mut self) -> &mut RytmProjectWorkBuffer

Get the work buffer structures mutably.

Trait Implementations

impl Clone for RytmProject

fn clone(&self) -> RytmProject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RytmProject

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

Formats the value using the given formatter.

impl Default for RytmProject

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RytmProject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RytmProject

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

where __S: Serializer,

Serialize this value into the given Serde serializer.