diff --git a/content/en-us/reference/engine/classes/AudioLimiter.yaml b/content/en-us/reference/engine/classes/AudioLimiter.yaml index 8fd6ce1e5..fbb01d830 100644 --- a/content/en-us/reference/engine/classes/AudioLimiter.yaml +++ b/content/en-us/reference/engine/classes/AudioLimiter.yaml @@ -2,8 +2,12 @@ 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 @@ -11,8 +15,10 @@ 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: [] @@ -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: [] @@ -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: [] @@ -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