Differences

This shows you the differences between two versions of the page.

--- en:orx:config:settings_structure:orxsound [2023/07/10 00:32 (2 years ago)] – Pitch correction (lol) sausage
+++ en:orx:config:settings_structure:orxsound [2025/09/30 17:26 (12 days ago)] (current) – external edit 127.0.0.1
@@ Line 3: / Line 3: @@
 ==== Summary ====
-<code ini>[SoundTemplate]
+<code ini>
+[SoundTemplate]
 Sound        = path/to/SoundFile
 Music        = path/to/MusicFile
@@ Line 19: / Line 20: @@
 </code>
+=== BiquadFilter ===
+<code ini>
+[BiquadFilter]
+Type           = biquad
+UseCustomParam = <bool>
+A0             = <float>
+A1             = <float>
+A2             = <float>
+B0             = <float>
+B1             = <float>
+B2             = <float>
+</code>
+=== LowPassFilter===
+<code ini>
+[LowPassFilter]
+Type           = lowpass
+UseCustomParam = <bool>
+Frequency      = <float>
+Order          = <int>
+</code>
+=== HighPassFilter ===
+<code ini>
+[HighPassFilter]
+Type           = highpass
+UseCustomParam = <bool>
+Frequency      = <float>
+Order          = <int>
+</code>
+=== BandPassFilter ===
+<code ini>
+[BandPassFilter]
+Type           = bandpass
+UseCustomParam = <bool>
+Frequency      = <float>
+Order          = <int>
+</code>
+=== LowShelfFilter ===
+<code ini>
+[LowShelfFilter]
+Type           = lowshelf
+UseCustomParam = <bool>
+Frequency      = <float>
+Q              = <float>
+Gain           = <float>
+</code>
+=== HighShelfFilter ===
+<code ini>
+[HighShelfFilter]
+Type           = highshelf
+UseCustomParam = <bool>
+Frequency      = <float>
+Q              = <float>
+Gain           = <float>
+</code>
+=== NotchFilter ===
+<code ini>
+[NotchFilter]
+Type           = notch
+UseCustomParam = <bool>
+Frequency      = <float>
+Q              = <float>
+</code>
+=== PeakingFilter ===
+<code ini>
+[PeakingFilter]
+Type           = peaking
+UseCustomParam = <bool>
+Frequency      = <float>
+Q              = <float>
+Gain           = <float>
+</code>
+=== DelayFilter ===
+<code ini>
+[DelayFilter]
+Type           = delay
+UseCustomParam = <bool>
+Delay          = <float>
+Decay          = <float>
+</code>
@@ Line 39: / Line 139: @@
 **NB: Spatialized sounds can be performed on either mono or stereo sounds. There is no longer any restriction on sample types.**
+=== BiquadFilter ===
+  * ''UseCustomParam'': When set to true, an event will be sent to override params values at runtime. Defaults to false, ie. no runtime override.
+=== LowPassFilter ===
+  * ''UseCustomParam'': When set to true, an event will be sent to override params values at runtime. Defaults to false, ie. no runtime override.
+  * ''Frequency'': Cutoff frequency.
+  * ''Order'': Should be between 1 and 8. Cannot be overridden at runtime with UseCustomParam. Defaults to 2.
+=== HighPassFilter ===
+  * ''UseCustomParam'': When set to true, an event will be sent to override params values at runtime. Defaults to false, ie. no runtime override.
+  * ''Frequency'': Cutoff frequency.
+  * ''Order'': Should be between 1 and 8. Cannot be overridden at runtime with UseCustomParam. Defaults to 2.
+=== BandPassFilter ===
+  * ''UseCustomParam'': When set to true, an event will be sent to override params values at runtime. Defaults to false, ie. no runtime override.
+  * ''Frequency'': Cutoff frequency.
+  * ''Order'': Should be between 2 and 8. Cannot be overridden at runtime with UseCustomParam. Defaults to 2.
+=== LowShelfFilter ===
+  * ''UseCustomParam'': When set to true, an event will be sent to override params values at runtime. Defaults to false, ie. no runtime override.
+  * ''Frequency'': Center frequency.
+  * ''Q'': Defines the filter's slope in ]0.0-1.0], the higher, the steeper. Defaults to ~0.707107 (1/sqrt(2.0)).
+  * ''Gain'': In dB. Positive for amplification, negative for damping. Defaults to 0 (no change).
+=== HighShelfFilter ===
+  * ''UseCustomParam'': When set to true, an event will be sent to override params values at runtime. Defaults to false, ie. no runtime override.
+  * ''Frequency'': Center frequency.
+  * ''Q'': Defines the filter's slope in ]0.0-1.0], the higher, the steeper. Defaults to ~0.707107 (1/sqrt(2.0)).
+  * ''Gain'': In dB. Positive for amplification, negative for damping. Defaults to 0 (no change).
+=== NotchFilter ===
+  * ''UseCustomParam'': When set to true, an event will be sent to override params values at runtime. Defaults to false, ie. no runtime override.
+  * ''Frequency'': Center frequency.
+  * ''Q'': Defines the filter's slope in ]0.0-1.0], the higher, the steeper. Defaults to ~0.707107 (1/sqrt(2.0)).
+=== PeakingFilter ===
+  * ''UseCustomParam'': When set to true, an event will be sent to override params values at runtime. Defaults to false, ie. no runtime override.
+  * ''Frequency'': Center frequency.
+  * ''Q'': Defines the filter's slope in ]0.0-1.0], the higher, the steeper. Defaults to ~0.707107 (1/sqrt(2.0)).
+  * ''Gain'': In dB. Positive for amplification, negative for damping. Defaults to 0 (no change).
+=== DelayFilter ===
+  * ''UseCustomParam'': When set to true, an event will be sent to override params values at runtime. Defaults to false, ie. no runtime override.
+  * ''Delay'': In seconds. Cannot be overridden at runtime with UseCustomParam. Should be > 0.0.
+  * ''Decay'': Amount of the "repeat" part, in [0.0-1.0]. 0.0 to deactivate the echo entirely and only introduce delay. Defaults to 0.0.
 ==== Latest config settings for the Development Version ====
 {{section>en:orx:config:developmentversion#&noheader&nofooter&noeditbutton}}

Orx Learning

User Tools

Site Tools

Differences

Page Tools