===== orxSOUND structure ===== ==== Summary ==== [SoundTemplate] Sound = path/to/SoundFile Music = path/to/MusicFile Bus = Loop = Pitch = Volume = Panning = Mix = DistanceList = (# ) GainList = (# ) RollOff = FilterList = FilterTemplate1 # ... # FilterTemplateN KeepInCache = === BiquadFilter === [BiquadFilter] Type = biquad UseCustomParam = A0 = A1 = A2 = B0 = B1 = B2 = === LowPassFilter=== [LowPassFilter] Type = lowpass UseCustomParam = Frequency = Order = === HighPassFilter === [HighPassFilter] Type = highpass UseCustomParam = Frequency = Order = === BandPassFilter === [BandPassFilter] Type = bandpass UseCustomParam = Frequency = Order = === LowShelfFilter === [LowShelfFilter] Type = lowshelf UseCustomParam = Frequency = Q = Gain = === HighShelfFilter === [HighShelfFilter] Type = highshelf UseCustomParam = Frequency = Q = Gain = === NotchFilter === [NotchFilter] Type = notch UseCustomParam = Frequency = Q = === PeakingFilter === [PeakingFilter] Type = peaking UseCustomParam = Frequency = Q = Gain = === DelayFilter === [DelayFilter] Type = delay UseCustomParam = Delay = Decay = ==== Details ==== Here's a list of the available properties for an ''orxSOUND'' structure: * ''Sound'': Specifies which sound file to use. The whole file will be loaded in memory before being played. This should be used for short sounds only (not for buffered streamed musics). * ''Music'': If no ''Sound'' is specified, this will be used as a path to a music file. Music differs from sounds mainly in the fact they're streamed from disk and buffered in memory at runtime to prevent having big files completely loaded in memory. * ''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''. * ''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. * ''Panning'': Panning control. -1.0 for full left & 1.0 for full right. Defaults to 0.0 (center). * ''Mix'': Defines the Panning mode. True for mixing channels based on their position and false to act like a regular balance; Defaults to false. * ''DistanceList'': Minimum (mandatory) and maximum (optional) distances for sound spatialization, in units. If any of them is negative, sound spatialization will be disabled for this sound. Defaults to -1.0 # FLT_MAX. * ''GainList'': Minimum (mandatory) and maximum (optional) gain, used to clamp computed gain during sound spatialization, if enabled with DistanceList. Should be within [0.0f - 1.0f]. Defaults to 0.0 # 1.0. * ''RollOff'': RollOff factor used to compute sound spatialization, if enabled with DistanceList. Defaults to 1.0. * ''FilterList'': Filters will be chained in their declaration order. * ''KeepInCache'': Specifies if the sound data (ie. the sample itself) should be kept in memory even when no sound of this type is used. This gives better performances (no disk access) but costs memory. Its default value is ''false''. **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}}