Player::setVoiceFxDistortion: Difference between revisions
(Created page with "==Syntax== <pre> player.setVoiceFxDistortion(fxHandle, { fGain, fEdge, fPostEQCenterFrequency, fPostEQBandwidth, fPreLowpassCutoff }); </pre> ===Required...") |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 11: | Line 11: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''fxHandle:''' The effect handle. | *'''fxHandle:''' {{RageType|int}} The effect handle. | ||
*'''fGain:''' Amount of signal change after distortion, in the range from -60 through 0. The default value is 0 dB. | *'''fGain:''' {{RageType|float}} Amount of signal change after distortion, in the range from -60 through 0. The default value is 0 dB. | ||
*'''fEdge:''' Percentage of distortion intensity, in the range in the range from 0 through 100. The default value is 50 percent. | *'''fEdge:''' {{RageType|float}} Percentage of distortion intensity, in the range in the range from 0 through 100. The default value is 50 percent. | ||
*'''fPostEQCenterFrequency:''' Center frequency of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz. | *'''fPostEQCenterFrequency:''' {{RageType|float}} Center frequency of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz. | ||
*'''fPostEQBandwidth:''' Width of frequency band that determines range of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz. | *'''fPostEQBandwidth:''' {{RageType|float}} Width of frequency band that determines range of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz. | ||
*'''fPreLowpassCutoff:''' Filter cutoff for high-frequency harmonics attenuation, in the range from 100 through 8000. The default value is 4000 Hz. | *'''fPreLowpassCutoff:''' {{RageType|float}} Filter cutoff for high-frequency harmonics attenuation, in the range from 100 through 8000. The default value is 4000 Hz. | ||
==See also== | |||
{{VoiceFx_definition_c}} | |||
[[Category:Clientside API]] | [[Category:Clientside API]] | ||
Latest revision as of 08:31, 10 November 2024
Syntax
player.setVoiceFxDistortion(fxHandle, {
fGain,
fEdge,
fPostEQCenterFrequency,
fPostEQBandwidth,
fPreLowpassCutoff
});
Required Arguments
- fxHandle: int The effect handle.
- fGain: float Amount of signal change after distortion, in the range from -60 through 0. The default value is 0 dB.
- fEdge: float Percentage of distortion intensity, in the range in the range from 0 through 100. The default value is 50 percent.
- fPostEQCenterFrequency: float Center frequency of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz.
- fPostEQBandwidth: float Width of frequency band that determines range of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz.
- fPreLowpassCutoff: float Filter cutoff for high-frequency harmonics attenuation, in the range from 100 through 8000. The default value is 4000 Hz.
See also
- Player::removeVoiceFx
- Player::resetVoiceFx
- Player::setVoiceFxChorus
- Player::setVoiceFxCompressor
- Player::setVoiceFxDistortion
- Player::setVoiceFxEcho
- Player::setVoiceFxFlanger
- Player::setVoiceFxGargle
- Player::setVoiceFxI3DL2Reverb
- Player::setVoiceFxParamEq
- Player::setVoiceFxReverb
- Player::setVoiceFxVolume
- Player::setVoiceFxPeakEq
- Player::setVoiceFxBQF