| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectStereoEnhance.xml.
- .. _class_AudioEffectStereoEnhance:
- AudioEffectStereoEnhance
- ========================
- **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- An audio effect that can be used to adjust the intensity of stereo panning.
- Description
- -----------
- An audio effect that can be used to adjust the intensity of stereo panning.
- Tutorials
- ---------
- - :doc:`Audio buses <../tutorials/audio/audio_buses>`
- Properties
- ----------
- +---------------------------+---------------------------------------------------------------------------------+---------+
- | :ref:`float<class_float>` | :ref:`pan_pullout<class_AudioEffectStereoEnhance_property_pan_pullout>` | ``1.0`` |
- +---------------------------+---------------------------------------------------------------------------------+---------+
- | :ref:`float<class_float>` | :ref:`surround<class_AudioEffectStereoEnhance_property_surround>` | ``0.0`` |
- +---------------------------+---------------------------------------------------------------------------------+---------+
- | :ref:`float<class_float>` | :ref:`time_pullout_ms<class_AudioEffectStereoEnhance_property_time_pullout_ms>` | ``0.0`` |
- +---------------------------+---------------------------------------------------------------------------------+---------+
- Property Descriptions
- ---------------------
- .. _class_AudioEffectStereoEnhance_property_pan_pullout:
- - :ref:`float<class_float>` **pan_pullout**
- +-----------+------------------------+
- | *Default* | ``1.0`` |
- +-----------+------------------------+
- | *Setter* | set_pan_pullout(value) |
- +-----------+------------------------+
- | *Getter* | get_pan_pullout() |
- +-----------+------------------------+
- Values greater than 1.0 increase intensity of any panning on audio passing through this effect, whereas values less than 1.0 will decrease the panning intensity. A value of 0.0 will downmix audio to mono.
- ----
- .. _class_AudioEffectStereoEnhance_property_surround:
- - :ref:`float<class_float>` **surround**
- +-----------+---------------------+
- | *Default* | ``0.0`` |
- +-----------+---------------------+
- | *Setter* | set_surround(value) |
- +-----------+---------------------+
- | *Getter* | get_surround() |
- +-----------+---------------------+
- ----
- .. _class_AudioEffectStereoEnhance_property_time_pullout_ms:
- - :ref:`float<class_float>` **time_pullout_ms**
- +-----------+-------------------------+
- | *Default* | ``0.0`` |
- +-----------+-------------------------+
- | *Setter* | set_time_pullout(value) |
- +-----------+-------------------------+
- | *Getter* | get_time_pullout() |
- +-----------+-------------------------+
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
