2 * Copyright (c) 2007-2010 SlimDX Group
\r
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
\r
5 * of this software and associated documentation files (the "Software"), to deal
\r
6 * in the Software without restriction, including without limitation the rights
\r
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
\r
8 * copies of the Software, and to permit persons to whom the Software is
\r
9 * furnished to do so, subject to the following conditions:
\r
11 * The above copyright notice and this permission notice shall be included in
\r
12 * all copies or substantial portions of the Software.
\r
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
\r
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
\r
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
\r
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
\r
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
\r
26 namespace DirectSound
\r
29 /// The SoundEffectCompressor object is used to set and retrieve effect parameters on a buffer that supports compression.
\r
31 /// <unmanaged>IDirectSoundFXCompressor</unmanaged>
\r
32 public ref class CompressorEffect : public ComObject
\r
34 COMOBJECT(IDirectSoundFXCompressor, CompressorEffect);
\r
38 /// Time before compression reaches its full value.
\r
40 property float Attack
\r
43 void set( float value );
\r
47 /// Output gain of signal after compression.
\r
52 void set( float value );
\r
56 /// Speed at which compression is stopped after input drops below Threshold.
\r
58 property float Release
\r
61 void set( float value );
\r
65 /// Time after Threshold is reached before attack phase is started, in milliseconds.
\r
67 property float PreDelay
\r
70 void set( float value );
\r
74 /// Compression ratio. The default value is 3, which means 3:1 compression.
\r
76 property float Ratio
\r
79 void set( float value );
\r
83 /// Point at which compression begins, in decibels.
\r
85 property float Threshold
\r
88 void set( float value );
\r
92 /// Default time before compression reaches its full value, in decibels (dB). The default value is 10 ms.
\r
94 literal float AttackDefault = 10.0f;
\r
97 /// Maximum time before compression reaches its full value, in decibels (dB).
\r
99 literal float AttackMax = DSFXCOMPRESSOR_ATTACK_MAX;
\r
102 /// Minimum time before compression reaches its full value, in decibels (dB).
\r
104 literal float AttackMin = DSFXCOMPRESSOR_ATTACK_MIN;
\r
107 /// Default output gain of signal after compression, in decibels (dB). The default value is 0 dB.
\r
109 literal float GainDefault = 0.0f;
\r
112 /// Maximum output gain of signal after compression, in decibels (dB).
\r
114 literal float GainMax = DSFXCOMPRESSOR_GAIN_MAX;
\r
117 /// Minimum output gain of signal after compression, in decibels (dB).
\r
119 literal float GainMin = DSFXCOMPRESSOR_GAIN_MIN;
\r
122 /// Default time after threshold is reached before attack phase is started, in milliseconds. The default value is 4 ms.
\r
124 literal float PreDelayDefault = 4.0f;
\r
127 /// Maximum time after threshold is reached before attack phase is started, in milliseconds.
\r
129 literal float PreDelayMax = DSFXCOMPRESSOR_PREDELAY_MAX;
\r
132 /// Minimum time after threshold is reached before attack phase is started, in milliseconds.
\r
134 literal float PreDelayMin = DSFXCOMPRESSOR_PREDELAY_MIN;
\r
137 /// Default compression ratio. The default value is 3, which means 3:1 compression.
\r
139 literal float RatioDefault = 3.0f;
\r
142 /// Maximum compression ratio.
\r
144 literal float RatioMax = DSFXCOMPRESSOR_RATIO_MAX;
\r
147 /// Minimum compression ratio.
\r
149 literal float RatioMin = DSFXCOMPRESSOR_RATIO_MIN;
\r
152 /// Default speed at which compression is stopped after input drops below Threshold, in miliseconds. The default value is 200 ms.
\r
154 literal float ReleaseDefault = 200.0f;
\r
157 /// Maximum speed at which compression is stopped after input drops below Threshold, in miliseconds.
\r
159 literal float ReleaseMax = DSFXCOMPRESSOR_RELEASE_MAX;
\r
162 /// Minimum speed at which compression is stopped after input drops below Threshold, in miliseconds.
\r
164 literal float ReleaseMin = DSFXCOMPRESSOR_RELEASE_MIN;
\r
167 /// Default point at which compression begins, in decibels, in decibels (dB). The default value is -20 dB.
\r
169 literal float ThresholdDefault = -20.0f;
\r
172 /// Maximum point at which compression begins, in decibels, in decibels (dB).
\r
174 literal float ThresholdMax = DSFXCOMPRESSOR_THRESHOLD_MAX;
\r
177 /// Minimum point at which compression begins, in decibels, in decibels (dB).
\r
179 literal float ThresholdMin = DSFXCOMPRESSOR_THRESHOLD_MIN;
\r