Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to doc. #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,4 +1,70 @@
# JayTrax Library

This is a port from C++ to C of Jaytrax replayer by Rhino https://github.com/rhinoid

Current status: everything works except sample interpolation.


Documentation can be found here: <doc_link>


---

## Lib jaytax API

The following functions are exposed.

### Init / Pre-processing

```c

void jaytrax_loadSong(
JT1Player* THIS,
JT1Song* sng

);
```

### Track Player commands.

```c
void jaytrax_playSubSong(
JT1Player* THIS,
int subsongnr
);
```

```c
void jaytrax_stopSong(
JT1Player* THIS
);
```

```c
void jaytrax_pauseSong(
JT1Player* THIS
);
```

```c
//rename to resume?
void jaytrax_continueSong(
JT1Player* THIS
);
```

### Internal (for now)

```c
void jaytrax_setInterpolation(JT1Player* THIS, uint8_t id);
```

```c
JT1Player* jaytrax_init();
```

```c
void jaytrax_renderChunk(JT1Player* THIS, int16_t* renderbuf, int32_t nrofsamples, int32_t frequency);
```

---