virtualx-engine/doc/classes/AudioEffectPanner.xml
Rémi Verschelde 967bfb0c4a doc: Remove revision.module_config from version string
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00

36 lines
946 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPanner" inherits="AudioEffect" category="Core" version="3.0-alpha">
<brief_description>
Adds a Panner audio effect to an Audio bus. Pans sound left or right.
</brief_description>
<description>
Determines how much of an audio signal is sent to the left and right buses.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_pan" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_pan">
<return type="void">
</return>
<argument index="0" name="cpanume" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="pan" type="float" setter="set_pan" getter="get_pan">
Pan position. Value can range from -1 (fully left) to 1 (fully right).
</member>
</members>
<constants>
</constants>
</class>