FMOD_STUDIO_ADVANCEDSETTINGS

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_STUDIO_ADVANCEDSETTINGS

Settings for advanced features like configuring memory and cpu usage.

C/C++ Syntax

typedef struct {
  int cbsize;
  unsigned int commandqueuesize;
  unsigned int handleinitialsize;
  int studioupdateperiod;
  int idlesampledatapoolsize;
} FMOD_STUDIO_ADVANCEDSETTINGS;

JavaScript Syntax

struct FMOD_STUDIO_ADVANCEDSETTINGS
{
  commandqueuesize,
  handleinitialsize,
  studioupdateperiod,
  idlesampledatapoolsize,
};

Members

cbsize

[w] Size of this structure. Use sizeof(FMOD_STUDIO_ADVANCEDSETTINGS) NOTE: This must be set before calling Studio::System::getAdvancedSettings or Studio::System::setAdvancedSettings!

commandqueuesize

[r/w] Optional. Specify 0 to ignore. Specify the command queue size for studio async processing. Default 32kB.

handleinitialsize

[r/w] Optional. Specify 0 to ignore. Specify the initial size to allocate for handles. Memory for handles will grow as needed in pages. Default 8192 * sizeof(void*)

studioupdateperiod

[r/w] Optional. Specify 0 to ignore. Specify the update period of Studio when in async mode, in milliseconds. Will be quantised to the nearest multiple of mixer duration. Default is 20ms.

idlesampledatapoolsize

[r/w] Optional. Specify 0 to ignore. Specify the amount of sample data to keep in memory when no longer used, to avoid repeated disk IO. Use -1 to disable. Default is 256kB.

Remarks

Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.
Members marked with [w] mean the variable can be written to. The user can set the value.
Members marked with [r/w] are either read or write depending on if you are using System::setAdvancedSettings (w) or System::getAdvancedSettings (r).

JavaScript only :

Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.STUDIO_ADVANCEDSETTINGS()", no 'new' keyword is required.

See Also




Version 1.10.03 Built on Feb 1, 2018