AudioGate
Mutes audio streams that fall below a certain volume threshold.
| Memory category | Internal |
|---|
Member index 9
Description
History 13
- 683 Change Tags of AudioGate from [NotBrowsable] to []
- 681 Change Tags of AudioGate from [] to [NotBrowsable]
- 682 Change Tags of AudioGate from [NotBrowsable] to []
- 680 Add WiringChanged
- 680 Add Reset
- 680 Add GetOutputPins
- 680 Add GetInputPins
- 680 Add GetConnectedWires
- 680 Add Threshold
- 680 Add Release
- 680 Add Bypass
- 680 Add Attack
- 680 Add AudioGate
Members 9
Attack
| Type | Default | |
|---|---|---|
| float | 0.00999999978 | |
The duration, in seconds, over which the gate will unmute the audio stream when the signal level rises above the Threshold. Ranges from 0.001 to 5.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Bypass
| Type | Default | |
|---|---|---|
| bool | false | |
If true, audio streams are passed-through unaffected by this effect.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
GetConnectedWires
| Parameters (1) | ||
|---|---|---|
| pin | string | |
| Returns (1) | ||
| Instances | ||
Returns an array of Wires that are connected to the specified pin. AudioGate has one "Input" pin and one "Output" pin.
| Thread safety | Unsafe |
|---|
History 1
- 680 Add GetConnectedWires
GetInputPins
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.
For AudioGate, this is Input only.
| Thread safety | Unsafe |
|---|
History 1
- 680 Add GetInputPins
GetOutputPins
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.
For AudioGate, this is Output only.
| Thread safety | Unsafe |
|---|
History 1
- 680 Add GetOutputPins
Release
| Type | Default | |
|---|---|---|
| float | 0.100000001 | |
The duration, in seconds, over which the gate will mute the audio stream when the signal level drops below the Threshold. Ranges from 0.001 to 5.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Reset
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
Threshold
| Type | Default | |
|---|---|---|
| NumberRange | -36 -24 | |
The gain value(s), in decibels, at which the gate will transition from being closed (i.e. muted) to being open (i.e. unmuted).
AudioGate.Threshold is a NumberRange with a "low" and a "high" threshold. The gate starts out muted - when the input stream's volume rises above the "high" threshold, the gate will unmute the audio stream over the course of Attack seconds. If the input stream's volume then dips below the "low" threshold, the gate will mute the audio stream over the course of Release seconds. The two "low" and "high" thresholds create a hysteresis region to prevent the gate from opening and closing very rapidly.
Ranges from -80 to 30, and defaults to -36 (low) and -24 (high).
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
WiringChanged
| Parameters (4) | |
|---|---|
| connected | bool |
| pin | string |
| wire | Wire |
| instance | Instance |
Event that fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the AudioGate and to some other wirable instance.
| Thread safety | Unsafe |
|---|
History 1
- 680 Add WiringChanged