Skip to main content
← PSoXide SDK guides and examples · SDK f2fec1c301f1 · All Cargo features enabled; check feature gates before use.

LoopingSample

Struct LoopingSample 

Source
pub struct LoopingSample { /* private fields */ }
Expand description

A resident ADPCM sample whose cooked block flags form a hardware loop.

The sample must carry a LOOP-START block and an END|REPEAT block. This handle owns the common voice setup and key-on policy, while the caller may update the voice’s left and right volumes each frame for spatial audio.

Implementations§

Source§

impl LoopingSample

Source

pub const fn new(sample: Sample, volume: Volume) -> Self

A loop at its recorded rate and a sustained full-level envelope.

Source

pub const fn with_volume(self, volume: Volume) -> Self

Change the initial equal left/right level used at key-on.

Source

pub const fn with_adsr(self, adsr: Adsr) -> Self

Override the sustained envelope.

Source

pub const fn with_pitch(self, pitch: Pitch) -> Self

Override playback pitch. 0x1000 is unity.

Source

pub const fn sample(&self) -> Sample

The resident sample behind this loop.

Source

pub fn configure(&self, voice: Voice)

Configure voice without starting it.

Source

pub fn play(&self, voice: Voice)

Configure and start this hardware loop on voice.

Source

pub fn stop(voice: Voice)

Stop a loop and silence its voice immediately.

Trait Implementations§

Source§

impl Clone for LoopingSample

Source§

fn clone(&self) -> LoopingSample

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for LoopingSample

Auto Trait Implementations§

§

impl Freeze for LoopingSample

§

impl RefUnwindSafe for LoopingSample

§

impl Send for LoopingSample

§

impl Sync for LoopingSample

§

impl Unpin for LoopingSample

§

impl UnsafeUnpin for LoopingSample

§

impl UnwindSafe for LoopingSample

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.