Struct AudioClip 

pub struct AudioClip { /* private fields */ }

tick-authored audio occurrence, separate from the retained root AudioClip.

Implementations

impl AudioClip

pub fn composition(timeline: Timeline) -> Self

Retains a nested mix, including its own buses and master, without decoding.

pub fn file(path: impl Into<PathBuf>) -> Self

Retains a local file path without opening, probing or decoding it.

pub fn with_resolved_source(&self, source: Arc<dyn AudioSource>) -> Self

Replaces a deferred source at an execution boundary, preserving all authored settings.

pub fn unresolved_file(&self) -> bool

Whether metadata is still required to determine a natural file duration.

pub fn parameters(&self) -> AudioClipParameters<'_>

Borrows mixer parameters without reading, decoding or copying PCM.

pub fn source(source: impl AudioSource + 'static) -> Self

Captures a stateless source. Infinite sources require an explicit duration.

pub fn start(self, start: Time) -> Self

Sets destination start in nonnegative ticks.

pub fn offset(self, offset: Time) -> Self

Sets source offset, rounded once to the nearest source-rate frame.

pub fn duration(self, duration: Duration) -> Self

Sets a finite positive occurrence duration; EOF is padded with silence.

pub fn volume(self, volume: f64) -> Self

Sets finite amplitude in 0..=16; mixing never normalizes peaks automatically.

pub fn volume_envelope(self, envelope: impl Animation<f64> + 'static) -> Self

Multiplies volume by a typed animation sampled at clip-local output time.

pub fn fade_in(self, duration: Duration) -> Self

Linear amplitude fade anchored to the clip start; overlapping fades multiply.

pub fn fade_out(self, duration: Duration) -> Self

Linear amplitude fade ending at the occurrence’s exclusive end.

pub fn pan(self, pan: f64) -> Self

Constant-power mono pan; stereo uses balance. Range -1 left through +1 right.

pub fn effect(self, effect: impl AudioEffect + 'static) -> Self

Appends an offline effect, rendered once from the clip origin.

pub fn ducked_by(self, trigger: &AudioClip, duck: Duck) -> Self

Lowers this clip while trigger is audible. The trigger is still mixed on its own when it is also added to the timeline; at most four triggers per clip. Ducking is rendered offline from the trigger envelope, so it is deterministic and random-access safe.

pub fn bus(self, name: impl Into<String>) -> Self

Routes the occurrence to a named timeline bus.

pub fn pan_law(self, law: PanLaw) -> Self

Replaces stereo balance law; mono panning is unaffected.

pub fn pan_animation(self, animation: impl Animation<f64> + 'static) -> Self

Sets a pure local-time pan animation, with values in -1..=1.

pub fn stereo_width(self, width: f64) -> Self

Sets mid/side width in 0..=2, without changing the mono component.

pub fn spatial( self, position: impl Animation<Point> + 'static, listener: Point, width: f64, rolloff: f64, ) -> Result<Self, ValidationError>

Couples screen position to pan and inverse-distance gain, multiplying the existing envelope. Width is the listener-to-edge distance; this is not HRTF or three-dimensional spatial audio.

pub fn trim(self, start: Time, end: Time) -> Self

Selects a positive source-time interval; natural duration is not required.

pub fn resolved_duration(&self) -> Result<Duration, ValidationError>

Validated natural/overridden duration, before destination placement.

pub fn end(&self) -> Result<Time, ValidationError>

Exclusive destination end, checked without reading samples.

pub fn relocated( &self, offset: Time, window: Duration, ) -> Result<Option<Self>, ValidationError>

Places a nested audio occurrence in a parent timeline, cropping its audible window. Source offsets and fade positions remain anchored to the original clip.

Trait Implementations

impl Clone for AudioClip

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioClip

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

Formats the value using the given formatter.

impl<Source: AudioSource + ?Sized + 'static> From<Arc<Source>> for AudioClip

fn from(source: Arc<Source>) -> Self

Converts to this type from the input type.