Skip to content
30 changes: 20 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,11 @@ 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`, 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 +54,10 @@ properties:
- Audio
writeCapabilities: []
- name: AudioLimiter.Release
summary: ''
description: ''
summary: 'The amount of time it takes for previously-loud 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 +75,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