| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| en:orx:config:settings_structure:orxsound [2023/07/06 08:00 (10 months ago)] – sausage | en:orx:config:settings_structure:orxsound [2023/09/20 00:01 (7 months ago)] (current) – sausage |
|---|
| ==== Summary ==== | ==== Summary ==== |
| |
| <code ini>[SoundTemplate] | <code ini> |
| | [SoundTemplate] |
| Sound = path/to/SoundFile | Sound = path/to/SoundFile |
| Music = path/to/MusicFile | Music = path/to/MusicFile |
| |
| </code> | </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> |
| | |
| |
| |
| * ''Bus'': Assign the sound/music to a named bus. If this is not specified, the default ''Master'' bus will be used. | * ''Bus'': Assign the sound/music to a named bus. If this is not specified, the default ''Master'' bus will be used. |
| * ''Loop'': Specifies if the sound should be played in loop. Its default value is ''false''. | * ''Loop'': Specifies if the sound should be played in loop. Its default value is ''false''. |
| * ''Pitch'': Defines a pitch value for the playing sound (ie. a relative frequency). Its default value is 1.0 which means the sound will be played at the same frequency it was recorded. | * ''Pitch'': Defines a pitch value for the playing sound (ie. a relative frequency). Its default value is 1.0 which means the sound will be played at the same frequency it was recorded. 2.0 will be a pitch twice as high, 0.5 is a pitch twice as low. 0.0 has no meaning and is ignored. |
| * ''Volume'': Specifies the relative volume to be used when playing the sound. It accepts a value between 0.0 and 1.0, default being 1.0. | * ''Volume'': Specifies the relative volume to be used when playing the sound. It accepts a value between 0.0 and 1.0, default being 1.0. |
| * ''Panning'': Panning control. -1.0 for full left & 1.0 for full right. Defaults to 0.0 (center). | * ''Panning'': Panning control. -1.0 for full left & 1.0 for full right. Defaults to 0.0 (center). |
| |
| **NB: Spatialized sounds can be performed on either mono or stereo sounds. There is no longer any restriction on sample types.** | **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 ==== | ==== Latest config settings for the Development Version ==== |
| {{section>en:orx:config:developmentversion#&noheader&nofooter&noeditbutton}} | {{section>en:orx:config:developmentversion#&noheader&nofooter&noeditbutton}} |
| |
