52
edits
Changes
Jump to navigation
Jump to search
Initial commit, plan to add a lot more
sndcore2 is the core [[RPL]] for the Sound-2 library, consisting of the core AX functions. Other libraries like MIX, SYN, and SEQ are included in [[snduser2.rpl]].
==Functions==
===Initialization===
{| class="wikitable"
!Name
!Prototype
!Description
|-
|AXInit
|<code>void AXInit(void);</code>
|DEPRECATED, use AXInitWithParams
|-
|AXIsInit
|<code>bool AXIsInit(void);</code>
|Checks if AX library is initialized.
|-
|AXInitWithParams
|<code>AXINIT_ERROR AXInitWithParams(AXInitParams* params);</code>
|Initializes the AX library for use.
|-
|AXQuit
|<code>void AXQuit(void);</code>
|Shuts down the AX library.
|-
|AXGetRendererFreq
|<code>AX_RENDERER_FREQ AXGetRendererFreq(void);</code>
|Gets the renderer frequency.
|-
|AXIsAudioOutReady
|<code>bool AXIsAudioOutReady(void);</code>
|Checks if Audio Out is ready.
|}
==Structures==
===Initialization===
{| class="wikitable"
!Name
!Prototype
|-
|AXInitWithParams
|
<syntaxhighlight lang="C">
typedef enum {
AXINIT_OK = 0,
AXINIT_ALREADY_INIT = -1,
AXINIT_INVALID_RENDERER = -2,
AXINIT_INVALID_FRAMESIZE = -3,
AXINIT_INVALID_PIPELINE = -4
} AXINIT_ERROR;
typedef enum {
AX_32K_RENDERER = 0,
AX_48K_RENDERER = 1
} AX_RENDERER_FREQ;
typedef enum {
AX_3MS_FRAME = 0
} AX_FRAMESIZE;
typedef enum {
AX_SINGLE_PIPELINE = 0,
AX_FOURSTAGE_PIPELINE = 1
} AX_PIPELINE;
typedef struct {
AX_RENDERER_FREQ rendererFreq;
AX_FRAMESIZE frameSize;
AX_PIPELINE pipeline;
} AXINITPARAMS;
</syntaxhighlight>
|}
==Functions==
===Initialization===
{| class="wikitable"
!Name
!Prototype
!Description
|-
|AXInit
|<code>void AXInit(void);</code>
|DEPRECATED, use AXInitWithParams
|-
|AXIsInit
|<code>bool AXIsInit(void);</code>
|Checks if AX library is initialized.
|-
|AXInitWithParams
|<code>AXINIT_ERROR AXInitWithParams(AXInitParams* params);</code>
|Initializes the AX library for use.
|-
|AXQuit
|<code>void AXQuit(void);</code>
|Shuts down the AX library.
|-
|AXGetRendererFreq
|<code>AX_RENDERER_FREQ AXGetRendererFreq(void);</code>
|Gets the renderer frequency.
|-
|AXIsAudioOutReady
|<code>bool AXIsAudioOutReady(void);</code>
|Checks if Audio Out is ready.
|}
==Structures==
===Initialization===
{| class="wikitable"
!Name
!Prototype
|-
|AXInitWithParams
|
<syntaxhighlight lang="C">
typedef enum {
AXINIT_OK = 0,
AXINIT_ALREADY_INIT = -1,
AXINIT_INVALID_RENDERER = -2,
AXINIT_INVALID_FRAMESIZE = -3,
AXINIT_INVALID_PIPELINE = -4
} AXINIT_ERROR;
typedef enum {
AX_32K_RENDERER = 0,
AX_48K_RENDERER = 1
} AX_RENDERER_FREQ;
typedef enum {
AX_3MS_FRAME = 0
} AX_FRAMESIZE;
typedef enum {
AX_SINGLE_PIPELINE = 0,
AX_FOURSTAGE_PIPELINE = 1
} AX_PIPELINE;
typedef struct {
AX_RENDERER_FREQ rendererFreq;
AX_FRAMESIZE frameSize;
AX_PIPELINE pipeline;
} AXINITPARAMS;
</syntaxhighlight>
|}