From 8c19cc7b3da43d143f4316e1b7de2c7c2a35b328 Mon Sep 17 00:00:00 2001 From: Jerome67000 Date: Sat, 16 Sep 2017 18:47:19 +0200 Subject: [PATCH] [DOCS] Adds AudioEffects doc --- doc/classes/AudioEffectAmplify.xml | 9 ++++----- doc/classes/AudioEffectCompressor.xml | 15 +++++++++++++++ doc/classes/AudioEffectDelay.xml | 16 ++++++++++++++++ doc/classes/AudioEffectDistortion.xml | 13 +++++++++++++ doc/classes/AudioEffectEQ.xml | 6 ++++++ doc/classes/AudioEffectEQ10.xml | 15 +++++++++++++++ doc/classes/AudioEffectEQ21.xml | 26 ++++++++++++++++++++++++++ doc/classes/AudioEffectEQ6.xml | 11 +++++++++++ doc/classes/AudioEffectLimiter.xml | 6 ++++++ doc/classes/AudioEffectPanner.xml | 3 +++ doc/classes/AudioEffectPhaser.xml | 8 ++++++++ doc/classes/AudioEffectPitchShift.xml | 4 ++++ doc/classes/AudioEffectReverb.xml | 11 +++++++++++ 13 files changed, 138 insertions(+), 5 deletions(-) diff --git a/doc/classes/AudioEffectAmplify.xml b/doc/classes/AudioEffectAmplify.xml index 8497042b532..35d79918336 100644 --- a/doc/classes/AudioEffectAmplify.xml +++ b/doc/classes/AudioEffectAmplify.xml @@ -1,10 +1,11 @@ - Amplifies the volume of an audio source. + Adds a Amplify audio effect to an Audio bus. + Increases or decreases the volume of the selected audio bus. - Amplifies the volume of an audio source. Increase gain of the audio being routed through the bus. + Increases or decreases the volume being routed through the audio bus. @@ -15,7 +16,6 @@ - Returns the set maximum volume. @@ -24,13 +24,12 @@ - Sets the maximum volume. - The effect's volume limit. + Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: [code]0[/code]. diff --git a/doc/classes/AudioEffectCompressor.xml b/doc/classes/AudioEffectCompressor.xml index 5a7a91ede03..9d7e25dbf2a 100644 --- a/doc/classes/AudioEffectCompressor.xml +++ b/doc/classes/AudioEffectCompressor.xml @@ -1,8 +1,16 @@ + Adds a Compressor audio effect to an Audio bus. + Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume. + Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB). + Compressor has many uses in the mix: + - In the Master bus to compress the whole output (Although a [AudioEffectLimiter] is probably better) + - In voice channels to ensure they sound as balanced as possible. + - Sidechained. Sidechained, which can reduce the sound level sidechained with another audio bus for threshold detection.. This technique is very common in video game mixing to download the level of Music/SFX while voices are being heard. + - Accentuates transients by using a wider attack, making effects sound more punchy. @@ -110,18 +118,25 @@ + Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: [code]20ms[/code]. + Gain applied to the output signal. + Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: [code]1[/code]. + Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: [code]4[/code]. + Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: [code]250ms[/code]. + Reduce the sound level using another audio bus for threshold detection. + The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: [code]0[/code]. diff --git a/doc/classes/AudioEffectDelay.xml b/doc/classes/AudioEffectDelay.xml index 8d317b3c46a..9dc61883ab6 100644 --- a/doc/classes/AudioEffectDelay.xml +++ b/doc/classes/AudioEffectDelay.xml @@ -1,8 +1,11 @@ + Adds a Delay audio effect to an Audio bus. Plays input signal back after a period of time. + Two tap delay and feedback options. + Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds. @@ -194,30 +197,43 @@ + Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: [code]1[/code]. + If [code]true[/code] feedback is enabled. Default value: [code]false[/code]. + Feedback delay time in milliseconds. Default value: [code]340[/code]. + Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code]. + Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: [code]16000[/code]. + If [code]true[/code], [code]tap1[/code] will be enabled. Default value: [code]true[/code]. + [b]Tap1[/b] delay time in milliseconds. Default value: [code]250ms[/code]. + Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code]. + Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right). Default value: [code]0.2[/code]. + If [code]true[/code], [code]tap2[/code] will be enabled. Default value: [code]true[/code]. + [b]Tap2[/b] delay time in milliseconds. Default value: [code]500ms[/code]. + Sound level for [code]tap2[/code]. Default value: [code]-12 dB[/code]. + Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right). Default value: [code]-0.4[/code]. diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml index e5c5a3b50e1..1a6aa1d2b64 100644 --- a/doc/classes/AudioEffectDistortion.xml +++ b/doc/classes/AudioEffectDistortion.xml @@ -1,8 +1,12 @@ + Adds a Distortion audio effect to an Audio bus. + Modify the sound to make it dirty. + Modify the sound and make it dirty. Differents types available : clip, tan, lofi (bit crushing), overdrive, or waveshape. + By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently. @@ -82,26 +86,35 @@ + Distortion power. Value can range from 0 to 1. Default value: [code]0[/code]. + High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: [code]16000[/code]. + Distortion type. Default value: [code]MODE_CLIP[/code]. + Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: [code]0[/code]. + Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: [code]0[/code]. + Digital distortion effect which cuts off peaks at the top and bottom of the waveform. + Low-resolution digital distortion effect. You can use it to emulate the sound of early digital audio devices. + Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. + Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound. diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml index 94d5c696c3e..246f6b882e3 100644 --- a/doc/classes/AudioEffectEQ.xml +++ b/doc/classes/AudioEffectEQ.xml @@ -1,8 +1,11 @@ + Base class for audio equalizers. Gives you control over frequencies. + Use it to create a custom equalizer if [AudioEffectEQ6], [AudioEffectEQ10] or [AudioEffectEQ21] don't fit your needs. + AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQ are very useful on the Master Bus to completely master a mix and give it character. They are also very useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged). @@ -13,6 +16,7 @@ + Returns the number of bands of the equalizer. @@ -21,6 +25,7 @@ + Returns the band's gain at the specified index, in dB. @@ -31,6 +36,7 @@ + Sets band's gain at the specified index, in dB. diff --git a/doc/classes/AudioEffectEQ10.xml b/doc/classes/AudioEffectEQ10.xml index 004236dfdee..7a29f4cc0ba 100644 --- a/doc/classes/AudioEffectEQ10.xml +++ b/doc/classes/AudioEffectEQ10.xml @@ -1,8 +1,23 @@ + Adds a 10-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 31 Hz to 16000 Hz. + Each frequency can be modulated between -60/+24 dB. + Frequency bands : + Band 1 : 31 Hz + Band 2 : 62 Hz + Band 3 : 125 Hz + Band 4 : 250 Hz + Band 5 : 500 Hz + Band 6 : 1000 Hz + Band 7 : 2000 Hz + Band 8 : 4000 Hz + Band 9 : 8000 Hz + Band 10 : 16000 Hz + + See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ21]. diff --git a/doc/classes/AudioEffectEQ21.xml b/doc/classes/AudioEffectEQ21.xml index e4faa9bb0c6..327f5a291ae 100644 --- a/doc/classes/AudioEffectEQ21.xml +++ b/doc/classes/AudioEffectEQ21.xml @@ -1,8 +1,34 @@ + Adds a 21-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 22 Hz to 22000 Hz. + Each frequency can be modulated between -60/+24 dB. + Frequency bands : + Band 1 : 22 Hz + Band 2 : 32 Hz + Band 3 : 44 Hz + Band 4 : 63 Hz + Band 5 : 90 Hz + Band 6 : 125 Hz + Band 7 : 175 Hz + Band 8 : 250 Hz + Band 9 : 350 Hz + Band 10 : 500 Hz + Band 11 : 700 Hz + Band 12 : 1000 Hz + Band 13 : 1400 Hz + Band 14 : 2000 Hz + Band 15 : 2800 Hz + Band 16 : 4000 Hz + Band 17 : 5600 Hz + Band 18 : 8000 Hz + Band 19 : 11000 Hz + Band 20 : 16000 Hz + Band 21 : 22000 Hz + + See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ10]. diff --git a/doc/classes/AudioEffectEQ6.xml b/doc/classes/AudioEffectEQ6.xml index b74cc5d285d..bc05535041c 100644 --- a/doc/classes/AudioEffectEQ6.xml +++ b/doc/classes/AudioEffectEQ6.xml @@ -1,8 +1,19 @@ + Adds a 6-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 32 Hz to 10000 Hz. + Each frequency can be modulated between -60/+24 dB. + Frequency bands : + Band 1 : 32 Hz + Band 2 : 100 Hz + Band 3 : 320 Hz + Band 4 : 1000 Hz + Band 5 : 3200 Hz + Band 6 : 10000 Hz + + See also [AudioEffectEQ], [AudioEffectEQ10], [AudioEffectEQ21]. diff --git a/doc/classes/AudioEffectLimiter.xml b/doc/classes/AudioEffectLimiter.xml index e52fb57c708..5209f290b13 100644 --- a/doc/classes/AudioEffectLimiter.xml +++ b/doc/classes/AudioEffectLimiter.xml @@ -1,8 +1,11 @@ + Adds a soft clip Limiter audio effect to an Audio bus. + A limiter is similar to a compressor, but it’s less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master Bus is always recommended to reduce the effects of clipping. + Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded. @@ -68,12 +71,15 @@ + The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: [code]-0.1dB[/code]. + Applies a gain to the limited waves. Value can range from 0 to 6. Default value: [code]2dB[/code]. + Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: [code]0dB[/code]. diff --git a/doc/classes/AudioEffectPanner.xml b/doc/classes/AudioEffectPanner.xml index b55d7f91c1a..56b39a36c60 100644 --- a/doc/classes/AudioEffectPanner.xml +++ b/doc/classes/AudioEffectPanner.xml @@ -1,8 +1,10 @@ + Adds a Panner audio effect to an Audio bus. Pans sound left or right. + Determines how much of an audio signal is sent to the left and right buses. @@ -26,6 +28,7 @@ + Pan position. Value can range from -1 (fully left) to 1 (fully right). diff --git a/doc/classes/AudioEffectPhaser.xml b/doc/classes/AudioEffectPhaser.xml index 7e9cd27a471..bd9067471ba 100644 --- a/doc/classes/AudioEffectPhaser.xml +++ b/doc/classes/AudioEffectPhaser.xml @@ -1,8 +1,11 @@ + Adds a Phaser audio effect to an Audio bus. + Combines the original signal with a copy that is slightly out of phase with the original. + Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low Frequency Oscillator. @@ -82,14 +85,19 @@ + Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: [code]1[/code]. + Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: [code]0.7[/code]. + Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: [code]1600hz[/code]. + Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: [code]440hz[/code]. + Adjusts the rate at which the effect sweeps up and down across the frequency range. diff --git a/doc/classes/AudioEffectPitchShift.xml b/doc/classes/AudioEffectPitchShift.xml index 6fc3acdc203..edcb54e09ee 100644 --- a/doc/classes/AudioEffectPitchShift.xml +++ b/doc/classes/AudioEffectPitchShift.xml @@ -1,8 +1,11 @@ + Adds a Pitch shift audio effect to an Audio bus. + Raises or lowers the pitch of original sound. + Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients. @@ -26,6 +29,7 @@ + Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves). diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml index b390fa239ce..4cda24530ba 100644 --- a/doc/classes/AudioEffectReverb.xml +++ b/doc/classes/AudioEffectReverb.xml @@ -1,8 +1,11 @@ + Adds a Reverb audio effect to an Audio bus. + Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces. + Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room. @@ -124,20 +127,28 @@ + Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: [code]1[/code]. + Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: [code]1[/code]. + High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: [code]0[/code]. + Output percent of predelay. Value can range from 0 to 1. Default value: [code]1[/code]. + Time between the original signal and the early reflections of the reverb signal. Default value: [code]150ms[/code]. + Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: [code]0.8[/code]. + Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: [code]1[/code]. + Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: [code]0.5[/code].