Cleanup audio effect class reference pages

This commit is contained in:
skyace65 2022-06-19 19:11:11 -04:00
parent f58ff85f8f
commit c2b5464659
22 changed files with 31 additions and 11 deletions

View file

@ -2,12 +2,12 @@
<class name="AudioEffectAmplify" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectAmplify" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds an amplifying audio effect to an audio bus. Adds an amplifying audio effect to an audio bus.
Increases or decreases the volume of the selected audio bus.
</brief_description> </brief_description>
<description> <description>
Increases or decreases the volume being routed through the audio bus. Increases or decreases the volume being routed through the audio bus.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0"> <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">

View file

@ -7,5 +7,6 @@
Limits the frequencies in a range around the [member AudioEffectFilter.cutoff_hz] and allows frequencies outside of this range to pass. Limits the frequencies in a range around the [member AudioEffectFilter.cutoff_hz] and allows frequencies outside of this range to pass.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
</class> </class>

View file

@ -7,5 +7,6 @@
Attenuates the frequencies inside of a range around the [member AudioEffectFilter.cutoff_hz] and cuts frequencies outside of this band. Attenuates the frequencies inside of a range around the [member AudioEffectFilter.cutoff_hz] and cuts frequencies outside of this band.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
</class> </class>

View file

@ -8,6 +8,7 @@
Application code should consume these audio frames from this ring buffer using [method get_buffer] and process it as needed, for example to capture data from a microphone, implement application defined effects, or to transmit audio over the network. When capturing audio data from a microphone, the format of the samples will be stereo 32-bit floating point PCM. Application code should consume these audio frames from this ring buffer using [method get_buffer] and process it as needed, for example to capture data from a microphone, implement application defined effects, or to transmit audio over the network. When capturing audio data from a microphone, the format of the samples will be stereo 32-bit floating point PCM.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<methods> <methods>
<method name="can_get_buffer" qualifiers="const"> <method name="can_get_buffer" qualifiers="const">

View file

@ -7,6 +7,7 @@
Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter. Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_voice_cutoff_hz" qualifiers="const"> <method name="get_voice_cutoff_hz" qualifiers="const">

View file

@ -13,6 +13,7 @@
- Accentuates transients by using a wider attack, making effects sound more punchy. - Accentuates transients by using a wider attack, making effects sound more punchy.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="attack_us" type="float" setter="set_attack_us" getter="get_attack_us" default="20.0"> <member name="attack_us" type="float" setter="set_attack_us" getter="get_attack_us" default="20.0">

View file

@ -8,6 +8,7 @@
Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds. Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0"> <member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">

View file

@ -8,6 +8,7 @@
AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQs are useful on the Master bus to completely master a mix and give it more character. They are also useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged). AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQs are useful on the Master bus to completely master a mix and give it more character. They are also useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged).
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_band_count" qualifiers="const"> <method name="get_band_count" qualifiers="const">

View file

@ -19,5 +19,6 @@
See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ21]. See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ21].
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
</class> </class>

View file

@ -30,5 +30,6 @@
See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ10]. See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ10].
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
</class> </class>

View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectEQ6" inherits="AudioEffectEQ" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectEQ6" inherits="AudioEffectEQ" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a 6-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 32 Hz to 10000 Hz. Adds a 6-band equalizer audio effect to an audio bus. Gives you control over frequencies from 32 Hz to 10000 Hz.
Each frequency can be modulated between -60/+24 dB. Each frequency can be modulated between -60/+24 dB.
</brief_description> </brief_description>
<description> <description>
@ -15,5 +15,6 @@
See also [AudioEffectEQ], [AudioEffectEQ10], [AudioEffectEQ21]. See also [AudioEffectEQ], [AudioEffectEQ10], [AudioEffectEQ21].
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
</class> </class>

View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a high-pass filter to the Audio Bus. Adds a high-pass filter to the audio bus.
</brief_description> </brief_description>
<description> <description>
Cuts frequencies lower than the [member AudioEffectFilter.cutoff_hz] and allows higher frequencies to pass. Cuts frequencies lower than the [member AudioEffectFilter.cutoff_hz] and allows higher frequencies to pass.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
</class> </class>

