Firelight Technologies FMOD Studio API

System::getSoftwareFormat

Retrieves the output format for the software mixer.

C++ Syntax

FMOD_RESULT System::getSoftwareFormat(
  int *samplerate,
  FMOD_SPEAKERMODE *speakermode,
  int *numrawspeakers
);

C Syntax

FMOD_RESULT FMOD_System_GetSoftwareFormat(
  FMOD_SYSTEM *system,
  int *samplerate,
  FMOD_SPEAKERMODE *speakermode,
  int *numrawspeakers
);

C# Syntax

RESULT System.getSoftwareFormat(
  out int samplerate,
  out SPEAKERMODE speakermode,
  out int numrawspeakers
);

JavaScript Syntax

System.getSoftwareFormat(
  samplerate,                      // writes value to samplerate.val
  speakermode,                     // writes value to speakermode.val
  numrawspeakers                   // writes value to numrawspeakers.val
);

Parameters

samplerate

Address of a variable that receives the sample rate of the mixer. Optional. Specify 0 or NULL to ignore.

speakermode

Address of a variable that receives the speaker setup of the mixer. Optional. Specify 0 or NULL to ignore.

numrawspeakers

Address of a variable that receives the number of speakers for FMOD_SPEAKERMODE_RAW mode. 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

Note that the settings returned here may differ from the settings provided by the user with System::setSoftwareFormat. This is because the driver may require certain settings to initialize.

See Also

• System::setSoftwareFormat
• FMOD_SOUND_FORMAT
• FMOD_DSP_RESAMPLER

Version 1.10.03 Built on Feb 1, 2018