Struct rytm_rs::object::sound::page::Sample

pub struct Sample { /* private fields */ }

Represents parameters in the sample page of a sound.

Implementations

impl Sample

pub fn set_tune(&mut self, tune: isize) -> Result<(), RytmError>

Sets the coarse tune of the sample.

Range: -24..=24

pub fn set_fine_tune(&mut self, fine_tune: isize) -> Result<(), RytmError>

Sets the fine tune of the sample.

Range: -64..=63

pub fn set_slice_number(&mut self, number: usize) -> Result<(), RytmError>

Sets the slice number of the sample.

Range: 0..=127

pub fn unset_slice(&mut self)

Unsets the sample slice.

Synonym with SMP OFF.

pub fn set_bit_reduction( &mut self, bit_reduction: usize ) -> Result<(), RytmError>

Sets the bit reduction of the sample.

Range: 0..=127

pub fn set_start(&mut self, start: f32) -> Result<(), RytmError>

Sets the start of the sample.

Range: 0.0..=120.0

pub fn set_end(&mut self, end: f32) -> Result<(), RytmError>

Sets the end of the sample.

Range: 0.0..=120.0

pub fn set_loop_flag(&mut self, loop_flag: bool)

Sets the loop flag of the sample.

pub fn set_volume(&mut self, volume: usize) -> Result<(), RytmError>

Sets the volume of the sample.

Range: 0..=127

pub const fn tune(&self) -> isize

Returns the coarse tune of the sample.

Range: -24..=24

pub const fn fine_tune(&self) -> isize

Returns the fine tune of the sample.

Range: -64..=63

pub const fn slice_number(&self) -> usize

Returns the slice number of the sample.

Range: 0..=127

pub const fn bit_reduction(&self) -> usize

Returns the bit reduction of the sample.

Range: 0..=127

pub const fn start(&self) -> f32

Returns the start of the sample.

Range: 0.0..=120.0

pub const fn end(&self) -> f32

Returns the end of the sample.

Range: 0.0..=120.0

pub const fn loop_flag(&self) -> bool

Returns the loop flag of the sample.

pub const fn volume(&self) -> usize

Returns the volume of the sample.

Range: 0..=127

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sample

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

Formats the value using the given formatter.

impl Default for Sample

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sample

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sample

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Sample

fn partial_cmp(&self, other: &Sample) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Sample

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&ar_sound_t> for Sample

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(raw_sound: &ar_sound_t) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Sample

impl StructuralPartialEq for Sample