stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 18:29:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-07-02 14:03:23 +02:00
parent 5402f28f59
commit a203daa272
397 changed files with 21934 additions and 16529 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_audioeffectcompressor.rst
+69 -55
View File
@@ -21,21 +21,21 @@ Reduces sounds that exceed a certain threshold level, smooths out the dynamics a
Properties
----------
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`attack_us<class_AudioEffectCompressor_property_attack_us>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectCompressor_property_gain>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`mix<class_AudioEffectCompressor_property_mix>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ratio<class_AudioEffectCompressor_property_ratio>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`release_ms<class_AudioEffectCompressor_property_release_ms>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`sidechain<class_AudioEffectCompressor_property_sidechain>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`threshold<class_AudioEffectCompressor_property_threshold>` |
+-----------------------------+--------------------------------------------------------------------+
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`attack_us<class_AudioEffectCompressor_property_attack_us>` | 20.0 |
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectCompressor_property_gain>` | 0.0 |
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`mix<class_AudioEffectCompressor_property_mix>` | 1.0 |
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`ratio<class_AudioEffectCompressor_property_ratio>` | 4.0 |
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`release_ms<class_AudioEffectCompressor_property_release_ms>` | 250.0 |
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`String<class_String>` | :ref:`sidechain<class_AudioEffectCompressor_property_sidechain>` | "" |
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`threshold<class_AudioEffectCompressor_property_threshold>` | 0.0 |
+-----------------------------+--------------------------------------------------------------------+-------+
Description
-----------
@@ -59,23 +59,27 @@ Property Descriptions
- :ref:`float<class_float>` **attack_us**
+----------+----------------------+
| *Setter* | set_attack_us(value) |
+----------+----------------------+
| *Getter* | get_attack_us() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 20.0 |
+-----------+----------------------+
| *Setter* | set_attack_us(value) |
+-----------+----------------------+
| *Getter* | get_attack_us() |
+-----------+----------------------+
Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000. Default value: ``20us``.
Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000.
.. _class_AudioEffectCompressor_property_gain:
- :ref:`float<class_float>` **gain**
+----------+-----------------+
| *Setter* | set_gain(value) |
+----------+-----------------+
| *Getter* | get_gain() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | 0.0 |
+-----------+-----------------+
| *Setter* | set_gain(value) |
+-----------+-----------------+
| *Getter* | get_gain() |
+-----------+-----------------+
Gain applied to the output signal.
@@ -83,47 +87,55 @@ Gain applied to the output signal.
- :ref:`float<class_float>` **mix**
+----------+----------------+
| *Setter* | set_mix(value) |
+----------+----------------+
| *Getter* | get_mix() |
+----------+----------------+
+-----------+----------------+
| *Default* | 1.0 |
+-----------+----------------+
| *Setter* | set_mix(value) |
+-----------+----------------+
| *Getter* | get_mix() |
+-----------+----------------+
Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``.
Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet).
.. _class_AudioEffectCompressor_property_ratio:
- :ref:`float<class_float>` **ratio**
+----------+------------------+
| *Setter* | set_ratio(value) |
+----------+------------------+
| *Getter* | get_ratio() |
+----------+------------------+
+-----------+------------------+
| *Default* | 4.0 |
+-----------+------------------+
| *Setter* | set_ratio(value) |
+-----------+------------------+
| *Getter* | get_ratio() |
+-----------+------------------+
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: ``4``.
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.
.. _class_AudioEffectCompressor_property_release_ms:
- :ref:`float<class_float>` **release_ms**
+----------+-----------------------+
| *Setter* | set_release_ms(value) |
+----------+-----------------------+
| *Getter* | get_release_ms() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 250.0 |
+-----------+-----------------------+
| *Setter* | set_release_ms(value) |
+-----------+-----------------------+
| *Getter* | get_release_ms() |
+-----------+-----------------------+
Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000. Default value: ``250ms``.
Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000.
.. _class_AudioEffectCompressor_property_sidechain:
- :ref:`String<class_String>` **sidechain**
+----------+----------------------+
| *Setter* | set_sidechain(value) |
+----------+----------------------+
| *Getter* | get_sidechain() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | "" |
+-----------+----------------------+
| *Setter* | set_sidechain(value) |
+-----------+----------------------+
| *Getter* | get_sidechain() |
+-----------+----------------------+
Reduce the sound level using another audio bus for threshold detection.
@@ -131,11 +143,13 @@ Reduce the sound level using another audio bus for threshold detection.
- :ref:`float<class_float>` **threshold**
+----------+----------------------+
| *Setter* | set_threshold(value) |
+----------+----------------------+
| *Getter* | get_threshold() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.0 |
+-----------+----------------------+
| *Setter* | set_threshold(value) |
+-----------+----------------------+
| *Getter* | get_threshold() |
+-----------+----------------------+
The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: ``0``.
The level above which compression is applied to the audio. Value can range from -60 to 0.