Struct Sample 

pub struct Sample<Api: Api = Default>(/* private fields */);

Implementations

impl<Api: Default + Api> Sample<Api>

pub fn new_with_size(bytes: c_int) -> Result<Self, Error>

Allocates and returns a new Sample with a buffer large enough to load a file of length bytes.

Equivalent to sys::ffi::playdate_sound_sample::newSampleBuffer

pub fn new_for_file<P: AsRef<Path>>(path: P) -> Result<Self, ApiError>

Retrieves size of file and allocate with that size.

Does not load a file.

Uses sys::ffi::playdate_sound_sample::newSampleBuffer

pub fn new_from_file<P: AsRef<Path>>(path: P) -> Result<Self, ApiError>

Loads the file into the self.

Equivalent to sys::ffi::playdate_sound_sample::load

pub fn new_from_data<'t>( data: &'t mut [u8], format: SoundFormat, sample_rate: u32, ) -> Result<SampleWithData<'t, Api>, Error>

Returns a new Sample referencing the given audio data.

The sample keeps a reference to the data instead of copying it, so the data must remain valid while the sample is active.

Equivalent to sys::ffi::playdate_sound_sample::newSampleFromData

impl<Api: Api> Sample<Api>

pub fn new_with_size_with(api: Api, bytes: c_int) -> Result<Self, Error>

Allocates and returns a new Sample with a buffer large enough to load a file of length bytes.

Equivalent to sys::ffi::playdate_sound_sample::newSampleBuffer

pub fn new_for_file_with<P: AsRef<Path>>( api: Api, path: P, ) -> Result<Self, ApiError>

Retrieves size of file and allocate with that size.

Does not load a file.

Uses sys::ffi::playdate_sound_sample::newSampleBuffer

pub fn new_from_file_with<P: AsRef<Path>>( api: Api, path: P, ) -> Result<Self, ApiError>

Loads the file into the self.

Equivalent to sys::ffi::playdate_sound_sample::load

pub fn new_from_data_with<'t>( api: Api, data: &'t mut [u8], format: SoundFormat, sample_rate: u32, ) -> Result<SampleWithData<'t, Api>, Error>

Returns a new Sample referencing the given audio data.

The sample keeps a reference to the data instead of copying it, so the data must remain valid while the sample is active.

Equivalent to sys::ffi::playdate_sound_sample::newSampleFromData

impl<Api: Api> Sample<Api>

pub fn length(&self) -> c_float

Returns the length, in seconds.

Equivalent to sys::ffi::playdate_sound_sample::getLength

pub fn get_data<'t>(&'t self) -> SampleData<'t>

Equivalent to sys::ffi::playdate_sound_sample::getData

Trait Implementations

impl<Api: Api> AsRef<Sample<Api>> for SampleWithData<'_, Api>

fn as_ref(&self) -> &Sample<Api>

Converts this type into a shared reference of the (usually inferred) input type.

impl<Api: Debug + Api> Debug for Sample<Api>

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

Formats the value using the given formatter.

impl<Api: Api> Drop for Sample<Api>

fn drop(&mut self)

Executes the destructor for this type.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.