Firelight Technologies FMOD Studio API
System::setSoftwareFormat
Sets the output format for the software mixer.
If loading Studio banks, this must be called with speakermode corresponding to the project's output format if there is a possibility of the output audio device not matching the project's format. Any differences between the project format and the system's speakermode will cause the mix to sound wrong.
If not loading Studio banks, do not call this unless you explicity want to change a setting from the default. FMOD will default to the speaker mode and sample rate that the OS / output prefers.
C++ Syntax
FMOD_RESULT System::setSoftwareFormat(
int samplerate,
FMOD_SPEAKERMODE speakermode,
int numrawspeakers
);
C Syntax
FMOD_RESULT FMOD_System_SetSoftwareFormat(
FMOD_SYSTEM *system,
int samplerate,
FMOD_SPEAKERMODE speakermode,
int numrawspeakers
);
C# Syntax
RESULT System.setSoftwareFormat(
int samplerate,
SPEAKERMODE speakermode,
int numrawspeakers
);
JavaScript Syntax
System.setSoftwareFormat(
samplerate,
speakermode,
numrawspeakers
);
Parameters
- samplerate
- Sample rate in Hz, that the software mixer will run at. Specify values between 8000 and 192000.
- speakermode
- Speaker setup for the software mixer.
- numrawspeakers
- Number of output channels / speakers to initialize the sound card to in FMOD_SPEAKERMODE_RAW mode. Optional. Specify 0 to ignore. Maximum of FMOD_MAX_CHANNEL_WIDTH.
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
This function cannot be called after FMOD is already activated, it must be called before System::init, or after System::close.
See Also
Version 1.10.03 Built on Feb 1, 2018