Firelight Technologies FMOD Studio API

System::setOutputByPlugin

Selects an output type based on the enumerated list of outputs including FMOD and 3rd party output plugins.

C++ Syntax

FMOD_RESULT System::setOutputByPlugin(
  unsigned int handle
);

C Syntax

FMOD_RESULT FMOD_System_SetOutputByPlugin(
  FMOD_SYSTEM *system,
  unsigned int handle
);

C# Syntax

RESULT System.setOutputByPlugin(
  uint handle
);

JavaScript Syntax

System.setOutputByPlugin(
  handle                           
);

Parameters

handle

Handle to a pre-existing output plugin.

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

(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.

See Also

• System::getNumPlugins
• System::getOutputByPlugin
• System::setOutput
• System::init
• System::close

Version 1.10.03 Built on Feb 1, 2018