Struct ctru::services::ndsp::wave::Wave

pub struct Wave<Buffer: LinearAllocation + AsRef<[u8]>> { /* private fields */ }

Informational struct holding the raw audio data and playback info.

You can play audio Waves by using Channel::queue_wave().

Implementations

impl<Buffer> Wave<Buffer>

where Buffer: LinearAllocation + AsRef<[u8]>,

pub fn new(buffer: Buffer, audio_format: AudioFormat, looping: bool) -> Self

Build a new playable wave object from a raw buffer on LINEAR memory and some info.

Example

use ctru::linear::LinearAllocator;
use ctru::services::ndsp::{AudioFormat, wave::Wave};

// Zeroed box allocated in the LINEAR memory.
let audio_data: Box<[_], _> = Box::new_in([0u8; 96], LinearAllocator);

let wave = Wave::new(audio_data, AudioFormat::PCM16Stereo, false);

pub fn get_buffer(&self) -> &[u8]

Returns a slice to the audio data (on the LINEAR memory).

pub fn get_buffer_mut(&mut self) -> Result<&mut [u8], Error>

where Buffer: AsMut<[u8]>,

Returns a mutable slice to the audio data (on the LINEAR memory).

Errors

This function will return an error if the Wave is currently busy, with the id to the channel in which it’s queued.

pub fn status(&self) -> Status

Returns this wave’s playback status.

Example

use ctru::services::ndsp::{AudioFormat, wave::{Wave, Status}};

// Provide your own audio data.
let wave = Wave::new(_audio_data, AudioFormat::PCM16Stereo, false);

// The `Wave` is free if never played before.
assert!(matches!(wave.status(), Status::Free));

pub fn sample_count(&self) -> usize

Returns the amount of samples read by the NDSP process.

Notes

This value varies depending on Wave::set_sample_count.

pub fn format(&self) -> AudioFormat

Returns the format of the audio data.

pub fn set_sample_count(&mut self, sample_count: usize) -> Result<(), Error>

Set the amount of samples to be read.

Note

This function doesn’t resize the internal buffer. Operations of this kind are particularly useful to allocate memory pools for VBR (Variable BitRate) formats, like OGG Vorbis.

Errors

This function will return an error if the sample size exceeds the buffer’s capacity or if the Wave is currently queued.

Trait Implementations

impl<Buffer> Drop for Wave<Buffer>

where Buffer: LinearAllocation + AsRef<[u8]>,

fn drop(&mut self)

Executes the destructor for this type.