Firelight Technologies FMOD Studio API
FSBank_Build
Begin the building process for the provided subsound descriptions, function will block until complete.
C Syntax
FSBANK_RESULT FSBank_Build(
const FSBANK_SUBSOUND *subSounds,
unsigned int numSubSounds,
FSBANK_FORMAT encodeFormat,
FSBANK_BUILDFLAGS buildFlags,
unsigned int quality,
const char *encryptKey,
const char *outputFileName
);
Parameters
subSounds
An array of subsound descriptions each defining one subsound for the final FSB.
numSubSounds
The number of elements in the 'subSounds' array.
encodeFormat
The format to be used for encoding the FSB.
buildFlags
Building flags which control how the sample data is encoded.
quality
Controls the quality level after compression. From 1 (high compression / low quality) to 100 (high quality / low compression), use 0 for default quality. See remarks for format specific usage.
encryptKey
Optional string 'key' used to encrypt the FSB, same key is required at runtime for decryption.
outputFileName
Name (and path) of the FSB to produce.
Return Values
If the function succeeds then the return value is FSBANK_OK.
If the function fails then the return value will be one of the values defined in the FSBANK_RESULT enumeration.
Remarks
- AT9 - Bitrate (Kbps) depends on channel count, quality [1 to 100] maps linearly to the available options
- 1ch = [36, 48, 60, 72, 84, 96]
- 2ch = [72, 96, 120, 144, 168, 192]
- MPEG - Bitrate (Kbps) = FMOD quality * 3.2
- Vorbis - Vorbis quality [-0.1 to 1.0] maps linearly to FMOD quality [1 to 100]
- XMA - XMA quality = FMOD quality
See Also
Version 1.10.03 Built on Feb 1, 2018