Firelight Technologies FMOD Studio API

System::getStreamBufferSize

Returns the current internal buffersize settings for streamable sounds.

C++ Syntax

FMOD_RESULT System::getStreamBufferSize(
  unsigned int *filebuffersize,
  FMOD_TIMEUNIT *filebuffersizetype
);

C Syntax

FMOD_RESULT FMOD_System_GetStreamBufferSize(
  FMOD_SYSTEM *system,
  unsigned int *filebuffersize,
  FMOD_TIMEUNIT *filebuffersizetype
);

C# Syntax

RESULT System.getStreamBufferSize(
  out uint filebuffersize,
  out TIMEUNIT filebuffersizetype
);

JavaScript Syntax

System.getStreamBufferSize(
  filebuffersize,                  // writes value to filebuffersize.val
  filebuffersizetype               // writes value to filebuffersizetype.val
);

Parameters

filebuffersize

Address of a variable that receives the current stream file buffer size setting. Default is 16384 (FMOD_TIMEUNIT_RAWBYTES). Optional. Specify 0 or NULL to ignore.

filebuffersizetype

Address of a variable that receives the type of unit for the current stream file buffer size setting. Can be FMOD_TIMEUNIT_MS, FMOD_TIMEUNIT_PCM, FMOD_TIMEUNIT_PCMBYTES or FMOD_TIMEUNIT_RAWBYTES. Default is FMOD_TIMEUNIT_RAWBYTES. 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.

See Also

• FMOD_TIMEUNIT
• System::setStreamBufferSize

Version 1.10.03 Built on Feb 1, 2018