Firelight Technologies FMOD Studio API
System::setOutput
This function selects the output mode for the platform. This is for selecting different OS specific APIs which might have different features.
C++ Syntax
FMOD_RESULT System::setOutput(
FMOD_OUTPUTTYPE output
);
C Syntax
FMOD_RESULT FMOD_System_SetOutput(
FMOD_SYSTEM *system,
FMOD_OUTPUTTYPE output
);
C# Syntax
RESULT System.setOutput(
OUTPUTTYPE output
);
JavaScript Syntax
System.setOutput(
output
);
Parameters
- output
- Output type to select. See FMOD_OUTPUTTYPE for different output types you can select.
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 is only necessary if you want to specifically switch away from the default output mode for the operating system. The most optimal mode is selected by default for the operating system.
(Windows Only) This function can be called after FMOD is already activated, you can use it to change the output mode at runtime. If FMOD_SYSTEM_CALLBACK_DEVICELISTCHANGED is specified use the setOutput call to change to FMOD_OUTPUTTYPE_NOSOUND if no more sound card drivers exist.
NOTE! When using the Studio API, switching to an NRT output mode after FMOD is already activated will not behave correctly unless the Studio API was initialized with FMOD_STUDIO_INIT_SYNCHRONOUS_UPDATE.
See Also
Version 1.10.03 Built on Feb 1, 2018