Firelight Technologies FMOD Studio API

System::getDSPBufferSize

Retrieves the buffer size settings for the FMOD software mixing engine.

C++ Syntax

FMOD_RESULT System::getDSPBufferSize(
  unsigned int *bufferlength,
  int *numbuffers
);

C Syntax

FMOD_RESULT FMOD_System_GetDSPBufferSize(
  FMOD_SYSTEM *system,
  unsigned int *bufferlength,
  int *numbuffers
);

C# Syntax

RESULT System.getDSPBufferSize(
  out uint bufferlength,
  out int numbuffers
);

JavaScript Syntax

System.getDSPBufferSize(
  bufferlength,                    // writes value to bufferlength.val
  numbuffers                       // writes value to numbuffers.val
);

Parameters

bufferlength

Address of a variable that receives the mixer engine block size in samples. Default = 1024. (milliseconds = 1024 at 48khz = 1024 / 48000 * 1000 = 10.66ms). This means the mixer updates every 21.3ms. Optional. Specify 0 or NULL to ignore.

numbuffers

Address of a variable that receives the mixer engine number of buffers used. Default = 4. To get the total buffersize multiply the bufferlength by the numbuffers value. By default this would be 4*1024. Optional. Specify 0 or NULL to ignore.

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

See documentation on System::setDSPBufferSize for more information about these values.

See Also

• System::setDSPBufferSize

Version 1.10.03 Built on Feb 1, 2018