Struct Sample

pub struct Sample<'a> { /* private fields */ }

Mapping information for a sample file

Implementations

impl<'a> Sample<'a>

pub fn with_file(self, file: impl Into<Cow<'a, Path>>) -> Self

Set the file path of the sample

pub fn with_sample_start(self, sample_start: impl Into<Option<f64>>) -> Self

Set the start point for the sample (in frames)

pub fn with_sample_stop(self, sample_stop: impl Into<Option<f64>>) -> Self

Set the end point for the sample (in frames)

pub fn with_gain(self, gain: impl Into<Option<f64>>) -> Self

Set the gain for the sample

pub fn with_group(self, group: impl Into<Option<isize>>) -> Self

Put the sample in a group

pub fn with_parameter_1(self, parameter_1: impl Into<Option<f64>>) -> Self

Set the first parameter

pub fn with_parameter_2(self, parameter_2: impl Into<Option<f64>>) -> Self

Set the second parameter

pub fn with_parameter_3(self, parameter_3: impl Into<Option<f64>>) -> Self

Set the third parameter

pub fn with_reverse(self, reverse: impl Into<Option<bool>>) -> Self

Set whether the sample should be played in reverse

pub fn with_zone_logic(self, zone_logic: impl Into<Option<ZoneLogic>>) -> Self

Choose an algorithm for sample selection when zones overlap

pub fn with_key(self, key: impl Into<Option<Key>>) -> Self

Set the key range for the sample

pub fn with_velocity(self, velocity: impl Into<Option<ZoneInfo>>) -> Self

Set the velocity range for the sample

pub fn with_select(self, select: impl Into<Option<ZoneInfo>>) -> Self

Set the “select” range for the sample

pub fn with_loop(self, loop: impl Into<Option<Loop>>) -> Self

Set the loop behavior of the sample

pub fn file(&self) -> &Path

Get the path to the sample file

pub fn sample_start(&self) -> Option<f64>

Get the sample’s start point (in frames)

pub fn sample_stop(&self) -> Option<f64>

Get the sample’s end point (in frames)

pub fn gain(&self) -> Option<f64>

Get the sample’s gain

pub fn group(&self) -> Option<isize>

Get the group associated with the sample, if any

pub fn parameter_1(&self) -> Option<f64>

Get the value of the first parameter

pub fn parameter_2(&self) -> Option<f64>

Get the value of the second parameter

pub fn parameter_3(&self) -> Option<f64>

Get the value of the third parameter

pub fn reverse(&self) -> Option<bool>

Get the playback reversal for the sample

pub fn zone_logic(&self) -> Option<ZoneLogic>

Get the overlap behavior for the sample

pub fn key(&self) -> &Option<Key>

Get the sample’s key range

pub fn velocity(&self) -> &Option<ZoneInfo>

Get the sample’s velocity range

pub fn select(&self) -> &Option<ZoneInfo>

Get the sample’s “select” range

pub fn loop(&self) -> &Option<Loop>

Get the sample’s loop behavior

Trait Implementations

impl<'a> Clone for Sample<'a>

fn clone(&self) -> Sample<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Sample<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Sample<'a>

fn default() -> Sample<'a>

Returns the “default value” for a type.

impl<'de: 'a, 'a> Deserialize<'de> for Sample<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq for Sample<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Serialize for Sample<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for Sample<'a>