:github_url: hide .. _class_AudioEffectCompressor: AudioEffectCompressor ===================== **Hérite de :** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Ajoute un effet de compresseur audio à un bus audio. Réduit les sons qui dépassent un certain seuil, lisse les dynamiques et augmente le volume global. .. rst-class:: classref-introduction-group Description ----------- Le compresseur dynamique d'intensité réduit le niveau du son lorsque le volume dépasse un certain seuil de décibels. L'une des principales utilisations d'un compresseur est d'augmenter la gamme dynamique en essayant de saturer le moins possible le son (quand le son dépasse 0dB). Le compresseur a de nombreuses utilisations dans le mixage : - Dans le bus Maître pour compresser toute la sortie (même si un :ref:`AudioEffectHardLimiter` est souvent plus adapté). - Dans les canaux de voix pour s'assurer qu'ils sonnent aussi équilibré que possible. - Pour le "Sidechained". Cela peut réduire le niveau de son enchaîné avec un autre bus audio pour la détection des seuils. Cette technique est courante dans le jeu vidéo pour mixer le niveau de la musique et les effets spéciaux tandis que les voix sont entendues. - Accentue les transitions en utilisant une attaque plus grande, rendant les effets sonores plus percutants. .. rst-class:: classref-introduction-group Tutoriels ------------------ - :doc:`Bus audio <../tutorials/audio/audio_buses>` .. rst-class:: classref-reftable-group Propriétés -------------------- .. table:: :widths: auto +-------------------------------------+--------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`attack_us` | ``20.0`` | +-------------------------------------+--------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`gain` | ``0.0`` | +-------------------------------------+--------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`mix` | ``1.0`` | +-------------------------------------+--------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`ratio` | ``4.0`` | +-------------------------------------+--------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`release_ms` | ``250.0`` | +-------------------------------------+--------------------------------------------------------------------+-----------+ | :ref:`StringName` | :ref:`sidechain` | ``&""`` | +-------------------------------------+--------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`threshold` | ``0.0`` | +-------------------------------------+--------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Descriptions des propriétés ------------------------------------------------------ .. _class_AudioEffectCompressor_property_attack_us: .. rst-class:: classref-property :ref:`float` **attack_us** = ``20.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_attack_us**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_attack_us**\ (\ ) Temps de réaction du compresseur quand le signal dépasse le seuil, en microsecondes. La valeur peut aller de 20 à 2000. .. rst-class:: classref-item-separator ---- .. _class_AudioEffectCompressor_property_gain: .. rst-class:: classref-property :ref:`float` **gain** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_gain**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_gain**\ (\ ) Gain appliqué au signal de sortie. .. rst-class:: classref-item-separator ---- .. _class_AudioEffectCompressor_property_mix: .. rst-class:: classref-property :ref:`float` **mix** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_mix**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_mix**\ (\ ) Équilibre entre le signal original et le signal avec effet. La valeur peut aller de 0 (totalement dry) à 1 (totalement wet). .. rst-class:: classref-item-separator ---- .. _class_AudioEffectCompressor_property_ratio: .. rst-class:: classref-property :ref:`float` **ratio** = ``4.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_ratio**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_ratio**\ (\ ) La quantité de compression appliquée à l'audio après avoir franchi le seuil. Plus le rapport est élevé, plus les parties hautes de l'audio seront comprimées. La valeur peut aller de 1 à 48. .. rst-class:: classref-item-separator ---- .. _class_AudioEffectCompressor_property_release_ms: .. rst-class:: classref-property :ref:`float` **release_ms** = ``250.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_release_ms**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_release_ms**\ (\ ) Le retard du compresseur avant d'arrêter de réduire le signal après que le niveau de signal sous le seuil, en millisecondes. La valeur peut aller de 20 à 2000. .. rst-class:: classref-item-separator ---- .. _class_AudioEffectCompressor_property_sidechain: .. rst-class:: classref-property :ref:`StringName` **sidechain** = ``&""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sidechain**\ (\ value\: :ref:`StringName`\ ) - :ref:`StringName` **get_sidechain**\ (\ ) Réduit le niveau sonore en utilisant un autre bus audio pour détecter les seuils. .. rst-class:: classref-item-separator ---- .. _class_AudioEffectCompressor_property_threshold: .. rst-class:: classref-property :ref:`float` **threshold** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_threshold**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_threshold**\ (\ ) Le niveau au-dessus duquel la compression est appliquée à l'audio. La valeur peut aller de -60 à 0. .. |virtual| replace:: :abbr:`virtual (Cette méthode doit typiquement être redéfinie par l'utilisateur pour avoir un effet.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (Cette méthode n'a pas d'effets de bord. Elle ne modifie aucune des variables membres de l'instance.)` .. |vararg| replace:: :abbr:`vararg (Cette méthode accepte n'importe quel nombre d'arguments après ceux décris ici.)` .. |constructor| replace:: :abbr:`constructor (Cette méthode est utilisée pour construire un type.)` .. |static| replace:: :abbr:`static (Cette méthode n'a pas besoin d'instance pour être appelée, elle peut donc être directement appelée en utilisant le nom de la classe.)` .. |operator| replace:: :abbr:`operator (Cette méthode décrit un opérateur valide à utiliser avec ce type en tant qu'opérande gauche.)` .. |bitfield| replace:: :abbr:`BitField (Cette valeur est un nombre entier composé d'un masque de bits des options suivantes.)` .. |void| replace:: :abbr:`void (Aucune valeur de retour.)`