Firelight Technologies FMOD Studio API

DSP::getInfo

Retrieves information about the current DSP unit, including name, version, default channels and width and height of configuration dialog box if it exists.

C++ Syntax

FMOD_RESULT DSP::getInfo(
  char *name,
  unsigned int *version,
  int *channels,
  int *configwidth,
  int *configheight
);

C Syntax

FMOD_RESULT FMOD_DSP_GetInfo(
  FMOD_DSP *dsp,
  char *name,
  unsigned int *version,
  int *channels,
  int *configwidth,
  int *configheight
);

C# Syntax

RESULT DSP.getInfo(
  StringBuilder name,
  out uint version,
  out int channels,
  out int configwidth,
  out int configheight
);

JavaScript Syntax

DSP.getInfo(
  name,                            // writes value to name.val
  version,                         // writes value to version.val
  channels,                        // writes value to channels.val
  configwidth,                     // writes value to configwidth.val
  configheight                     // writes value to configheight.val
);

Parameters

name

Address of a variable that receives the name of the unit. This will be a maximum of 32bytes. If the DSP unit has filled all 32 bytes with the name with no terminating \0 null character it is up to the caller to append a null character. Optional. Specify 0 or NULL to ignore.

version

Address of a variable that receives the version number of the DSP unit. Version number is usually formated as hex AAAABBBB where the AAAA is the major version number and the BBBB is the minor version number. Optional. Specify 0 or NULL to ignore.

channels

Address of a variable that receives the number of channels the unit was initialized with. 0 means the plugin will process whatever number of channels is currently in the network. >0 would be mostly used if the unit is a unit that only generates sound, or is not flexible enough to take any number of input channels. Optional. Specify 0 or NULL to ignore.

configwidth

Address of a variable that receives the width of an optional configuration dialog box that can be displayed with DSP::showConfigDialog. 0 means the dialog is not present. Optional. Specify 0 or NULL to ignore.

configheight

Address of a variable that receives the height of an optional configuration dialog box that can be displayed with DSP::showConfigDialog. 0 means the dialog is not present. 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

JavaScript only :

Note: For the "name" parameter, the maximum string length is 512.

See Also

• DSP::showConfigDialog

Version 1.10.03 Built on Feb 1, 2018