FMOD

Build All Banks / Platforms and also do custom a step

The Why

Building is an essential part of the FMOD workflow but we might also require to always do an additional step. For example to generate a file with the duration of each Voice Over .wav file if we need it at the game engine author time (not only at runtime). Without a solution we need to do two steps every time: First build the banks and then run your custom script. This can be tedious and easy to forget.

Solution: Use Unity Editor Scripting

It is easy to add Unity editor code for our game specific needs in general, such as generating this file. It is also straight forward to call the FMOD Unity integration to build the banks. So we make a menu item that does both steps.

// Assets/Code/Editor/BuildBanksAndDoCustomStep.cs
[MenuItem("Audio/Build Banks and do custom step %#&b")] // Ctrl+Shift+Alt+B
public static void BuildSoundBanksAndDoCustomStep()
{
	string msg = "Building all the banks to all the platforms listed in the build tab of the preferences dialog."
	EditorUtility.DisplayProgressBar("Building FMOD Banks", msg, 0.5f);
	bool success = FMODUnity.EditorUtils.SendScriptCommand("studio.project.build();");
	if(!success)
	{
		msg = "Likely because FMOD is not running. Cancelling the process.";
		EditorUtility.ClearProgressBar();
		EditorUtility.DisplayDialog("FAILED to connect to FMOD Studio", msg, "Ok");
		// This is what likely causes the failure but we do not get what exactly failed back from the FMOD API.
		// This script command does not check if you are building banks for the correct FMOD project so we need to make sure the correct one is open in FMOD Studio.
		return;
	}
	// TODO: to the custom step here, for example generate a Voice Over file with the duration of each VO .wav file.
	EditorUtility.ClearProgressBar();
	// Show a dialog that the process is done, with errors if any.
}