Player::setVoiceFxCompressor: Difference between revisions

Latest revision as of 08:31, 10 November 2024

Syntax

player.setVoiceFxCompressor(fxHandle, {
    fGain,
    fAttack,
    fRelease,
    fThreshold,
    fRatio,
    fPredelay
});

Required Arguments

fxHandle: int The effect handle.
fGain: float Output gain of signal in dB after compression, in the range from -60 to 60. The default value is 0 dB.
fAttack: float Time in ms before compression reaches its full value, in the range from 0.01 to 500. The default value is 10 ms.
fRelease: float Time (speed) in ms at which compression is stopped after input drops below fThreshold, in the range from 50 to 3000. The default value is 200 ms.
fThreshold: float Point at which compression begins, in dB, in the range from -60 to 0. The default value is -20 dB.
fRatio: float Compression ratio, in the range from 1 to 100. The default value is 3, which means 3:1 compression.
fPredelay: float Time in ms after fThreshold is reached before attack phase is started, in milliseconds, in the range from 0 to 4. The default value is 4 ms.

@@ Line 12: / Line 12: @@
 ===Required Arguments===
-*'''fxHandle:''' The effect handle.
+*'''fxHandle:''' {{RageType|int}} The effect handle.
-*'''fGain:''' Output gain of signal in dB after compression, in the range from -60 to 60. The default value is 0 dB.
+*'''fGain:''' {{RageType|float}} Output gain of signal in dB after compression, in the range from -60 to 60. The default value is 0 dB.
-*'''fAttack:''' Time in ms before compression reaches its full value, in the range from 0.01 to 500. The default value is 10 ms.
+*'''fAttack:''' {{RageType|float}} Time in ms before compression reaches its full value, in the range from 0.01 to 500. The default value is 10 ms.
-*'''fRelease:''' Time (speed) in ms at which compression is stopped after input drops below fThreshold, in the range from 50 to 3000. The default value is 200 ms.
+*'''fRelease:''' {{RageType|float}} Time (speed) in ms at which compression is stopped after input drops below fThreshold, in the range from 50 to 3000. The default value is 200 ms.
-*'''fThreshold:''' Point at which compression begins, in dB, in the range from -60 to 0. The default value is -20 dB.
+*'''fThreshold:''' {{RageType|float}} Point at which compression begins, in dB, in the range from -60 to 0. The default value is -20 dB.
-*'''fRatio:''' Compression ratio, in the range from 1 to 100. The default value is 3, which means 3:1 compression.
+*'''fRatio:''' {{RageType|float}} Compression ratio, in the range from 1 to 100. The default value is 3, which means 3:1 compression.
-*'''fPredelay:''' Time in ms after fThreshold is reached before attack phase is started, in milliseconds, in the range from 0 to 4. The default value is 4 ms.
+*'''fPredelay:''' {{RageType|float}} Time in ms after fThreshold is reached before attack phase is started, in milliseconds, in the range from 0 to 4. The default value is 4 ms.
+==See also==
+{{VoiceFx_definition_c}}
 [[Category:Clientside API]]