Skip to content

Commit

Permalink
Update AudioLimiter.yaml (#869)
Browse files Browse the repository at this point in the history
## 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]>
  • Loading branch information
4 people authored Oct 18, 2024
1 parent 96268bb commit 0b017c7
Showing 1 changed file with 27 additions and 10 deletions.
37 changes: 27 additions & 10 deletions content/en-us/reference/engine/classes/AudioLimiter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,23 @@ name: AudioLimiter
type: class
category:
memory_category: Internal
summary: ''
description: ''
summary: |
Limits how loud audio streams are allowed to be.
description: |
`AudioLimiter` limits how loud audio streams are allowed to be.
Whenever its input stream exceeds a specified maximum level, the stream's volume is reduced for a moment.
`AudioLimiter` provides a single **Input** pin, and a single **Output** pin that can be connected to/from by `Class.Wires`.
code_samples: []
inherits:
- Instance
tags: []
deprecation_message: ''
properties:
- name: AudioLimiter.Bypass
summary: ''
description: ''
summary: |
Whether audio streams are passed-through unaffected by this effect.
description: |
If `true`, audio streams are passed-through unaffected by this effect.
code_samples: []
type: bool
tags: []
Expand All @@ -29,8 +35,13 @@ properties:
- Audio
writeCapabilities: []
- name: AudioLimiter.MaxLevel
summary: ''
description: ''
summary: |
The maximum volume tolerated.
description: |
The maximum volume, in decibels, that the limiter will allow to pass through without reduction.
Whenever the input stream exceeds `Class.AudioLimiter.MaxLevel|MaxLevel`, the output
stream's volume will be reduced to compensate.
This value ranges from `-12` to `0`.
code_samples: []
type: float
tags: []
Expand All @@ -47,8 +58,11 @@ properties:
- Audio
writeCapabilities: []
- name: AudioLimiter.Release
summary: ''
description: ''
summary: |
The amount of time it takes for previously limited streams to return to their normal volume.
description: |
The amount of time, in seconds, that it takes for any previously (but not currently) limited streams to
return to their normal volume. This value ranges from `0.001` to `1`.
code_samples: []
type: float
tags: []
Expand All @@ -66,8 +80,11 @@ properties:
writeCapabilities: []
methods:
- name: AudioLimiter:GetConnectedWires
summary: ''
description: ''
summary: |
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
description: |
Returns an array of `Class.Wire|Wires` that are connected to the specified pin. `Class.AudioLimiter`
has one **Input** pin and one **Output** pin.
code_samples: []
parameters:
- name: pin
Expand Down

0 comments on commit 0b017c7

Please sign in to comment.