Firelight Technologies FMOD Studio API

Studio::System::loadBankMemory

Loads a Studio event bank from memory.

C++ Syntax

FMOD_RESULT Studio::System::loadBankMemory(
  const char *buffer,
  int length,
  FMOD_STUDIO_LOAD_MEMORY_MODE mode,
  FMOD_STUDIO_LOAD_BANK_FLAGS flags,
  Studio::Bank **bank
);

C Syntax

FMOD_RESULT FMOD_Studio_System_LoadBankMemory(
  FMOD_STUDIO_SYSTEM *system,
  const char *buffer,
  int length,
  FMOD_STUDIO_LOAD_MEMORY_MODE mode,
  FMOD_STUDIO_LOAD_BANK_FLAGS flags,
  FMOD_STUDIO_BANK **bank
);

Parameters

buffer
Memory buffer to load from. This should be 32-byte aligned if mode is FMOD_STUDIO_LOAD_MEMORY_POINT.
length
Length of the memory buffer.
mode
Loading mode to use.
flags
Flags to control bank loading.
bank
Address of a variable to receive the Bank object.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

Specifying mode FMOD_STUDIO_LOAD_MEMORY_POINT will POINT to your memory rather than FMOD allocating its own buffers and duplicating it internally.

See Also




Version 1.03.06 Built on Apr 17, 2014