Development Notes: Upgrading FMOD version

Jump to bottom Edit New page

Martin Evans edited this page Oct 9, 2015 · 1 revision

How to upgrade SSS to use a new version of FMOD

Download new FMOD Installer

Download and run the latest Windows installer (For example this, requires login).
Copy fmod.cs, fmod_dsp.cs and fmod_errors.cs from C:\Program Files (x86)\FMOD SoundSystem\FMOD Studio API Windows\api\lowlevel\inc to <project root>\SupersonicSound\Wrapper\Fmod
Copy fmod_studio.cs from C:\Program Files (x86)\FMOD SoundSystem\FMOD Studio API Windows\api\studio\inc to <project root>\SupersonicSound\Wrapper\Fmod

Update SSS project

Rebuild and fix/update any changes in the API, use FMOD's release notes in the process
Ask FMOD support for clarity on changes if necessary, they have been very helpful so far. It is possible they have mistakes in the wrapper itself, it's not their primary API. They have accepted our suggestions in the past.

Fix new/changed enums

Run through the sample applications and examine the exceptions thrown on mismatched enums (see documentation on EquivalentEnumAttribute here)
Fix the enums by adding/updating/deleting the SSS enums to match the FMOD wrapper, copy/paste the summary description as well

Update Repository

Create issue in GitHub and submit Pull Request