# CompressorSoundEffect

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [SoundEffect](https://rapi.sleaze.dev/classes/SoundEffect.md), [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/CompressorSoundEffect/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/CompressorSoundEffect

Adjusts the dynamic range of audio.

## Properties

### Attack

```luau
CompressorSoundEffect.Attack: number = 0.100000001
```

- Tags: Read capabilities: LegacySound

The time the effect takes to become active after its [`Threshold`](https://rapi.sleaze.dev/classes/CompressorSoundEffect.md) has been reached.

### GainMakeup

```luau
CompressorSoundEffect.GainMakeup: number = 0
```

- Tags: Read capabilities: LegacySound

The overall amplification applied to the effect's [`Sound`](https://rapi.sleaze.dev/classes/Sound.md) or [`SoundGroup`](https://rapi.sleaze.dev/classes/SoundGroup.md) after attenuation of sounds above the threshold.

### Ratio

```luau
CompressorSoundEffect.Ratio: number = 40
```

- Tags: Read capabilities: LegacySound

The ratio between the [`SideChain`](https://rapi.sleaze.dev/classes/CompressorSoundEffect.md) sound effect, and this sound effect.

### Release

```luau
CompressorSoundEffect.Release: number = 0.100000001
```

- Tags: Read capabilities: LegacySound

The time the effect takes to become inactive after its sound is below the [`Threshold`](https://rapi.sleaze.dev/classes/CompressorSoundEffect.md).

### SideChain

```luau
CompressorSoundEffect.SideChain: Instance
```

- Tags: Read capabilities: LegacySound

Applies a ducking effect to the compressor sound effect. The behavior of the sidechain depends on the [`Sound`](https://rapi.sleaze.dev/classes/Sound.md) or [`SoundGroup`](https://rapi.sleaze.dev/classes/SoundGroup.md) linked to it.

### Threshold

```luau
CompressorSoundEffect.Threshold: number = -40
```

- Tags: Read capabilities: LegacySound

Volume level at which point the compressor applies its effect.

## Inherited members

- From [SoundEffect](https://rapi.sleaze.dev/classes/SoundEffect.md): `Enabled`, `Priority`
- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`