Skip to content

Commit 0b017c7

Browse files
rbxphogenmatthewzhang-rbxjulia-rbxIgnisRBX
authored
Update AudioLimiter.yaml (#869)
## Changes Add a description for AudioLimiter ## Checks By submitting your pull request for review, you agree to the following: - [x] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [x] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [x] To the best of my knowledge, all proposed changes are accurate. --------- Co-authored-by: matthewzhang-rbx <[email protected]> Co-authored-by: julia <[email protected]> Co-authored-by: IgnisRBX <[email protected]>
1 parent 96268bb commit 0b017c7

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

content/en-us/reference/engine/classes/AudioLimiter.yaml

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,23 @@ name: AudioLimiter
22
type: class
33
category:
44
memory_category: Internal
5-
summary: ''
6-
description: ''
5+
summary: |
6+
Limits how loud audio streams are allowed to be.
7+
description: |
8+
`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+
`AudioLimiter` provides a single **Input** pin, and a single **Output** pin that can be connected to/from by `Class.Wires`.
711
code_samples: []
812
inherits:
913
- Instance
1014
tags: []
1115
deprecation_message: ''
1216
properties:
1317
- name: AudioLimiter.Bypass
14-
summary: ''
15-
description: ''
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.
1622
code_samples: []
1723
type: bool
1824
tags: []
@@ -29,8 +35,13 @@ properties:
2935
- Audio
3036
writeCapabilities: []
3137
- name: AudioLimiter.MaxLevel
32-
summary: ''
33-
description: ''
38+
summary: |
39+
The maximum volume tolerated.
40+
description: |
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`.
3445
code_samples: []
3546
type: float
3647
tags: []
@@ -47,8 +58,11 @@ properties:
4758
- Audio
4859
writeCapabilities: []
4960
- name: AudioLimiter.Release
50-
summary: ''
51-
description: ''
61+
summary: |
62+
The amount of time it takes for previously limited streams to return to their normal volume.
63+
description: |
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`.
5266
code_samples: []
5367
type: float
5468
tags: []
@@ -66,8 +80,11 @@ properties:
6680
writeCapabilities: []
6781
methods:
6882
- name: AudioLimiter:GetConnectedWires
69-
summary: ''
70-
description: ''
83+
summary: |
84+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
85+
description: |
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.
7188
code_samples: []
7289
parameters:
7390
- name: pin

0 commit comments

Comments
 (0)