Firelight Technologies FMOD Studio API
FMOD_OUTPUT_STATE
Output object state passed into every callback provides access to plugin developers data and system functionality.
C/C++ Syntax
typedef struct {
void *plugindata;
FMOD_OUTPUT_READFROMMIXER_FUNC readfrommixer;
FMOD_OUTPUT_ALLOC_FUNC alloc;
FMOD_OUTPUT_FREE_FUNC free;
FMOD_OUTPUT_LOG_FUNC log;
FMOD_OUTPUT_COPYPORT_FUNC copyport;
FMOD_OUTPUT_REQUESTRESET_FUNC requestreset;
} FMOD_OUTPUT_STATE;
JavaScript Syntax
struct FMOD_OUTPUT_STATE
{
plugindata,
};
Members
plugindata
[w] Pointer used to store any plugin specific state so it's available in all callbacks.
readfrommixer
[r] Function to execute the mixer producing a buffer of audio. Used to control when the mix occurs manually as an alternative to FMOD_OUTPUT_DESCRIPTION::polling == TRUE.
alloc
[r] Function to allocate memory using the FMOD memory system.
free
[r] Function to free memory allocated with FMOD_OUTPUT_ALLOC.
log
[r] Function to write to the FMOD logging system.
copyport
[r] Function to copy the output from the mixer for the given auxiliary port.
requestreset
[r] Function to request the output plugin be shutdown then restarted during the next System::update.
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.OUTPUT_STATE()", no 'new' keyword is required.
See Also
Version 1.10.03 Built on Feb 1, 2018