max
/
rodio-xm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme

This commit is contained in:
Max Bradbury 2021-11-27 11:49:47 +00:00
parent 4734ae81f8
commit c5d954c56c
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,21 +1,28 @@
# rodio-xm
provides a source for playback of fasttracker 2 extended modules in rodio
provides a Source for playback of FastTracker 2 extended modules in rodio
## examples
```rust
use std::path::PathBuf;
use rodio::{OutputStream, Sink};
use rodio_xm::XMSource;
fn main() {
const SAMPLE_RATE: u32 = 44100;
let mut source = XMSource::from_bytes(include_bytes!("path/to/xm"), SAMPLE_RATE);
let source = XMSource::from_file(
PathBuf::from("path/to/file.xm"),
44100
);
let (_stream, stream_handle) = rodio::OutputStream::try_default().unwrap();
let sink = rodio::Sink::try_new(&stream_handle).unwrap();
let (_stream, stream_handle) = OutputStream::try_default().unwrap();
let sink = Sink::try_new(&stream_handle).unwrap();
sink.append(source);
sink.sleep_until_end();
sink.play();
loop {}
}
```
@ -23,4 +30,7 @@ see more in the *examples* directory.
## license
example track "chica-pop!" is in the public domain: https://modarchive.org/index.php?request=view_by_moduleid&query=189433
released under the MIT license.
example track ["Chica-pop!"](https://modarchive.org/index.php?request=view_by_moduleid&query=189433)
is in the public domain.