Author: Marco H. Sobol

Audiomatik: API Reference

Basic playback functions

Call: Parameters: Usage:
AM_Start n/a call AM_Init (if not previously called), start playback with intro, then loops
AM_Stop n/a at next sync callback, skip to extro, then stop playback and rewind to intro
AM_Pause n/a fade volume to zero, then pause playback (no rewind)
AM_UnPause n/a resume playback, then fade volume to full
AM_SetVolume FLOAT volume fade current music volume to parameter value (0-1)
AM_GetVolume returns FLOAT volume retrieve current music volume
AM_Mute n/a fade volume to zero (no pause)
AM_UnMute n/a fade volume to full
AM_SetPlaybackSpeed FLOAT speed change playback speed (1-255)
AM_GetPlaybackSpeed returns FLOAT speed retrieve current playback speed value
AM_GetDefaultSpeed returns FLOAT speed retrieve current module's default playback speed value


Forced-playback functions

Call: Parameters: Usage:
AM_ForceStart n/a call AM_Init (if not previously called), start playback (skip intro), then loop
AM_ForceStop n/a instantly halt playback and rewind
AM_ForcePause n/a instantl pause playback (no rewind)
AM_ForceUnPause n/a instantly resume playback at current volume
AM_ForceSetVolume FLOAT volume instantly set current music volume to parameter value (0-1)
AM_ForceMute n/a instantly set volume to zero (no pause)
AM_ForceUnMute n/a instantly set volume to full


Mood functions

Call: Parameters: Usage:
AM_SetValence INT valence instantly change valence (0=menu, 1=positive, 2=neutral, 3=negative)
AM_GetValence returns INT valence retrieve current valence state (0-3)
AM_SetIntensity INT intensity instantly change intensity (0-10)
AM_GetIntensity returns INT intensity retrieve current intensity level
AM_SetMood INT valence, INT intensity instantly change both valence and intensity
AM_GetMood INT valence, INT intensity retrieve both current valence and intensity
AM_ESI_SetState INT state set emotional state (1=relaxed, 2=tense, 3=neutral, 4=excited, 5=distress)
AM_ESI_GetState returns INT state retrieve current emotional state (1-5)
AM_ESI_SetEC INT event, INT status toggle event channel, (1-3, status 1=on, 2=off)
AM_ESI_GetEC INT event, returns INT status retrieve event channel status


Miscellaneous functions

Call: Parameters: Usage:
AM_Ping n/a simple lib test, trigger a Windows dialog box with an Ok button
AM_Init n/a initiate lib, load/decompress all assets, fill post-mix buffer
AM_Free n/a release all resources
AM_GetCPU returns FLOAT cpu retrieve current CPU load (mixing only, including DSP effects)
AM_SetESM INT model set interface model (0=none, 1=ESI, 2=ACP)
AM_GetESM returns INT model get active interface model (0-2)
AM_SetSubSong INT level switch to another sub song
AM_GetSubSong returns INT level retrieve current sub song
AM_SetOutcome INT outcome set active extro (1=win, 2=lose)
AM_GetOutcome returns INT outcome retrieve active extro
AM_SetFadeTime INT time set global fade time (0-5000)
AM_GetFadeTime returns INT time retrieve current global fade time
AM_SetFX INT fx experimental, enable/disable fixed FX enhancements (0/1)
AM_GetFX returns INT fx experimental, retrieve current FX status


DSP & parametric EQ functions

Call: Parameters: Usage:
AM_FX_Echo INT status experimental, enables/disables fixed Echo filter (0/1)
AM_FX_Flanger INT status experimental, enables/disables fixed Flange filter (0/1)
AM_FX_Rotate INT status experimental, enables/disables fixed Rotate filter (0/1
AM_EQ_Low INT value parametric equalizer: set 125 Hz value (0-20)
AM_EQ_Med INT value parametric equalizer: set 1 KHz value (0-20)
AM_EQ_High INT value parametric equalizer: set 6 KHz value (0-20)
AM_EQ_DryWet INT value parametric reverb filter: set dry-wet value (0-20)