Struct AudioClip 

pub struct AudioClip<const SAMPLE_RATE_HZ: u32, T: ?Sized = [i16]> { /* private fields */ }

Available on target_os=none only.

Unsized view of static audio clip data. &AudioClip values of different lengths can be sequenced together.

For fixed-size, const-friendly storage, see AudioClipBuf.

See the audio_player module documentation for usage examples.

Implementations

impl<const SAMPLE_RATE_HZ: u32, T: ?Sized> AudioClip<SAMPLE_RATE_HZ, T>

pub const SAMPLE_RATE_HZ: u32 = SAMPLE_RATE_HZ

Clip sample rate in hertz.

impl<const SAMPLE_RATE_HZ: u32> AudioClip<SAMPLE_RATE_HZ>

pub const fn samples(&self) -> &[i16]

Clip samples as an i16 slice.

pub const fn sample_count(&self) -> usize

Number of samples in this clip.

See the audio_player module documentation for usage examples.

impl<const SAMPLE_RATE_HZ: u32, const SAMPLE_COUNT: usize> AudioClip<SAMPLE_RATE_HZ, [i16; SAMPLE_COUNT]>

Implementation for fixed-size clips (AudioClipBuf).

This impl applies to AudioClip with array-backed storage: AudioClip<SAMPLE_RATE_HZ, [i16; SAMPLE_COUNT]> (which is what AudioClipBuf aliases).

pub const SAMPLE_COUNT: usize = SAMPLE_COUNT

Number of samples in this clip.

See the audio_player module documentation for clip usage examples.

pub const fn new(samples: [i16; SAMPLE_COUNT]) -> Self

Creates a clip from i16 samples.

This is the primary constructor for custom clip-generation and transform helpers written as const fn.

pub const fn samples(&self) -> &[i16; SAMPLE_COUNT]

Returns the clip samples as a fixed-size array reference.

This is intended for custom clip-transform helpers written as const fn.

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

Returns a new clip with linear sample gain applied.

This is intended to be used in const clip definitions so the adjusted samples are computed ahead of time.

You can also write your own compile-time clip transforms by reading samples with AudioClipBuf::samples and building a new clip with AudioClipBuf::new.

Gain multiplication uses i32 math and saturates to i16 sample bounds. Large boosts can hard-clip peaks and introduce distortion.

See the audio_player module documentation for usage examples.

pub const fn silence() -> Self

Creates a silent clip.

See the audio_player module documentation for usage examples.

pub const fn tone(frequency_hz: u32) -> Self

Creates a sine-wave clip.

See the audio_player module documentation for usage examples.