Skip to content
28 changes: 18 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,21 @@ name: AudioLimiter
type: class
category:
memory_category: Internal
summary: ''
description: ''
summary: |
Limits how loud audio streams are allowed to be.
description: |
`Class.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.
`Class.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 +33,10 @@ 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, unclamped.
Whenever the input stream exceeds `Class.AudioLimiter.MaxLevel`, the output stream's volume will be reduced to compensate.
code_samples: []
type: float
tags: []
Expand All @@ -47,8 +53,9 @@ properties:
- Audio
writeCapabilities: []
- name: AudioLimiter.Release
summary: ''
description: ''
summary: 'The amount of time it takes to unclamp previously-loud streams.'
description: |
The amount of time, in seconds, that it takes for the limiter to unclamp any previously (but not currently) loud streams.
code_samples: []
type: float
tags: []
Expand All @@ -66,8 +73,9 @@ properties:
writeCapabilities: []
methods:
- name: AudioLimiter:GetConnectedWires
summary: ''
description: ''
summary: 'Returns an array of `Class.Wires` that are connected to the specified pin.'
description: |
Returns an array of `Class.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
Loading