Player::setVoiceFx

2022-10-17T18:11:26Z

Ufteers: See also

==Syntax==
<pre>
player.setVoiceFx(fxType, priority);
</pre>
===Required Arguments===
*'''fxType:''' One of the following types of effect (see BASSFXType)
*'''priority:''' The priority of the new FX, which determines it's position in the DSP chain - DSP/FX with higher priority are applied before those with lower. This parameter has no effect with DX8 effects when the "with FX flag" DX8 effect implementation is used.

==BASSFXType==
<pre>
const BASSFXType = {
BASS_FX_DX8_CHORUS: 0,
BASS_FX_DX8_COMPRESSOR: 1,
BASS_FX_DX8_DISTORTION: 2,
BASS_FX_DX8_ECHO: 3,
BASS_FX_DX8_FLANGER: 4,
BASS_FX_DX8_GARGLE: 5,
BASS_FX_DX8_I3DL2REVERB: 6,
BASS_FX_DX8_PARAMEQ: 7,
BASS_FX_DX8_REVERB: 8,
BASS_FX_VOLUME: 9,

// bassfx.dll
BASS_FX_BFX_PEAKEQ: 65540,
BASS_FX_BFX_BQF: 65555
};
</pre>

==See also==
[[Player::setVoiceFxChorus]] 
[[Player::setVoiceFxCompressor]] 
[[Player::setVoiceFxDistortion]] 
[[Player::setVoiceFxEcho]] 
[[Player::setVoiceFxFlanger]] 
[[Player::setVoiceFxGargle]] 
[[Player::setVoiceFxI3DL2Reverb]] 
[[Player::setVoiceFxParamEq]] 
[[Player::setVoiceFxReverb]] 
[[Player::setVoiceFxVolume]] 
[[Player::setVoiceFxPeakEq]] 
[[Player::setVoiceFxBQF]] 

[[Category:Clientside API]]

Player::setVoiceFxBQF

2022-10-17T18:11:22Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxBQF(fxHandle, { lFilter, fCenter, fGain, fBandwidth, fQ, fS, lChannel }); </pre> ===Required Arguments=== *'''f..."

Player::setVoiceFxPeakEq

2022-10-17T18:07:56Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxPeakEq(fxHandle, { lBand, fBandwidth, fQ, fCenter, fGain, lChannel }); </pre> ===Required Arguments=== *'''fxHandle..."

==Syntax==
<pre>
player.setVoiceFxPeakEq(fxHandle, {
lBand,
fBandwidth,
fQ,
fCenter,
fGain,
lChannel
});
</pre>

===Required Arguments===
*'''fxHandle:''' The effect handle.
*'''lBand:''' 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).
*'''fQ:''' 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).
*'''fGain:''' 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.

[[Category:Clientside API]]

Player::setVoiceFxVolume

2022-10-17T18:03:53Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxVolume(fxHandle, { fTarget, fCurrent, fTime, lCurve }); </pre> ===Required Arguments=== *'''fxHandle:''' The effect handle...."

==Syntax==
<pre>
player.setVoiceFxVolume(fxHandle, {
fTarget,
fCurrent,
fTime,
lCurve
});
</pre>

===Required Arguments===
*'''fxHandle:''' The effect handle.
*'''fTarget:''' The new volume level... 0 = silent, 1.0 = normal, above 1.0 = amplification. The default value is 1.
*'''fCurrent:''' The current volume level... -1 = leave existing current level when setting parameters. The default value is 1.
*'''fTime:''' The time to take to transition from the current level to the new level, in seconds. The default value is 0.
*'''lCurve:''' The curve to use in the transition... 0 = linear, 1 = logarithmic. The default value is 0.

[[Category:Clientside API]]

Player::setVoiceFxReverb

2022-10-17T18:01:30Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxReverb(fxHandle, { fInGain, fReverbMix, fReverbTime, fHighFreqRTRatio }); </pre> ===Required Arguments=== *'''fxHandle:'''..."

==Syntax==
<pre>
player.setVoiceFxReverb(fxHandle, {
fInGain,
fReverbMix,
fReverbTime,
fHighFreqRTRatio
});
</pre>

===Required Arguments===
*'''fxHandle:''' The effect handle.
*'''fInGain:''' Input gain of signal, in decibels (dB), in the range from -96 through 0. The default value is 0 dB.
*'''fReverbMix:''' Reverb mix, in dB, in the range from -96 through 0. The default value is 0 dB.
*'''fReverbTime:''' Reverb time, in milliseconds, in the range from 0.001 through 3000. The default value is 1000.
*'''fHighFreqRTRatio:''' In the range from 0.001 through 0.999. The default value is 0.001.

[[Category:Clientside API]]

Player::setVoiceFxParamEq

