Struct Tone 

pub struct Tone {
    pub partials: Vec<Partial>,
    pub envelope: Envelope,
    pub duration: Duration,
}

A complete tone: a set of Partials shaped by an Envelope over a fixed duration.

Fields

partials: Vec<Partial>

Sinusoidal components that sum to form the tone.

envelope: Envelope

Amplitude envelope applied across the tone.

duration: Duration

Total sounding length of the tone.

Implementations

impl Tone

pub fn sine(frequency: Frequency, duration: Duration) -> Self

Builds a pure sine tone at frequency with the default envelope.

pub fn sawtooth( frequency: Frequency, duration: Duration, partials: usize, ) -> Self

Builds a sawtooth tone from partials harmonics with 1/n amplitudes.

pub fn square(frequency: Frequency, duration: Duration, partials: usize) -> Self

Builds a square tone from the odd harmonics within partials, with 1/n amplitudes.

pub fn triangle( frequency: Frequency, duration: Duration, partials: usize, ) -> Self

Builds a triangle tone from the odd harmonics within partials, with 1/n^2 amplitudes.

pub fn from_partials( partials: Vec<Partial>, envelope: Envelope, duration: Duration, ) -> Result<Self, SoundCoreError>

Builds a tone from explicit partials, rejecting empty partial lists, zero durations, and invalid component values.

pub fn transpose_cents(self, cents: f64) -> Self

Returns the tone with every partial shifted by cents.

pub fn amplify(self, gain: f64) -> Self

Returns the tone with every partial amplitude scaled by gain.

pub fn time_stretch(self, factor: f64) -> Result<Self, SoundCoreError>

Returns the tone with its duration and envelope stages scaled by factor, rejecting non-positive factors.

Trait Implementations

impl Add for Tone

type Output = Tone

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl Clone for Tone

fn clone(&self) -> Tone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tone

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

Formats the value using the given formatter.

impl PartialEq for Tone

fn eq(&self, other: &Tone) -> 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 StructuralPartialEq for Tone