Struct rytm_rs::object::sound::Sound

pub struct Sound { /* private fields */ }

Represents a sound in the analog rytm.

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

Implementations

impl Sound

pub fn link_parameter_lock_pool( &mut self, parameter_lock_pool: &Arc<Mutex<ParameterLockPool>> ) -> Result<(), RytmError>

Links a pattern’s parameter lock pool to this sound.

This way, one can set parameter locks for trigs for the machine assigned to this sound.

Errors

Sound must be a track sound. This is necessary because the pattern’s parameter lock pool belongs to a pattern but sounds are not. Sounds are received with different query compared to patterns.

Calling this method on a pool sound will result in an error.

pub const fn sound_type(&self) -> SoundType

Returns the type of the sound.

pub const fn is_pool_sound(&self) -> bool

Returns if the sound is coming from the sound pool.

pub const fn is_work_buffer_sound(&self) -> bool

Returns if the sound is coming from the work buffer and assigned to a track.

pub const fn is_part_of_a_kit_query(&self) -> bool

Returns if the sound is coming from a kit query and loaded as a part of a kit.

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

Sets the name of the sound.

Errors

The name must be ASCII and have a length of 15 characters or less. Other cases will result in an error.

pub fn set_accent_level(&mut self, accent_level: usize) -> Result<(), RytmError>

Sets the accent level of the sound.

Range: 0..=127

pub const fn assigned_track(&self) -> Option<usize>

Returns the assigned track if this is a track sound.

Returns None if this is not a track sound.

Range: 0..=11

pub const fn kit_number(&self) -> Option<usize>

Returns the kit number if this sound is a part of a kit.

Returns None if this is not a kit sound.

Range: 0..=127

pub const fn pool_index(&self) -> Option<usize>

Returns the kit number if this sound is a part of a kit.

Returns None if this is not a kit sound.

Range: 0..=127

pub const fn accent_level(&self) -> usize

Returns the accent level of the sound.

Range: 0..=127

pub fn name(&self) -> &str

Returns the name of the sound.

pub const fn sample(&self) -> &Sample

Returns the sample page parameters of the sound.

pub const fn filter(&self) -> &Filter

Returns the filter page parameters of the sound.

pub const fn amplitude(&self) -> &Amplitude

Returns the amplitude page parameters of the sound.

pub const fn lfo(&self) -> &Lfo

Returns the LFO page parameters of the sound.

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

Returns sound settings of the sound.

pub const fn machine_parameters(&self) -> &MachineParameters

Returns the machine parameters of the sound.

pub fn sample_mut(&mut self) -> &mut Sample

Returns the sample page parameters of the sound mutably.

pub fn filter_mut(&mut self) -> &mut Filter

Returns the filter page parameters of the sound mutably.

pub fn amplitude_mut(&mut self) -> &mut Amplitude

Returns the amplitude page parameters of the sound mutably.

pub fn lfo_mut(&mut self) -> &mut Lfo

Returns the LFO page parameters of the sound mutably.

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

Returns sound settings of the sound mutably.

pub fn machine_parameters_mut(&mut self) -> &mut MachineParameters

Returns the machine parameters of the sound mutably.

pub const fn structure_version(&self) -> u32

Returns the version of the sound structure.

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

Makes a new pool sound with the given index complying to project defaults.

Range: 0..=127

pub fn try_kit_default( track_index: usize, kit_index: usize, sysex_meta: SysexMeta ) -> Result<Self, RytmError>

Makes a new sound with the given index complying to project defaults as if it comes from a part of a kit.

Track index range: 0..=11 Kit index range: 0..=127

pub fn try_work_buffer_default(track_index: usize) -> Result<Self, RytmError>

Makes a new sound with the given index complying to project defaults as if it comes from the work buffer.

Track index range: 0..=11

pub fn set_machine_type( &mut self, machine_type: MachineType ) -> Result<(), RytmError>

Sets the machine type of the sound.

Errors

Not every machine type could be set for every sound if they’re assigned to a track.

For the sounds which are assigned to a track, the machine type must be compatible with the track or an error will be returned.

For pool sounds this function will always succeed.

pub const fn machine_type(&self) -> MachineType

Returns the machine type of the sound.

pub const fn index(&self) -> usize

Returns the index of the sound.

Trait Implementations

impl Clone for Sound

fn clone(&self) -> Sound

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sound

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sound

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Sound> for ar_sound_t

fn from(sound: &Sound) -> Self

Converts to this type from the input type.

impl Serialize for Sound

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 Sound

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.