2022-10-17T17:59:22Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxParamEq(fxHandle, { fCenter, fBandwidth, fGain }); </pre> ===Required Arguments=== *'''fxHandle:''' The effect handle. *'''fCen..."

==Syntax==
<pre>
player.setVoiceFxParamEq(fxHandle, {
fCenter,
fBandwidth,
fGain
});
</pre>

===Required Arguments===
*'''fxHandle:''' The effect handle.
*'''fCenter:''' Bandwidth, in semitones, in the range from 1 to 36. Default 18 semitones.
*'''fBandwidth:''' Center frequency, in hertz, in the range from 80 to 16000. This value cannot exceed one-third of the frequency of the channel. Default 100 Hz.
*'''fGain:''' Gain, in the range from -15 to 15. Default 0 dB.

[[Category:Clientside API]]

Player::setVoiceFxI3DL2Reverb

2022-10-17T17:52:47Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxI3DL2Reverb(fxHandle, { lRoom, lRoomHF, flRoomRolloffFactor, flDecayTime, flDecayHFRatio, lReflections, flReflect..."

==Syntax==
<pre>
player.setVoiceFxI3DL2Reverb(fxHandle, {
lRoom,
lRoomHF,
flRoomRolloffFactor,
flDecayTime,
flDecayHFRatio,
lReflections,
flReflectionsDelay,
lReverb,
flReverbDelay,
flDiffusion,
flDensity,
flHFReference
});
</pre>

===Required Arguments===
*'''fxHandle:''' The effect handle.
*'''lRoom:''' Attenuation of the room effect, in millibels (mB), in the range from -10000 to 0. The default value is -1000 mB.
*'''lRoomHF:''' Attenuation of the room high-frequency effect, in mB, in the range from -10000 to 0. The default value is 0 mB.
*'''flRoomRolloffFactor:''' Rolloff factor for the reflected signals, in the range from 0 to 10. The default value is 0.0.
*'''flDecayTime:''' Decay time, in seconds, in the range from 0.1 to 20. The default value is 1.49 second.
*'''flDecayHFRatio:''' Ratio of the decay time at high frequencies to the decay time at low frequencies, in the range from 0.1 to 2. The default value is 0.83.
*'''lReflections:''' Attenuation of early reflections relative to lRoom, in mB, in the range from -10000 to 1000. The default value is -2602 mB.
*'''flReflectionsDelay:''' Delay time of the first reflection relative to the direct path, in seconds, in the range from 0 to 0.3. The default value is 0.007 seconds.
*'''lReverb:''' Attenuation of late reverberation relative to lRoom, in mB, in the range from -10000 to 2000. The default value is 200 mB.
*'''flReverbDelay:''' Time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds, in the range from 0 to 0.1. The default value is 0.011 seconds.
*'''flDiffusion:''' Echo density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent.
*'''flDensity:''' Modal density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent.
*'''flHFReference:''' Reference high frequency, in hertz, in the range from 20 to 20000. The default value is 5000.0 Hz.

[[Category:Clientside API]]

Player::setVoiceFxGargle

2022-10-17T17:49:05Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxGargle(fxHandle, { dwRateHz, dwWaveShape }); </pre> ===Required Arguments=== *'''fxHandle:''' The effect handle. *'''dwRateHz:''' R..."

==Syntax==
<pre>
player.setVoiceFxGargle(fxHandle, {
dwRateHz,
dwWaveShape
});
</pre>

===Required Arguments===
*'''fxHandle:''' The effect handle.
*'''dwRateHz:''' Rate of modulation, in Hertz. Must be in the range from 1 through 1000. Default 500 Hz.
*'''dwWaveShape:''' Shape of the modulation wave... 0 = triangle, 1 = square (default).

[[Category:Clientside API]]

Player::setVoiceFxFlanger

2022-10-17T17:48:00Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxFlanger(fxHandle, { fWetDryMix, fDepth, fFeedback, fFrequency, lWaveform, fDelay, lPhase }); </pre> ===Required..."

Player::setVoiceFxEcho

2022-10-17T17:44:18Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxEcho(fxHandle, { fWetDryMix, fFeedback, fLeftDelay, fRightDelay, lPanDelay }); </pre> ===Required Arguments=== *'''fxHa..."

==Syntax==
<pre>
player.setVoiceFxEcho(fxHandle, {
fWetDryMix,
fFeedback,
fLeftDelay,
fRightDelay,
lPanDelay
});
</pre>

===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).
*'''fFeedback:''' Percentage of output fed back into input, in the range from 0 through 100. The default value is 0.
*'''fLeftDelay:''' Delay for left channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
*'''fRightDelay:''' Delay for right channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
*'''lPanDelay:''' Value that specifies whether to swap left and right delays with each successive echo. The default value is false, meaning no swap.

[[Category:Clientside API]]

Player::setVoiceFxDistortion

2022-10-17T17:42:11Z

Ufteers: Created page with "==Syntax== <pre> player.setVoiceFxDistortion(fxHandle, { fGain, fEdge, fPostEQCenterFrequency, fPostEQBandwidth, fPreLowpassCutoff }); </pre> ===Required..."

==Syntax==
<pre>
player.setVoiceFxDistortion(fxHandle, {
fGain,
fEdge,
fPostEQCenterFrequency,
fPostEQBandwidth,
fPreLowpassCutoff
});
</pre>

===Required Arguments===
*'''fxHandle:''' The effect handle.
*'''fGain:''' 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.
*'''fPostEQCenterFrequency:''' 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.
*'''fPreLowpassCutoff:''' Filter cutoff for high-frequency harmonics attenuation, in the range from 100 through 8000. The default value is 4000 Hz.

[[Category:Clientside API]]

Template:Player::setVoiceFxChorus

2022-10-17T17:38:57Z

Ufteers: Ufteers moved page Template:Player::setVoiceFxChorus to Player::setVoiceFxCompressor

#REDIRECT [[Player::setVoiceFxCompressor]]