Skip to main content

Player::setVoiceFxChorus

Syntax

``` player.setVoiceFxChorus(fxHandle, {

   fWetDryMix,
   fDepth,
   fFeedback,
   fFrequency,
   lWaveform,
   fDelay,
   lPhase

}); ```

Required Arguments

  • fxHandle: The effect handle.
  • fWetDryMix: Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 (default) through 100 (all wet).
  • fDepth: Percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 25.
  • fFeedback: Percentage of output signal to feed back into the effect's input, in the range from -99 to 99. The default value is 0.
  • fFrequency: Frequency of the LFO, in the range from 0 to 10. The default value is 0.
  • lWaveform: Waveform of the LFO... 0 = triangle, 1 = sine. By default, the waveform is a sine.
  • fDelay: Number of milliseconds the input is delayed before it is played back, in the range from 0 to 20. The default value is 0 ms.
  • lPhase: Phase differential between left and right LFOs, one of BASSFXPhase values. Default is (int)BASSFXPhase.BASS_FX_PHASE_ZERO.

BASSFXPhase

``` const BASSFXPhase = {

   BASS_FX_PHASE_NEG_180: 0, // Phase differential between left and right LFOs (-180)
   BASS_FX_PHASE_NEG_90: 1, // Phase differential between left and right LFOs (-90)
   BASS_FX_PHASE_ZERO: 2, // Phase differential between left and right LFOs (+/-0)
   BASS_FX_PHASE_90: 3, // Phase differential between left and right LFOs (+90)
   BASS_FX_PHASE_180: 4 // Phase differential between left and right LFOs (+180)

}; ```

See also