rusty_audio

Crates.iorusty_audio
lib.rsrusty_audio
version1.4.1
sourcesrc
created_at2019-10-10 19:42:27.497704
updated_at2023-04-10 17:55:50.974489
descriptionConvenient sound library for small projects and educational purposes.
homepagehttps://github.com/cleancut/rusty_engine/tree/master/rusty_audio
repositoryhttps://github.com/cleancut/rusty_engine/tree/master/rusty_audio
max_upload_size
id171512
size70,623
Nathan Stocks (CleanCut)

documentation

README

Crates.io Version Crates.io Downloads Build Status

Rusty Audio Playback Library

rusty_audio is a fun and easy audio playback library that provides a 4-track audio system to load/decode audio files and play them, perfect for small projects. It is also well-suited for training purposes, and is featured in the Ultimate Rust Crash Course on Udemy.

  • Formats: MP3, WAV, Vorbis and Flac.
  • Platforms: Supports macOS, Windows, and iOS out of the box. Linux requires installation of extra dependencies.

This library uses the rodio audio playback library under the hood, which you should consider using directly if your needs are more complex.

Example

# Add this to your [dependencies] section in Cargo.toml
rusty_audio = "1.4.1"
// main.rs
use rusty_audio::Audio;

fn main() {
    let mut audio = Audio::new();
    audio.add("startup", "my_sound_file.mp3"); // Load the sound, give it a name
    audio.play("startup"); // Execution continues while playback occurs in another thread.
    audio.wait(); // Block until sounds finish playing
}

Built-in Example

You can run the built-in example by cloning this repository, and then running:

$ cargo run --example play

Dependencies on Linux

For Linux, the CPAL package that is used under the hood requires the alsa development libraries to be installed.

CentOS

sudo yum install -y alsa-lib-devel

Debian/Ubuntu

sudo apt install libasound2-dev

Contribution

All contributions are assumed to be dual-licensed under MIT/Apache-2.

License

Distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See license/APACHE and license/MIT.

Sponsor

If you like Rusty Audio, please consider sponsoring me on GitHub. 💖

Commit count: 366

cargo fmt