View file

@ -1,9 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Reduces all frequencies above the [member AudioEffectFilter.cutoff_hz]. Adds a high-shelf filter to the audio bus.
</brief_description> </brief_description>
<description> <description>
Reduces all frequencies above the [member AudioEffectFilter.cutoff_hz].
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link> <link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>

View file

@ -8,6 +8,7 @@
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. 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.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="ceiling_db" type="float" setter="set_ceiling_db" getter="get_ceiling_db" default="-0.1"> <member name="ceiling_db" type="float" setter="set_ceiling_db" getter="get_ceiling_db" default="-0.1">

View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a low-pass filter to the Audio bus. Adds a low-pass filter to the audio bus.
</brief_description> </brief_description>
<description> <description>
Cuts frequencies higher than the [member AudioEffectFilter.cutoff_hz] and allows lower frequencies to pass. Cuts frequencies higher than the [member AudioEffectFilter.cutoff_hz] and allows lower frequencies to pass.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
</class> </class>

View file

@ -1,9 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Reduces all frequencies below the [member AudioEffectFilter.cutoff_hz]. Adds a low-shelf filter to the audio bus.
</brief_description> </brief_description>
<description> <description>
Reduces all frequencies below the [member AudioEffectFilter.cutoff_hz].
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link> <link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>

View file

@ -7,5 +7,6 @@
Attenuates frequencies in a narrow band around the [member AudioEffectFilter.cutoff_hz] and cuts frequencies outside of this range. Attenuates frequencies in a narrow band around the [member AudioEffectFilter.cutoff_hz] and cuts frequencies outside of this range.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
</class> </class>

View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPanner" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectPanner" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a panner audio effect to an Audio bus. Pans sound left or right. Adds a panner audio effect to an audio bus. Pans sound left or right.
</brief_description> </brief_description>
<description> <description>
Determines how much of an audio signal is sent to the left and right buses. Determines how much of an audio signal is sent to the left and right buses.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="pan" type="float" setter="set_pan" getter="get_pan" default="0.0"> <member name="pan" type="float" setter="set_pan" getter="get_pan" default="0.0">

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPhaser" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectPhaser" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a phaser audio effect to an Audio bus. Adds a phaser audio effect to an audio bus.
Combines the original signal with a copy that is slightly out of phase with the original. Combines the original signal with a copy that is slightly out of phase with the original.
</brief_description> </brief_description>
<description> <description>
Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a low-frequency oscillator. Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a low-frequency oscillator.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0"> <member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPitchShift" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectPitchShift" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a pitch-shifting audio effect to an Audio bus. Adds a pitch-shifting audio effect to an audio bus.
Raises or lowers the pitch of original sound. Raises or lowers the pitch of original sound.
</brief_description> </brief_description>
<description> <description>
Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients. Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="fft_size" type="int" setter="set_fft_size" getter="get_fft_size" enum="AudioEffectPitchShift.FFTSize" default="3"> <member name="fft_size" type="int" setter="set_fft_size" getter="get_fft_size" enum="AudioEffectPitchShift.FFTSize" default="3">

View file

@ -2,12 +2,12 @@
<class name="AudioEffectReverb" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AudioEffectReverb" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a reverberation audio effect to an Audio bus. Adds a reverberation audio effect to an Audio bus.
Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.
</brief_description> </brief_description>
<description> <description>
Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
</tutorials> </tutorials>
<members> <members>

View file

@ -7,6 +7,7 @@
An audio effect that can be used to adjust the intensity of stereo panning. An audio effect that can be used to adjust the intensity of stereo panning.
</description> </description>
<tutorials> <tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="pan_pullout" type="float" setter="set_pan_pullout" getter="get_pan_pullout" default="1.0"> <member name="pan_pullout" type="float" setter="set_pan_pullout" getter="get_pan_pullout" default="1.0">