@@ -5,18 +5,20 @@ memory_category: Internal
55summary : |
66 Limits how loud audio streams are allowed to be.
77description : |
8- `Class. AudioLimiter` limits how loud audio streams are allowed to be.
8+ `AudioLimiter` limits how loud audio streams are allowed to be.
99 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`.
10+ `AudioLimiter` provides a single **Input** pin, and a single **Output** pin that can be connected to/from by `Class.Wires`.
1111code_samples : []
1212inherits :
1313 - Instance
1414tags : []
1515deprecation_message : ' '
1616properties :
1717 - name : AudioLimiter.Bypass
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.'
18+ summary : |
19+ Whether audio streams are passed-through unaffected by this effect.
20+ description : |
21+ If `true`, audio streams are passed-through unaffected by this effect.
2022 code_samples : []
2123 type : bool
2224 tags : []
@@ -33,11 +35,13 @@ properties:
3335 - Audio
3436 writeCapabilities : []
3537 - name : AudioLimiter.MaxLevel
36- summary : ' The maximum volume tolerated.'
38+ summary : |
39+ The maximum volume tolerated.
3740 description : |
38- The maximum volume, in decibels, that the limiter will allow to pass through, without reduction.
39- Whenever the input stream exceeds `Class.AudioLimiter.MaxLevel`, the output stream's volume will be reduced to compensate.
40- This value ranges from -12 to 0.
41+ The maximum volume, in decibels, that the limiter will allow to pass through without reduction.
42+ Whenever the input stream exceeds `Class.AudioLimiter.MaxLevel|MaxLevel`, the output
43+ stream's volume will be reduced to compensate.
44+ This value ranges from `-12` to `0`.
4145 code_samples : []
4246 type : float
4347 tags : []
@@ -54,10 +58,11 @@ properties:
5458 - Audio
5559 writeCapabilities : []
5660 - name : AudioLimiter.Release
57- summary : ' The amount of time it takes for previously-loud streams to return to their normal volume.'
61+ summary : |
62+ The amount of time it takes for previously limited streams to return to their normal volume.
5863 description : |
59- The amount of time, in seconds, that it takes for any previously (but not currently) limited streams to return to their normal volume.
60- This value ranges from 0.001 to 1 .
64+ The amount of time, in seconds, that it takes for any previously (but not currently) limited streams to
65+ return to their normal volume. This value ranges from ` 0.001` to `1` .
6166 code_samples : []
6267 type : float
6368 tags : []
@@ -75,9 +80,11 @@ properties:
7580 writeCapabilities : []
7681methods :
7782 - name : AudioLimiter:GetConnectedWires
78- summary : ' Returns an array of `Class.Wires` that are connected to the specified pin.'
83+ summary : |
84+ Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
7985 description : |
80- Returns an array of `Class.Wires` that are connected to the specified pin. `Class.AudioLimiter` has one "Input" pin, and one "Output" pin.
86+ Returns an array of `Class.Wire|Wires` that are connected to the specified pin. `Class.AudioLimiter`
87+ has one **Input** pin and one **Output** pin.
8188 code_samples : []
8289 parameters :
8390 - name : pin
0 commit comments