Struct BasicSong

pub struct BasicSong {
    pub notes: Vec<Note>,
    pub bpm: BPMChoice,
}

Deprecated

This feature has been deprecated in the latest update. Please use the new player, not the legacy one.

Basic songs are collections of Notes. Each song can export to a .wav file.

Example:

use rs_audio::*;

let mut song = BasicSong::default();
song.play().unwrap();

let mut second_song = BasicSong::new(vec![
Note { freq: 880.0, dur: 1.0, vol: 0.20, wave: WaveForm::Sine },
Note { freq: 220.0, dur: 1.0, vol: 0.20, wave: WaveForm::Square },
Note { freq: 880.0, dur: 1.0, vol: 0.20, wave: WaveForm::Sine },
Note { freq: 220.0, dur: 1.0, vol: 0.20, wave: WaveForm::Triangle },
], BPMChoice::Default);

second_song.play().unwrap(); // Uses the main thread.
second_song.export_to_wav("test.wav".to_string());

Fields

notes: Vec<Note>

bpm: BPMChoice

Implementations

impl BasicSong

pub fn new(notes: Vec<Note>, bpm: BPMChoice) -> Self

pub fn play(&mut self) -> Result<(), Error>

impl BasicSong

pub fn export_to_wav(&self, filename: String) -> Result<(), Box<dyn Error>>

Deprecated

This feature has been deprecated in the latest update. Please use the new player, not the legacy one.

Exports a Song struct to a .wav file.
It creates a .wav file in the current directory.
Usage:

use rs_audio::*;
use rs_audio::{legacyplayer::BasicSong};

let song = BasicSong::default();
song.export_to_wav("test.wav".to_string());

pub fn play_wav(file_path: &str) -> Result<(), Error>

Deprecated

This feature has been deprecated in the latest update. Please use the new player, not the legacy one.

Plays a .wav file.

Usage:

use rs_audio::*;
use rs_audio::{legacyplayer::BasicSong};

BasicSong::play_wav("test.wav").unwrap();

Trait Implementations

impl Default for BasicSong

fn default() -> Self

Deprecated

This feature has been deprecated in the latest update. Please use the new player, not the legacy one.

Creates a default song that is useful for debugging purposes.

It contains a single default sine wave.
Usage:

use rs_audio::*;
let song = BasicSong::default();