Struct ScratchGate 

pub struct ScratchGate { /* private fields */ }

Audio-rate, travel-based scratch crossfader gate.

intent_rate should be the filtered/target hand rate and rendered_rate should be the rate actually used to advance audible PCM. Direction changes use intent for responsiveness and rendered motion as a fallback, while pattern phase follows audible travel in the confirmed stroke direction.

Implementations

impl ScratchGate

pub fn new(preset: ScratchPreset) -> Self

pub fn preset(&self) -> ScratchPreset

pub fn set_preset(&mut self, preset: ScratchPreset)

pub fn clicks(&self) -> u8

pub fn set_clicks(&mut self, clicks: u8)

pub fn algorithm_version(&self) -> u32

pub fn set_algorithm_version(&mut self, _version: u32)

Retains source compatibility while legacy consumers migrate.

The canonical gate does not emulate replaced algorithms.

pub fn reset_for_replay(&mut self)

Starts a recorded performance from one defined gate state while retaining its selected technique and click count.

pub fn gate(&self) -> f64

pub fn target(&self) -> f64

pub fn direction(&self) -> i8

pub fn moving(&self) -> bool

pub fn phase(&self) -> f64

pub fn stroke_progress(&self) -> f64

pub fn learned_span(&self) -> f64

Returns the estimate for the active direction.

Before motion starts, this method returns the forward seed.

pub fn learned_span_for_direction(&self, direction: i8) -> f64

Returns one direction’s learned source-travel span.

pub fn span_prediction_confidence(&self) -> f64

Returns confidence for the active direction.

Before motion starts, this method returns forward confidence.

pub fn span_prediction_confidence_for_direction(&self, direction: i8) -> f64

Returns zero before the first direction-specific observation.

Confidence reaches one after four observations in that direction.

pub fn snapshot(&self) -> ScratchGateSnapshot

pub fn restore( &mut self, snapshot: &ScratchGateSnapshot, ) -> Result<(), ScratchPerformanceError>

Restores only after the complete gate state passes validation.

pub fn release(&mut self)

Marks the record as released immediately. The target opens at once; the returned gain still reaches it through the de-click envelope.

pub fn process( &mut self, delta_seconds: f64, hand_contact: bool, intent_rate: f64, rendered_rate: f64, ) -> f64

Advances the gate by one audio frame and returns its de-clicked gain.

Trait Implementations

impl Clone for ScratchGate

fn clone(&self) -> ScratchGate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ScratchGate

impl Debug for ScratchGate

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

Formats the value using the given formatter.

impl Default for ScratchGate

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScratchGate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScratchGate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScratchGate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScratchGate