Firelight Technologies FMOD Studio API

FSBANK_RESULT

Error codes returned from every function.

Enumeration

typedef enum {
  FSBANK_OK,
  FSBANK_ERR_CACHE_CHUNKNOTFOUND,
  FSBANK_ERR_CANCELLED,
  FSBANK_ERR_CANNOT_CONTINUE,
  FSBANK_ERR_ENCODER,
  FSBANK_ERR_ENCODER_INIT,
  FSBANK_ERR_ENCODER_NOTSUPPORTED,
  FSBANK_ERR_FILE_OS,
  FSBANK_ERR_FILE_NOTFOUND,
  FSBANK_ERR_FMOD,
  FSBANK_ERR_INITIALIZED,
  FSBANK_ERR_INVALID_FORMAT,
  FSBANK_ERR_INVALID_FORMAT_PCMBITS,
  FSBANK_ERR_INVALID_PARAM,
  FSBANK_ERR_MEMORY,
  FSBANK_ERR_UNINITIALIZED,
  FSBANK_ERR_WRITER_FORMAT,
  FSBANK_WARN_CANNOTLOOP,
  FSBANK_WARN_IGNORED_OPTIMIZESAMPLERATE,
  FSBANK_WARN_IGNORED_FILTERHIGHFREQ,
  FSBANK_WARN_IGNORED_DISABLESEEKING,
  FSBANK_WARN_IGNORED_DONTINTERLEAVE
} FSBANK_RESULT;

Values

FSBANK_OK

No errors.

FSBANK_ERR_CACHE_CHUNKNOTFOUND

An expected chunk is missing from the cache, perhaps try deleting cache files.

FSBANK_ERR_CANCELLED

The build process was cancelled during compilation by the user.

FSBANK_ERR_CANNOT_CONTINUE

The build process cannot continue due to previously ignored errors.

FSBANK_ERR_ENCODER

Encoder for chosen format has encountered an unexpected error.

FSBANK_ERR_ENCODER_INIT

Encoder initialization failed.

FSBANK_ERR_ENCODER_NOTSUPPORTED

Encoder for chosen format is not supported on this platform.

FSBANK_ERR_FILE_OS

An operating system based file error was encountered.

FSBANK_ERR_FILE_NOTFOUND

A specified file could not be found.

FSBANK_ERR_FMOD

Internal error from FMOD sub-system.

FSBANK_ERR_INITIALIZED

Already initialized.

FSBANK_ERR_INVALID_FORMAT

The format of the source file is invalid, see output for details.

FSBANK_ERR_INVALID_FORMAT_PCMBITS

The format of the source file is invalid, the source bit formats (i.e. PCM8, PCM16, etc) must match for all sub-sounds

FSBANK_ERR_INVALID_PARAM

An invalid parameter has been passed to this function.

FSBANK_ERR_MEMORY

Ran out of memory.

FSBANK_ERR_UNINITIALIZED

Not initialized yet.

FSBANK_ERR_WRITER_FORMAT

Chosen encode format is not supported by this FSB version.

FSBANK_WARN_CANNOTLOOP

Source file is too short for seamless looping. Looping disabled.

FSBANK_WARN_IGNORED_OPTIMIZESAMPLERATE

FSBANK_BUILD_OPTIMIZESAMPLERATE flag ignored: MP2, MP3 and CELT formats, and the USEBASICHEADERS flag make this option irrelevant.

FSBANK_WARN_IGNORED_FILTERHIGHFREQ

FSBANK_BUILD_FILTERHIGHFREQ flag ignored: feature only supported by XMA format.

FSBANK_WARN_IGNORED_DISABLESEEKING

FSBANK_BUILD_DISABLESEEKING flag ignored: feature only supported by XMA format.

FSBANK_WARN_IGNORED_DONTINTERLEAVE

FSBANK_BUILD_DONTINTERLEAVE flag ignored: feature only supported by VAG and GCADPCM formats.




Version 1.03.06 Built on Apr 17, 2014