Firelight Technologies FMOD Studio API

FSBANK_BUILDFLAGS

Bit fields to use with FSBank_Build and in FSBANK_SUBSOUND to control how subsounds are encoded.

Definition

#define FSBANK_BUILD_DEFAULT 0x00000000
#define FSBANK_BUILD_DISABLESYNCPOINTS 0x00000001
#define FSBANK_BUILD_DONTLOOP 0x00000002
#define FSBANK_BUILD_FILTERHIGHFREQ 0x00000004
#define FSBANK_BUILD_DISABLESEEKING 0x00000008
#define FSBANK_BUILD_OPTIMIZESAMPLERATE 0x00000010
#define FSBANK_BUILD_DONTINTERLEAVE 0x00000020
#define FSBANK_BUILD_FSB4_USEBASICHEADERS 0x00000040
#define FSBANK_BUILD_FSB5_DONTWRITENAMES 0x00000080
#define FSBANK_BUILD_NOGUID 0x00000100
#define FSBANK_BUILD_WRITEPEAKVOLUME 0x00000200
#define FSBANK_BUILD_OVERRIDE_MASK (FSBANK_BUILD_DISABLESYNCPOINTS | FSBANK_BUILD_DONTLOOP | FSBANK_BUILD_FILTERHIGHFREQ | FSBANK_BUILD_DISABLESEEKING | FSBANK_BUILD_OPTIMIZESAMPLERATE | FSBANK_BUILD_DONTINTERLEAVE | FSBANK_BUILD_WRITEPEAKVOLUME)
#define FSBANK_BUILD_CACHE_VALIDATION_MASK (FSBANK_BUILD_DONTLOOP | FSBANK_BUILD_FILTERHIGHFREQ | FSBANK_BUILD_OPTIMIZESAMPLERATE | FSBANK_BUILD_DONTINTERLEAVE)

Values

FSBANK_BUILD_DEFAULT

Build with default settings.

FSBANK_BUILD_DISABLESYNCPOINTS

Disable the storing of syncpoints in the output

FSBANK_BUILD_DONTLOOP

Disable perfect loop encoding and sound stretching. Removes chirps from the start of oneshot MP2, MP3 and IMAADPCM sounds.

FSBANK_BUILD_FILTERHIGHFREQ

XMA only. Enable high frequency filtering.

FSBANK_BUILD_DISABLESEEKING

XMA only. Disable seek tables to save memory.

FSBANK_BUILD_OPTIMIZESAMPLERATE

Attempt to optimize the sample rate down. Ignored if format is MP2, MP3 or CELT or if FSB4 basic headers flag is used.

FSBANK_BUILD_DONTINTERLEAVE

VAG and GCADPCM only. Don't interleave the data as LRLRLRLR... instead use LLLLRRRR type encoding. Speeds up loading for samples (not streams, streams must remained interleaved), allows FMOD_OPENMEMORY_POINT.

FSBANK_BUILD_FSB4_USEBASICHEADERS

FSB4 format only. Generate FSBs with small sample header data. They only contain basic information such as sample length, and everything else has its attributes inherited from the first sample (for example the default frequency).

FSBANK_BUILD_FSB5_DONTWRITENAMES

FSB5 format only. Do not write out a names chunk to the FSB to reduce file size.

FSBANK_BUILD_NOGUID

FSB5 format only. Write out a null GUID for the FSB header. The runtime will not use header caching for these FSB files.

FSBANK_BUILD_WRITEPEAKVOLUME

FSB5 format only. Write peak volume for all subsounds.

FSBANK_BUILD_OVERRIDE_MASK

Build flag mask that specifies which settings can be overridden per subsound.

FSBANK_BUILD_CACHE_VALIDATION_MASK

Build flag mask that specifies which settings (when changed) invalidate a cache file.

See Also




Version 1.03.06 Built on Apr 17, 2014