class_audioeffectlimiter.rst 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioEffectLimiter.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioEffectLimiter:
  6. AudioEffectLimiter
  7. ==================
  8. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Adds a soft clip Limiter audio effect to an Audio bus.
  13. Properties
  14. ----------
  15. +---------------------------+---------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`ceiling_db<class_AudioEffectLimiter_property_ceiling_db>` |
  17. +---------------------------+---------------------------------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`soft_clip_db<class_AudioEffectLimiter_property_soft_clip_db>` |
  19. +---------------------------+---------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`soft_clip_ratio<class_AudioEffectLimiter_property_soft_clip_ratio>` |
  21. +---------------------------+---------------------------------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`threshold_db<class_AudioEffectLimiter_property_threshold_db>` |
  23. +---------------------------+---------------------------------------------------------------------------+
  24. Description
  25. -----------
  26. 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.
  27. 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.
  28. Property Descriptions
  29. ---------------------
  30. .. _class_AudioEffectLimiter_property_ceiling_db:
  31. - :ref:`float<class_float>` **ceiling_db**
  32. +----------+-----------------------+
  33. | *Setter* | set_ceiling_db(value) |
  34. +----------+-----------------------+
  35. | *Getter* | get_ceiling_db() |
  36. +----------+-----------------------+
  37. The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``.
  38. ----
  39. .. _class_AudioEffectLimiter_property_soft_clip_db:
  40. - :ref:`float<class_float>` **soft_clip_db**
  41. +----------+-------------------------+
  42. | *Setter* | set_soft_clip_db(value) |
  43. +----------+-------------------------+
  44. | *Getter* | get_soft_clip_db() |
  45. +----------+-------------------------+
  46. Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``.
  47. ----
  48. .. _class_AudioEffectLimiter_property_soft_clip_ratio:
  49. - :ref:`float<class_float>` **soft_clip_ratio**
  50. +----------+----------------------------+
  51. | *Setter* | set_soft_clip_ratio(value) |
  52. +----------+----------------------------+
  53. | *Getter* | get_soft_clip_ratio() |
  54. +----------+----------------------------+
  55. ----
  56. .. _class_AudioEffectLimiter_property_threshold_db:
  57. - :ref:`float<class_float>` **threshold_db**
  58. +----------+-------------------------+
  59. | *Setter* | set_threshold_db(value) |
  60. +----------+-------------------------+
  61. | *Getter* | get_threshold_db() |
  62. +----------+-------------------------+
  63. Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: ``0dB``.