Player::setVoiceFxPeakEq: Difference between revisions

Revision as of 18:39, 17 October 2022

Syntax

player.setVoiceFxPeakEq(fxHandle, {
    lBand,
    fBandwidth,
    fQ,
    fCenter,
    fGain,
    lChannel
});

Required Arguments

fxHandle: int The effect handle.
lBand: int Number of bands (0...n), more bands means more memory and cpu usage. Default = 0.
fBandwidth: float Bandwidth in octaves (0.1...4...n), Q is not in use (fBandwidth has priority over fQ). Default = 1 (0=not in use). In most cases users should use the minimum of 0.5 octave. The bandwidth in octaves (between -3 dB frequencies for BPF and notch or between midpoint (dBgain/2) gain frequencies for peaking EQ).
fQ: float EE kinda definition of Q (0.1...1...n), if bandwidth is not in use. Default = 0.0 (0=not in use).
fCenter: float Center frequency in Hz (1Hz...nHz). Default = 1000 (max. is 1/2 of the samplerate).
fGain: float Gain in dB (-15...0...+15). Default 0dB.
lChannel: int A BASSFXChan flag to define on which channels to apply the effect. Default: -1 (BASS_BFX_CHANALL) - all channels.

@@ Line 12: / Line 12: @@
 ===Required Arguments===
-*'''fxHandle:''' The effect handle.
+*'''fxHandle:''' {{RageType|int}} The effect handle.
-*'''lBand:''' Number of bands (0...n), more bands means more memory and cpu usage. Default = 0.
+*'''lBand:''' {{RageType|int}} Number of bands (0...n), more bands means more memory and cpu usage. Default = 0.
-*'''fBandwidth:''' Bandwidth in octaves (0.1...4...n), Q is not in use (fBandwidth has priority over fQ). Default = 1 (0=not in use). In most cases users should use the minimum of 0.5 octave. The bandwidth in octaves (between -3 dB frequencies for BPF and notch or between midpoint (dBgain/2) gain frequencies for peaking EQ).
+*'''fBandwidth:''' {{RageType|float}} Bandwidth in octaves (0.1...4...n), Q is not in use (fBandwidth has priority over fQ). Default = 1 (0=not in use). In most cases users should use the minimum of 0.5 octave. The bandwidth in octaves (between -3 dB frequencies for BPF and notch or between midpoint (dBgain/2) gain frequencies for peaking EQ).
-*'''fQ:''' EE kinda definition of Q (0.1...1...n), if bandwidth is not in use. Default = 0.0 (0=not in use).
+*'''fQ:''' {{RageType|float}} EE kinda definition of Q (0.1...1...n), if bandwidth is not in use. Default = 0.0 (0=not in use).
-*'''fCenter:''' Center frequency in Hz (1Hz...nHz). Default = 1000 (max. is 1/2 of the samplerate).
+*'''fCenter:''' {{RageType|float}} Center frequency in Hz (1Hz...nHz). Default = 1000 (max. is 1/2 of the samplerate).
-*'''fGain:''' Gain in dB (-15...0...+15). Default 0dB.
+*'''fGain:''' {{RageType|float}} Gain in dB (-15...0...+15). Default 0dB.
-*'''lChannel:''' A BASSFXChan flag to define on which channels to apply the effect. Default: -1 (BASS_BFX_CHANALL) - all channels.
+*'''lChannel:''' {{RageType|int}} A BASSFXChan flag to define on which channels to apply the effect. Default: -1 (BASS_BFX_CHANALL) - all channels.
 [[Category:Clientside API]]