Struct rytm_rs::object::pattern::Pattern

pub struct Pattern { /* private fields */ }

Represents a pattern in the analog rytm.

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

Implementations

impl Pattern

pub fn try_default(index: usize) -> Result<Self, RytmError>

Makes a new pattern with the project defaults.

pub fn work_buffer_default() -> Self

Makes a new pattern with the project defaults as if it is in the work buffer..

pub fn tracks_mut(&mut self) -> &mut [Track]

Returns a mutable reference to the tracks which this pattern contains.

13th element is the FX track.

pub fn set_master_length( &mut self, master_length: usize ) -> Result<(), RytmError>

Sets master length for the pattern.

Range 1..=1024

• 1 = Infinite
• 2 = 2

and onwards.

pub fn set_swing_amount(&mut self, swing_amount: usize) -> Result<(), RytmError>

Sets swing amount for the pattern.

Range 50..=80

Range denotes percentage.

pub fn set_speed(&mut self, speed: Speed)

Sets the speed for the pattern.

Check Speed for options.

pub fn set_global_quantize( &mut self, global_quantize: usize ) -> Result<(), RytmError>

Sets the global quantize for the pattern.

Range 0..=127

pub fn set_kit_number(&mut self, kit_number: usize) -> Result<(), RytmError>

Sets the kit number for the pattern.

Range 0..=127

pub fn set_time_mode(&mut self, time_mode: TimeMode)

Sets the time mode for the pattern.

Check TimeMode for options.

pub fn set_master_change( &mut self, master_change: usize ) -> Result<(), RytmError>

Sets the master change for the pattern.

Range 1..=1024

• 1 = OFF
• 2 = 2

and onwards.

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

Sets the BPM for the pattern.

Range 30.0..=300.0

This is only effective when pattern level bpm is enabled.

pub const fn tracks(&self) -> &[Track]

Returns a reference to the tracks which this pattern contains.

13th element is the FX track.

pub const fn master_length(&self) -> usize

Returns the master length for the pattern.

Range 1..=1024

• 1 = Infinite
• 2 = 2

and onwards.

pub const fn swing_amount(&self) -> usize

Returns the swing amount for the pattern.

Range 50..=80

Range denotes percentage.

pub const fn speed(&self) -> Speed

Returns the speed for the pattern.

Check Speed for options.

pub const fn global_quantize(&self) -> usize

Returns the global quantize for the pattern.

Range 0..=127

pub const fn kit_number(&self) -> usize

Returns the kit number for the pattern.

Range 0..=127

pub const fn time_mode(&self) -> TimeMode

Returns the time mode for the pattern.

Check TimeMode for options.

pub const fn master_change(&self) -> usize

Returns the master change for the pattern.

Range 1..=1024

• 1 = OFF
• 2 = 2

and onwards.

pub const fn bpm(&self) -> f32

Returns the BPM for the pattern.

Range 30.0..=300.0

This is only effective when pattern level bpm is enabled.

pub const fn index(&self) -> usize

Returns the index of the pattern.

pub const fn is_work_buffer_pattern(&self) -> bool

Checks if this pattern is the pattern at work buffer.

pub const fn structure_version(&self) -> u32

Returns the version of the pattern structure.

pub fn clear_all_plocks(&mut self)

Clears all the parameter locks for this pattern.

pub fn clear_all_plocks_for_track( &mut self, track_index: u8 ) -> Result<(), RytmError>

Clears all the parameter locks for the given track in this pattern.

Range 0..=12

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pattern

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Pattern> for ar_pattern_t

fn from(pattern: &Pattern) -> Self

Converts to this type from the input type.

impl Serialize for Pattern

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 Pattern

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.