Skip to main content

Sound

Struct Sound 

Source
pub struct Sound {
    track: AudioTrack,
}
Expand description

An audio leaf: plays a clip’s span inside its placed window.

Authored with Sound::new plus the track shapers (with_gain, with_fade_in, …), then composed exactly like a visual animation:

ⓘ
seq![
    square.fade_in(),
    Sound::new(narration),          // plays while the next cells run
    square.write(),
]

Fields§

§track: AudioTrack

Implementations§

Source§

impl Sound

Source

pub fn new(clip: AudioClip) -> Self

A sound playing the whole clip at unit gain.

Source

pub fn from_track(track: AudioTrack) -> Self

A sound from a shaped track (gain, fades, play range).

Source

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

Set the sound’s linear gain.

Source

pub fn with_fade_in(self, secs: f64) -> Self

Fade in linearly over the first secs of the sound.

Source

pub fn with_fade_out(self, secs: f64) -> Self

Fade out linearly over the last secs of the sound.

Source

pub fn with_play_secs(self, range: Range<f64>) -> Self

Play only the clip’s seconds within range — a content trim, unlike the cell layer’s with_duration, which resamples the sound to fit a new window length.

Source

pub fn duration_secs(&self) -> f64

The sound’s natural window length: the clip’s play length.

Trait Implementations§

Source§

impl IntoAnimNode for Sound

Source§

fn into_anim_node(self) -> AnimNode

Lower this definition into its local runtime representation.
Source§

impl Unplaced for Sound

Source§

fn at(self, offset_sec: f64) -> At<Self>

Place this definition at an offset in its parent’s local time coordinates.

Auto Trait Implementations§

§

impl Freeze for Sound

§

impl RefUnwindSafe for Sound

§

impl Send for Sound

§

impl Sync for Sound

§

impl Unpin for Sound

§

impl UnsafeUnpin for Sound

§

impl UnwindSafe for Sound

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Discard for T

Source§

fn discard(&self)

Simply returns ()
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoResult<T> for T

§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

Source§

impl<A> PlaybackExt for A
where A: Unplaced,

Source§

fn with_rate_func(self, rate_func: fn(f64) -> f64) -> Paramed<Self>

Change the animation’s rate function.
Source§

fn with_duration(self, duration_secs: f64) -> Paramed<Self>

Change the animation’s duration.
Source§

fn with_enabled(self, enabled: bool) -> Paramed<Self>

Enable or disable this animation’s output.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> TransformedExt for T

Source§

fn transformed<G>(self, transform: G) -> Transformed<Self, G>

Return self wrapped with transform stored exactly as G.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> With for T

Source§

fn with(self, f: impl Fn(&mut Self)) -> Self
where Self: Sized,

Mutating a value in place
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more