Firelight Technologies FMOD Studio API

System::update

Updates the FMOD system. This should be called once per 'game' tick, or once per frame in your application.

C++ Syntax

FMOD_RESULT System::update();

C Syntax

FMOD_RESULT FMOD_System_Update(FMOD_SYSTEM *system);

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

This updates the following things.

• 3D Sound. System::update must be called to get 3D positioning.
• Virtual voices. If more voices are played than there are real voices, System::update must be called to handle the virtualization.
• *_NRT output modes. System::update must be called to drive the output for these output modes.
• FMOD_INIT_STREAM_FROM_UPDATE. System::update must be called to update the streamer if this flag has been used.
• Callbacks. System::update must be called to fire callbacks if they are specified.
• FMOD_NONBLOCKING. System::update must be called to make sounds opened with FMOD_NONBLOCKING flag to work properly.

If FMOD_OUTPUTTYPE_NOSOUND_NRT or FMOD_OUTPUTTYPE_WAVWRITER_NRT output modes are used, this function also drives the software / DSP engine, instead of it running asynchronously in a thread as is the default behaviour.

This can be used for faster than realtime updates to the decoding or DSP engine which might be useful if the output is the wav writer for example.

If FMOD_INIT_STREAM_FROM_UPDATE is used, this function will update the stream engine. Combining this with the non realtime output will mean smoother captured output.

Warning! Do not be tempted to call this function from a different thread to other FMOD commands! This is dangerous and will cause corruption/crashes. This function is not thread safe, and should be called from the same thread as the rest of the FMOD commands.

See Also

• System::init
• FMOD_INITFLAGS
• FMOD_OUTPUTTYPE
• FMOD_MODE

Version 1.03.06 Built on Apr 17, 2014