From e909bb3fc8566620bdf6815c4046ded5f4131e72 Mon Sep 17 00:00:00 2001 From: John Date: Mon, 22 Apr 2019 14:03:00 +0100 Subject: [PATCH] Changes to doc. --- README.MD | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/README.MD b/README.MD index 70e8c8e..4dea142 100644 --- a/README.MD +++ b/README.MD @@ -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: + + +--- + +## 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); +``` + +--- \ No newline at end of file