Firelight Technologies FMOD Studio API

DSP::showConfigDialog

Display or hide a DSP unit configuration dialog box inside the target window.

C++ Syntax

FMOD_RESULT DSP::showConfigDialog(
  void *hwnd,
  bool show
);

C Syntax

FMOD_RESULT FMOD_DSP_ShowConfigDialog(
  FMOD_DSP *dsp,
  void *hwnd,
  FMOD_BOOL show
);

C# Syntax

RESULT DSP.showConfigDialog(
  IntPtr hwnd,
  bool show
);

JavaScript Syntax

DSP.showConfigDialog(
  hwnd,                            
  show                             
);

Parameters

hwnd

Target HWND in windows to display configuration dialog.

show

true = show dialog box inside target hwnd. false = remove dialog from target hwnd.

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

Dialog boxes are used by DSP plugins that prefer to use a graphical user interface to modify their parameters rather than using the other method of enumerating the parameters and using DSP::setParameterFloat / DSP::setParameterInt / DSP::setParameterBool / DSP::setParameterData.

These are usually VST plugins. FMOD Studio plugins do not have configuration dialog boxes. To find out what size window to create to store the configuration screen, use DSP::getInfo where you can get the width and height.

See Also

• DSP::getInfo
• DSP::setParameterFloat
• DSP::setParameterInt
• DSP::setParameterBool
• DSP::setParameterData
• DSP::getParameterFloat
• DSP::getParameterInt
• DSP::getParameterBool
• DSP::getParameterData

Version 1.10.03 Built on Feb 1, 2018