Firelight Technologies FMOD Studio API

FMOD_DSP_STATE

DSP plugin structure that is passed into each callback.

Structure

typedef struct {
  FMOD_DSP *instance;
  void *plugindata;
  FMOD_CHANNELMASK channelmask;
  FMOD_SPEAKERMODE source_speakermode;
  float *sidechaindata;
  int sidechainchannels;
  FMOD_DSP_STATE_SYSTEMCALLBACKS *callbacks;
} FMOD_DSP_STATE;

Members

instance

[r] Handle to the FMOD_DSP object the callback is associated with. Not to be modified. C++ users cast to FMOD::DSP to use.

plugindata

[r/w] Plugin writer created data the output author wants to attach to this object.

channelmask

[r] Specifies which speakers the DSP effect is active on

source_speakermode

[r] Specifies which speaker mode the signal originated for information purposes, ie in case panning needs to be done differently.

sidechaindata

[r] The mixed result of all incoming sidechains is stored at this pointer address.

sidechainchannels

[r] The number of channels of pcm data stored within the sidechain buffer.

callbacks

[r] Struct containing callbacks for system level functionality.

Remarks

Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.
Members marked with [w] mean the variable can be written to. The user can set the value.

See Also




Version 1.03.06 Built on Apr 17, 2014