modplay 0.1.0

Convenience abstraction of xmrsplayer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# Convenience abstraction of xmrsplayer


This library crate is a convenience abstraction of [xmrsplayer](https://crates.io/crates/xmrsplayer) with only one goal in mind, to easily play [XM](https://en.wikipedia.org/wiki/XM_(file_format)) files in your application without dealing with its internals.

If your use case requires more features or lower level control you may need to consider using [xmrs](https://crates.io/crates/xmrs) or [xmrsplayer](https://crates.io/crates/xmrsplayer) directly.

## Features


- Powered by `xmrs` and `cpal`
- Quickly play your favorite `.xm` file


## Examples:


You can use `modplay` like this:

```rust
use modplay::ModPlay;

let data = std::fs::read("filename.xm").unwrap();
ModPlay::new(&data).run();
```

It is recommended to run from a separate thread:
```rust
use modplay::ModPlay;

std::thread::spawn(|| {
    if let Ok(data) = std::fs::read("filename.xm") {
        ModPlay::new(&data).run();
    }
}).join().unwrap()
```

If you need to set some options you can use something like this:

```rust
use modplay::ModPlay;

let data = std::fs::read("filename.xm").unwrap()
ModPlay::new(&data)
    .set_amplification(0.5)
    .set_loops(2)
    .set_sample_rate(44100.0)
    .run();
```