playdate-sound

Crates.ioplaydate-sound
lib.rsplaydate-sound
version0.4.5
created_at2023-09-08 13:00:44.531409+00
updated_at2025-03-19 17:21:56.135651+00
descriptionHigh-level sound API built on-top of Playdate API
homepagehttps://github.com/boozook/playdate
repositoryhttps://github.com/boozook/playdate.git
max_upload_size
id967086
size98,721
Alex (boozook)

documentation

README

Sound API for PlayDate

High-level sound API built on-top of playdate-sys.

Covered parts of the sound API:

  • File Player
  • Sample Player
    • Sample
  • Sound Source
  • Headphones and microphone (incomplete)

Not covered things:

  • channel
  • synth
  • sequence
  • effect
  • lfo
  • envelope
  • callbacks

⚠️ Prior to the version 1.0 API is unstable and can be changed without deprecation period.

Prerequisites

  1. Rust nightly toolchain (rustup is optional)
  2. Playdate SDK
  3. Follow the official documentation
  4. Follow the instructions for playdate-sys

Usage

use playdate_sound::sample::*;
use playdate_sound::player::sp::*;
use playdate_sound::player::Repeat;

let player = Player::<api::Cache>::new()?;
let sample = Sample::new_from_file("game_main_theme.pda")?;

player.set_sample(&sample);
player.play(Repeat::LoopsEndlessly, 1.0);

See more in examples.


This software is not sponsored or supported by Panic.

Commit count: 562

cargo fmt