# AudioFilter

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

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

Adjusts the frequency content of audio streams.

## Properties

### Bypass

```luau
AudioFilter.Bypass: boolean = false
```

- Tags: Read capabilities: Audio

Whether audio streams are passed-through unaffected by this effect.

### FilterType

```luau
AudioFilter.FilterType: Enum.AudioFilterType = Enum.AudioFilterType.Peak
```

- Tags: Read capabilities: Audio

The curve type of the band represented by the filter.

### Frequency

```luau
AudioFilter.Frequency: number = 2000
```

- Tags: Read capabilities: Audio

The central frequency that the filter acts around.

### Gain

```luau
AudioFilter.Gain: number = 0
```

- Tags: Read capabilities: Audio

For peaking and shelving filters, controls volume increase or reduction.

### Q

```luau
AudioFilter.Q: number = 0.707000017
```

- Tags: Read capabilities: Audio

For peaking, lowpass, highpass, bandpass, and notch filters, controls the selectiveness or resonance.

### Editor

```luau
AudioFilter.Editor: boolean = false
```

- Tags: Not replicated, Roblox script security, Read capabilities: Audio, Load only

## Methods

### GetConnectedWires

```luau
AudioFilter:GetConnectedWires(pin: string): { Instance }
```

- Tags: Capabilities: Audio

Returns an array of `Wires` that are connected to the specified pin.

Parameters:

- `pin`: An input or output pin on this instance

Returns: An array of `Wires`

### GetGainAt

```luau
AudioFilter:GetGainAt(frequency: number): number
```

- Tags: Capabilities: Audio

Returns the magnitude response of the filter at the given frequency.

Parameters:

- `frequency`: The frequency, in hertz, to sample.

Returns: The gain value, in decibels, at the given frequency.

### GetInputPins

```luau
AudioFilter:GetInputPins(): { any }
```

- Tags: Capabilities: Audio

Gets the list of pins that [`Wire`](https://rapi.sleaze.dev/classes/Wire.md) can use in [`Wire.TargetName`](https://rapi.sleaze.dev/classes/Wire.md) to connect to this instance via its [`Wire.TargetInstance`](https://rapi.sleaze.dev/classes/Wire.md) property.

Returns: An array of strings representing valid pin names.

### GetOutputPins

```luau
AudioFilter:GetOutputPins(): { any }
```

- Tags: Capabilities: Audio

Gets the list of pins that [`Wire`](https://rapi.sleaze.dev/classes/Wire.md) can use in [`Wire.SourceName`](https://rapi.sleaze.dev/classes/Wire.md) to connect to this instance via its [`Wire.SourceInstance`](https://rapi.sleaze.dev/classes/Wire.md) property.

Returns: An array of strings representing valid pin names.

## Events

### WiringChanged

```luau
AudioFilter.WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance)>
```

- Tags: Capabilities: Audio

Fires when another instance is connected to or disconnected from the [`AudioFilter`](https://rapi.sleaze.dev/classes/AudioFilter.md) via a [`Wire`](https://rapi.sleaze.dev/classes/Wire.md).

## Inherited members

- 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`