Struct crankstart::sound::Sound

pub struct Sound { /* private fields */ }

Sound is the main interface to the Playdate audio subsystems.

Implementations

impl Sound

pub fn get() -> Self

Gets a handle to the Sound system. This is the primary entry point for users.

pub fn get_file_player(&self) -> Result<FilePlayer>

Get a FilePlayer that can be used to stream audio from disk, e.g. for music.

pub fn get_sample_player(&self) -> Result<SamplePlayer>

Get a SamplePlayer that can be used to play sound effects.

pub fn load_audio_sample(&self, sample_path: &str) -> Result<AudioSample>

Loads an AudioSample sound effect. Assign it to a SamplePlayer with SamplePlayer.set_sample.

pub fn get_current_time(&self) -> Result<c_uint>

Returns the sound engine’s current time, in frames, 44.1k per second.

pub fn set_outputs_active(&self, headphone: bool, speaker: bool) -> Result<()>

Sets which audio outputs should be active. Note: if you disable headphones and enable speaker, sound will be played through the speaker even if headphones are plugged in.

Trait Implementations

impl Clone for Sound

fn clone(&self) -> Sound

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sound

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

Formats the value using the given formatter.