Firelight Technologies FMOD Studio API
FMOD_DSP_STATE_FUNCTIONS
Struct containing functions to give plugin developers the ability to query system state, access system level functionality and helpers.
C/C++ Syntax
typedef struct {
FMOD_DSP_ALLOC_FUNC alloc;
FMOD_DSP_REALLOC_FUNC realloc;
FMOD_DSP_FREE_FUNC free;
FMOD_DSP_GETSAMPLERATE_FUNC getsamplerate;
FMOD_DSP_GETBLOCKSIZE_FUNC getblocksize;
FMOD_DSP_STATE_DFT_FUNCTIONS *dft;
FMOD_DSP_STATE_PAN_FUNCTIONS *pan;
FMOD_DSP_GETSPEAKERMODE_FUNC getspeakermode;
FMOD_DSP_GETCLOCK_FUNC getclock;
FMOD_DSP_GETLISTENERATTRIBUTES_FUNC getlistenerattributes;
FMOD_DSP_LOG_FUNC log;
FMOD_DSP_GETUSERDATA_FUNC getuserdata;
} FMOD_DSP_STATE_FUNCTIONS;
Members
alloc
[r] Function to allocate memory using the FMOD memory system.
realloc
[r] Function to reallocate memory using the FMOD memory system.
free
[r] Function to free memory allocated with FMOD_DSP_ALLOC_FUNC.
getsamplerate
[r] Function to query the system sample rate.
getblocksize
[r] Function to query the system block size, DSPs will be requested to process blocks of varying length up to this size.
dft
[r] Struct containing DFT functions to enable a plugin to perform optimized time-frequency domain conversion.
pan
[r] Struct containing panning helper functions for spatialization plugins.
getspeakermode
[r] Function to query the system speaker modes. One is the mixer's default speaker mode, the other is the output mode the system is downmixing or upmixing to.
getclock
[r] Function to get the clock of the current DSP, as well as the subset of the input buffer that contains the signal.
getlistenerattributes
[r] Callback for getting the absolute listener attributes set via the API (returned as left-handed coordinates).
log
[r] Function to write to the FMOD logging system.
getuserdata
[r] Function to get the user data attached to this DSP. See FMOD_DSP_DESCRIPTION::userdata.
Remarks
Members marked with [r] mean read only for the developer, read/write for the FMOD system.
Members marked with [w] mean read/write for the developer, read only for the FMOD system.
JavaScript only :
Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.DSP_STATE_FUNCTIONS()", no 'new' keyword is required.
See Also
Version 1.10.03 Built on Feb 1, 2018