@@ -2,17 +2,21 @@ name: AudioLimiter
22type : class
33category :
44memory_category : Internal
5- summary : ' '
6- description : ' '
5+ summary : |
6+ `Class.AudioLimiter` limits how loud audio streams are allowed to be.
7+ description : |
8+ `Class.AudioLimiter` limits how loud audio streams are allowed to be.
9+ Whenever its input stream exceeds a specified maximum level, the stream's volume is reduced for a moment.
10+ `Class.AudioLimiter` provides a single **Input** pin, and a single **Output** pin that can be connected to/from by `Class.Wires`.
711code_samples : []
812inherits :
913 - Instance
1014tags : []
1115deprecation_message : ' '
1216properties :
1317 - name : AudioLimiter.Bypass
14- summary : ' '
15- description : ' '
18+ summary : ' Whether audio streams are passed-through unaffected by this effect. '
19+ description : ' If `true`, audio streams are passed-through unaffected by this effect. '
1620 code_samples : []
1721 type : bool
1822 tags : []
@@ -29,8 +33,10 @@ properties:
2933 - Audio
3034 writeCapabilities : []
3135 - name : AudioLimiter.MaxLevel
32- summary : ' '
33- description : ' '
36+ summary : ' The maximum volume tolerated.'
37+ description : |
38+ The maximum volume, in decibels, that the limiter will allow to pass through, unclamped.
39+ Whenever
3440 code_samples : []
3541 type : float
3642 tags : []
@@ -47,8 +53,9 @@ properties:
4753 - Audio
4854 writeCapabilities : []
4955 - name : AudioLimiter.Release
50- summary : ' '
51- description : ' '
56+ summary : ' The amount of time it takes to unclamp previously-loud streams.'
57+ description : |
58+ The amount of time, in seconds, that it takes for the limiter to unclamp any previously (but not currently) loud streams.
5259 code_samples : []
5360 type : float
5461 tags : []
@@ -66,8 +73,9 @@ properties:
6673 writeCapabilities : []
6774methods :
6875 - name : AudioLimiter:GetConnectedWires
69- summary : ' '
70- description : ' '
76+ summary : ' Returns an array of `Class.Wires` that are connected to the specified pin.'
77+ description : |
78+ Returns an array of `Class.Wires` that are connected to the specified pin. `Class.AudioLimiter` has one "Input" pin, and one "Output" pin.
7179 code_samples : []
7280 parameters :
7381 - name : pin
0 commit comments