Player::setVoiceFxBQF: Difference between revisions
No edit summary |
No edit summary |
||
| Line 13: | Line 13: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''fxHandle:''' The effect handle. | *'''fxHandle:''' {{RageType|int}} The effect handle. | ||
*'''lFilter:''' Defines which BiQuad filter should be used. | *'''lFilter:''' {{RageType|int}} Defines which BiQuad filter should be used. | ||
*'''fCenter:''' Cut-off frequency (Center in PEAKINGEQ and Shelving filters) in Hz (1...info.freq/2). Default = 200Hz. | *'''fCenter:''' {{RageType|float}} Cut-off frequency (Center in PEAKINGEQ and Shelving filters) in Hz (1...info.freq/2). Default = 200Hz. | ||
*'''fGain:''' Gain in dB (-15...0...+15). Default 0dB (used only for PEAKINGEQ and Shelving filters). | *'''fGain:''' {{RageType|float}} Gain in dB (-15...0...+15). Default 0dB (used only for PEAKINGEQ and Shelving filters). | ||
*'''fBandwidth:''' Bandwidth in octaves (0.1...4...n), Q is not in use (fBandwidth has priority over fQ). Default = 1 (0=not in use). The bandwidth in octaves (between -3 dB frequencies for for BANDPASS and NOTCH or between midpoint (dBgain/2) gain frequencies for PEAKINGEQ). | *'''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). The bandwidth in octaves (between -3 dB frequencies for for BANDPASS and NOTCH or between midpoint (dBgain/2) gain frequencies for PEAKINGEQ). | ||
*'''fQ:''' The EE kinda definition (linear), if fBandwidth is not in use (0.1...1). Default = 0.0 (0=not in use). | *'''fQ:''' {{RageType|float}} The EE kinda definition (linear), if fBandwidth is not in use (0.1...1). Default = 0.0 (0=not in use). | ||
*'''fS:''' A shelf slope parameter (linear, used only with Shelving filters) (0.1...1). Default = 0.0. When fS=1, the shelf slope is as steep as you can get it and remain monotonically increasing or decreasing gain with frequency. | *'''fS:''' {{RageType|float}} A shelf slope parameter (linear, used only with Shelving filters) (0.1...1). Default = 0.0. When fS=1, the shelf slope is as steep as you can get it and remain monotonically increasing or decreasing gain with frequency. | ||
*'''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]] | [[Category:Clientside API]] | ||
Revision as of 18:40, 17 October 2022
Syntax
player.setVoiceFxBQF(fxHandle, {
lFilter,
fCenter,
fGain,
fBandwidth,
fQ,
fS,
lChannel
});
Required Arguments
- fxHandle: int The effect handle.
- lFilter: int Defines which BiQuad filter should be used.
- fCenter: float Cut-off frequency (Center in PEAKINGEQ and Shelving filters) in Hz (1...info.freq/2). Default = 200Hz.
- fGain: float Gain in dB (-15...0...+15). Default 0dB (used only for PEAKINGEQ and Shelving filters).
- 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). The bandwidth in octaves (between -3 dB frequencies for for BANDPASS and NOTCH or between midpoint (dBgain/2) gain frequencies for PEAKINGEQ).
- fQ: float The EE kinda definition (linear), if fBandwidth is not in use (0.1...1). Default = 0.0 (0=not in use).
- fS: float A shelf slope parameter (linear, used only with Shelving filters) (0.1...1). Default = 0.0. When fS=1, the shelf slope is as steep as you can get it and remain monotonically increasing or decreasing gain with frequency.
- lChannel: int A BASSFXChan flag to define on which channels to apply the effect. Default: -1 (BASS_BFX_CHANALL) - all channels.