Easy Effects

https://wwmm.github.io/easyeffects/
Admin
Easy Effects applies audio effects to applications managed by PipeWire, allowing effects to be...
Tokens:22,887
Snippets:360
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Plugin Property Management

Source: https://wwmm.github.io/easyeffects/user_interface/local_server.html

Commands to get and set individual plugin properties.

```APIDOC
## Plugin Property API

### Description
Allows modification and retrieval of specific properties for individual plugins within Easy Effects.

### Method
POST (via socat or direct socket communication)

### Endpoint
`UNIX-CONNECT:$XDG_RUNTIME_DIR/EasyEffectsServer`

### Parameters
- **pipeline**: `output` or `input`.
- **plugin_id**: The unique identifier of the plugin (e.g., `compressor`, `equalizer`).
- **instance_id**: The instance number, starting from `0`.
- **property_name**: The specific setting to change (e.g., `threshold`, `inputGain`).

### Commands
#### Set Property
**Format:** `set_property:pipeline:plugin_id:instance_id:property_name:value`

**Example 1:** Set the compressor threshold on the output pipeline to -20dB:
```bash
echo "set_property:output:compressor:0:threshold:-20" | socat - UNIX-CONNECT:$XDG_RUNTIME_DIR/EasyEffectsServer
```

**Example 2:** Set the compressor `mode` to `Upward` (assuming `1` represents Upward):
```bash
echo "set_property:output:compressor:0:mode:1" | socat - UNIX-CONNECT:$XDG_RUNTIME_DIR/EasyEffectsServer
```

#### Get Property
**Format:** `get_property:pipeline:plugin_id:instance_id:property_name`

**Example:** Get the current output gain of the equalizer:
```bash
echo "get_property:output:equalizer:0:outputGain" | socat - UNIX-CONNECT:$XDG_RUNTIME_DIR/EasyEffectsServer
```

### Response Example
(For `get_property`, the response will be the current value of the specified property.)
```

--------------------------------

### Load Preset via Socat

Source: https://wwmm.github.io/easyeffects/user_interface/local_server.html

Use this command to load a specific preset for an audio pipeline. Ensure the preset name and pipeline are correctly specified.

```bash
echo "load_preset:output:MyPresetName" | socat - UNIX-CONNECT:$XDG_RUNTIME_DIR/EasyEffectsServer
```

--------------------------------

### General Commands

Source: https://wwmm.github.io/easyeffects/user_interface/local_server.html

These commands control the main Easy Effects application window and global settings.

```APIDOC
## General Commands API

### Description
Provides commands to control the Easy Effects application, such as showing/hiding the window, quitting, toggling effects, and loading presets.

### Method
POST (via socat or direct socket communication)

### Endpoint
`UNIX-CONNECT:$XDG_RUNTIME_DIR/EasyEffectsServer`

### Commands
- **show_window**: Opens the main window.
- **hide_window**: Hides the main window.
- **quit_app**: Quits Easy Effects.
- **global_bypass**: Toggles effects on/off. Arguments: `1` (bypass) or `0` (active).
- **load_preset**: Loads a preset. Arguments: `pipeline:preset_name`.
- **get_last_loaded_preset**: Returns the name of the last loaded preset. Arguments: `pipeline`.

### Request Example
```bash
echo "load_preset:output:MyPresetName" | socat - UNIX-CONNECT:$XDG_RUNTIME_DIR/EasyEffectsServer
```

### Response Example
(Varies based on command. For `get_last_loaded_preset`, it would return the preset name.)
```

--------------------------------

### Get Equalizer Output Gain via Socat

Source: https://wwmm.github.io/easyeffects/user_interface/local_server.html

Retrieve the current output gain setting for the equalizer plugin on the output pipeline. The response will be printed to standard output.

```bash
echo "get_property:output:equalizer:0:outputGain" | socat - UNIX-CONNECT:$XDG_RUNTIME_DIR/EasyEffectsServer
```

--------------------------------

### Equalizer Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Endpoints for managing the equalizer module settings.

```APIDOC
## GET /equalizer

### Description
Retrieves the current configuration for the equalizer module.

### Method
GET

### Endpoint
/equalizer

### Response
#### Success Response (200)
- **bypass** (Bool) - Bypass status
- **inputGain** (Double) - Input gain level
- **outputGain** (Double) - Output gain level
- **numBands** (Int) - Number of bands
- **mode** (Enum) - 0: IIR, 1: FIR, 2: FFT, 3: SPM
- **splitChannels** (Bool) - Split channels status
- **balance** (Double) - Balance level
- **pitchLeft** (Double) - Left pitch
- **pitchRight** (Double) - Right pitch
- **viewLeftChannel** (Bool) - View left channel status
```

--------------------------------

### Multiband Compressor Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Configuration parameters for the multiband compressor plugin, covering 8 bands of audio processing.

```APIDOC
## Multiband Compressor Configuration

### Description
This configuration defines the settings for the 8-band compressor, including compression modes, enable states, solo/mute toggles, and dynamic processing parameters like attack and release thresholds and times.

### Parameters
#### Request Body
- **band7SidechainHighcutFrequency** (Double) - Sidechain highcut frequency for band 7.
- **band[0-7]CompressionMode** (Enum) - Compression mode for each band (0: Downward, 1: Upward, 2: Boosting).
- **band[0-7]CompressorEnable** (Bool) - Enable state for each band's compressor.
- **band[0-7]Solo** (Bool) - Solo state for each band.
- **band[0-7]Mute** (Bool) - Mute state for each band.
- **band[0-7]AttackThreshold** (Double) - Attack threshold for each band.
- **band[0-7]AttackTime** (Double) - Attack time for each band.
- **band[0-7]ReleaseThreshold** (Double) - Release threshold for each band.
- **band[0-7]ReleaseTime** (Double) - Release time for each band.
- **band[0-4]Ratio** (Double) - Compression ratio for the specified bands.
```

--------------------------------

### Reverb Plugin Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Configuration for the reverb effect, including room size, decay, and frequency cutoffs.

```APIDOC
## Reverb Plugin Parameters

### Parameters
- **bypass** (Bool) - Default: false
- **inputGain** (Double) - Default: 0
- **outputGain** (Double) - Default: 0
- **roomSize** (Enum) - Default: 2 (0: Small, 1: Medium, 2: Large, 3: Tunnel-like, 4: Large/smooth, 5: Experimental)
- **decayTime** (Double) - Default: 1.5
- **hfDamp** (Double) - Default: 5000
- **diffusion** (Double) - Default: 0.5
- **amount** (Double) - Default: -12
- **dry** (Double) - Default: 0
- **predelay** (Double) - Default: 0
- **bassCut** (Double) - Default: 300
- **trebleCut** (Double) - Default: 5000
```

--------------------------------

### Expander Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Endpoints for managing the expander module settings.

```APIDOC
## GET /expander

### Description
Retrieves the current configuration for the expander module.

### Method
GET

### Endpoint
/expander

### Response
#### Success Response (200)
- **bypass** (Bool) - Bypass status
- **mode** (Enum) - 0: Downward, 1: Upward
- **attack** (Double) - Attack time
- **release** (Double) - Release time
- **threshold** (Double) - Threshold level
- **ratio** (Double) - Ratio value
- **sidechainType** (Enum) - 0: Internal, 1: External, 2: Link
```

--------------------------------

### Multiband Gate Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Parameters for controlling the multiband gate plugin, including hysteresis, thresholds, and gain settings for multiple bands.

```APIDOC
## Multiband Gate Parameters

### Parameters
- **band[0-7]HysteresisThreshold** (Double) - Default: -12
- **band[0-7]HysteresisZone** (Double) - Default: -6
- **band[0-7]CurveThreshold** (Double) - Default: -24
- **band[0-7]CurveZone** (Double) - Default: -6
- **band[0-7]Reduction** (Double) - Default: -24
- **band[0-7]Makeup** (Double) - Default: 0
```

--------------------------------

### Limiter Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Configuration options for the Limiter audio effect.

```APIDOC
## Limiter Configuration

### Description
Configures the parameters for the Limiter audio effect, controlling peak levels and dynamic range.

### Parameters
#### Request Body
- **bypass** (Bool) - Optional - Bypasses the limiter effect.
- **inputGain** (Double) - Optional - Adjusts the input gain of the limiter.
- **outputGain** (Double) - Optional - Adjusts the output gain of the limiter.
- **mode** (Enum) - Optional - Sets the limiter mode. Choices: `Herm Thin`, `Herm Wide`, `Herm Tail`, `Herm Duck`, `Exp Thin`, `Exp Wide`, `Exp Tail`, `Exp Duck`, `Line Thin`, `Line Wide`, `Line Tail`, `Line Duck`.
- **oversampling** (Enum) - Optional - Sets the oversampling mode. Choices: `None`, `Half x2/16 bit`, `Half x2/24 bit`, `Half x3/16 bit`, `Half x3/24 bit`, `Half x4/16 bit`, `Half x4/24 bit`, `Half x6/16 bit`, `Half x6/24 bit`, `Half x8/16 bit`, `Half x8/24 bit`, `Full x2/16 bit`, `Full x2/24 bit`, `Full x3/16 bit`, `Full x3/24 bit`, `Full x4/16 bit`, `Full x4/24 bit`, `Full x6/16 bit`, `Full x6/24 bit`, `Full x8/16 bit`, `Full x8/24 bit`, `True Peak/16 bit`, `True Peak/24 bit`.
- **dithering** (Enum) - Optional - Sets the dithering mode. Choices: `None`, `7bit`, `8bit`, `11bit`, `12bit`, `15bit`, `16bit`, `23bit`, `24bit`.
- **sidechainType** (Enum) - Optional - Specifies the sidechain type. Choices: `Internal`, `External`, `Link`.
- **lookahead** (Double) - Optional - Sets the lookahead time.
- **attack** (Double) - Optional - Sets the attack time.
- **release** (Double) - Optional - Sets the release time.
- **threshold** (Double) - Optional - Sets the threshold level.
- **gainBoost** (Bool) - Optional - Enables gain boost.
- **sidechainPreamp** (Double) - Optional - Adjusts the preamp gain for the sidechain.
- **stereoLink** (Double) - Optional - Sets the stereo linking percentage.
- **alr** (Bool) - Optional - Enables Automatic Loudness Reduction.
- **alrAttack** (Double) - Optional - Sets the attack time for ALR.
- **alrRelease** (Double) - Optional - Sets the release time for ALR.
- **alrKnee** (Double) - Optional - Sets the knee for ALR.
- **alrKneeSmooth** (Double) - Optional - Sets the knee smoothing for ALR.
- **sidechainInputDevice** (String) - Optional - Specifies the input device for the sidechain.
- **inputToSidechain** (Double) - Optional - Gain adjustment from input to sidechain.
- **inputToLink** (Double) - Optional - Gain adjustment from input to link.
- **sidechainToInput** (Double) - Optional - Gain adjustment from sidechain to input.
- **sidechainToLink** (Double) - Optional - Gain adjustment from sidechain to link.
- **linkToSidechain** (Double) - Optional - Gain adjustment from link to sidechain.
- **linkToInput** (Double) - Optional - Gain adjustment from link to input.

### Response
#### Success Response (200)
- **limiter** (Object) - Contains the limiter configuration parameters.
```

--------------------------------

### Multiband Compressor Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Parameters for configuring the multiband compressor bands.

```APIDOC
## Multiband Compressor Parameters

### Description
Configuration settings for the 8-band compressor (bands 0-7).

### Parameters
- **band[0-7]Ratio** (Double) - Compression ratio for the specified band.
- **band[0-7]Knee** (Double) - Knee setting for the specified band.
- **band[0-7]BoostThreshold** (Double) - Boost threshold for the specified band.
- **band[0-7]BoostAmount** (Double) - Boost amount for the specified band.
- **band[0-7]Makeup** (Double) - Makeup gain for the specified band.
```

--------------------------------

### Multiband Compressor Parameters

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Configuration options for the Multiband Compressor effect.

```APIDOC
## Multiband Compressor Configuration

### Description
This section details the parameters available for configuring the Multiband Compressor effect. These parameters control various aspects of the compressor, including sidechaining behavior, band enabling, frequency splitting, and stereo processing.

### Parameters

#### General Parameters
- **multiband_compressor** | `inputToSidechain` (Double) - Default: `-80.01` - Controls the input to sidechain signal level.
- **multiband_compressor** | `inputToLink` (Double) - Default: `-80.01` - Controls the input to link signal level.
- **multiband_compressor** | `sidechainToInput` (Double) - Default: `-80.01` - Controls the sidechain to input signal level.
- **multiband_compressor** | `sidechainToLink` (Double) - Default: `-80.01` - Controls the sidechain to link signal level.
- **multiband_compressor** | `linkToSidechain` (Double) - Default: `-80.01` - Controls the link to sidechain signal level.
- **multiband_compressor** | `linkToInput` (Double) - Default: `-80.01` - Controls the link to input signal level.
- **multiband_compressor** | `sidechainInputDevice` (String) - Default: `""` - Specifies the device for sidechain input.

#### Band Enabling
- **multiband_compressor** | `band1Enable` (Bool) - Default: `true` - Enables or disables Band 1.
- **multiband_compressor** | `band2Enable` (Bool) - Default: `true` - Enables or disables Band 2.
- **multiband_compressor** | `band3Enable` (Bool) - Default: `true` - Enables or disables Band 3.
- **multiband_compressor** | `band4Enable` (Bool) - Default: `false` - Enables or disables Band 4.
- **multiband_compressor** | `band5Enable` (Bool) - Default: `false` - Enables or disables Band 5.
- **multiband_compressor** | `band6Enable` (Bool) - Default: `false` - Enables or disables Band 6.
- **multiband_compressor** | `band7Enable` (Bool) - Default: `false` - Enables or disables Band 7.

#### Band Split Frequencies
- **multiband_compressor** | `band1SplitFrequency` (Double) - Default: `500` - Sets the split frequency for Band 1.
- **multiband_compressor** | `band2SplitFrequency` (Double) - Default: `1000` - Sets the split frequency for Band 2.
- **multiband_compressor** | `band3SplitFrequency` (Double) - Default: `2000` - Sets the split frequency for Band 3.
- **multiband_compressor** | `band4SplitFrequency` (Double) - Default: `4000` - Sets the split frequency for Band 4.
- **multiband_compressor** | `band5SplitFrequency` (Double) - Default: `8000` - Sets the split frequency for Band 5.
- **multiband_compressor** | `band6SplitFrequency` (Double) - Default: `12000` - Sets the split frequency for Band 6.
- **multiband_compressor** | `band7SplitFrequency` (Double) - Default: `16000` - Sets the split frequency for Band 7.

#### Sidechain Type
- **multiband_compressor** | `band0SidechainType` (Enum) - Default: `0` - Type of sidechain for Band 0. Choices: `0`: `Internal`, `1`: `External`, `2`: `Link`.
- **multiband_compressor** | `band1SidechainType` (Enum) - Default: `0` - Type of sidechain for Band 1. Choices: `0`: `Internal`, `1`: `External`, `2`: `Link`.
- **multiband_compressor** | `band2SidechainType` (Enum) - Default: `0` - Type of sidechain for Band 2. Choices: `0`: `Internal`, `1`: `External`, `2`: `Link`.
- **multiband_compressor** | `band3SidechainType` (Enum) - Default: `0` - Type of sidechain for Band 3. Choices: `0`: `Internal`, `1`: `External`, `2`: `Link`.
- **multiband_compressor** | `band4SidechainType` (Enum) - Default: `0` - Type of sidechain for Band 4. Choices: `0`: `Internal`, `1`: `External`, `2`: `Link`.
- **multiband_compressor** | `band5SidechainType` (Enum) - Default: `0` - Type of sidechain for Band 5. Choices: `0`: `Internal`, `1`: `External`, `2`: `Link`.
- **multiband_compressor** | `band6SidechainType` (Enum) - Default: `0` - Type of sidechain for Band 6. Choices: `0`: `Internal`, `1`: `External`, `2`: `Link`.
- **multiband_compressor** | `band7SidechainType` (Enum) - Default: `0` - Type of sidechain for Band 7. Choices: `0`: `Internal`, `1`: `External`, `2`: `Link`.

#### Sidechain Mode
- **multiband_compressor** | `band0SidechainMode` (Enum) - Default: `1` - Mode of sidechain for Band 0. Choices: `0`: `Peak`, `1`: `RMS`, `2`: `LPF`, `3`: `SMA`.
- **multiband_compressor** | `band1SidechainMode` (Enum) - Default: `1` - Mode of sidechain for Band 1. Choices: `0`: `Peak`, `1`: `RMS`, `2`: `LPF`, `3`: `SMA`.
- **multiband_compressor** | `band2SidechainMode` (Enum) - Default: `1` - Mode of sidechain for Band 2. Choices: `0`: `Peak`, `1`: `RMS`, `2`: `LPF`, `3`: `SMA`.
- **multiband_compressor** | `band3SidechainMode` (Enum) - Default: `1` - Mode of sidechain for Band 3. Choices: `0`: `Peak`, `1`: `RMS`, `2`: `LPF`, `3`: `SMA`.
- **multiband_compressor** | `band4SidechainMode` (Enum) - Default: `1` - Mode of sidechain for Band 4. Choices: `0`: `Peak`, `1`: `RMS`, `2`: `LPF`, `3`: `SMA`.
- **multiband_compressor** | `band5SidechainMode` (Enum) - Default: `1` - Mode of sidechain for Band 5. Choices: `0`: `Peak`, `1`: `RMS`, `2`: `LPF`, `3`: `SMA`.
- **multiband_compressor** | `band6SidechainMode` (Enum) - Default: `1` - Mode of sidechain for Band 6. Choices: `0`: `Peak`, `1`: `RMS`, `2`: `LPF`, `3`: `SMA`.
- **multiband_compressor** | `band7SidechainMode` (Enum) - Default: `1` - Mode of sidechain for Band 7. Choices: `0`: `Peak`, `1`: `RMS`, `2`: `LPF`, `3`: `SMA`.

#### Sidechain Source
- **multiband_compressor** | `band0SidechainSource` (Enum) - Default: `0` - Source for sidechain in Band 0. Choices: `0`: `Middle`, `1`: `Side`, `2`: `Left`, `3`: `Right`, `4`: `Min`, `5`: `Max`.
- **multiband_compressor** | `band1SidechainSource` (Enum) - Default: `0` - Source for sidechain in Band 1. Choices: `0`: `Middle`, `1`: `Side`, `2`: `Left`, `3`: `Right`, `4`: `Min`, `5`: `Max`.
- **multiband_compressor** | `band2SidechainSource` (Enum) - Default: `0` - Source for sidechain in Band 2. Choices: `0`: `Middle`, `1`: `Side`, `2`: `Left`, `3`: `Right`, `4`: `Min`, `5`: `Max`.
- **multiband_compressor** | `band3SidechainSource` (Enum) - Default: `0` - Source for sidechain in Band 3. Choices: `0`: `Middle`, `1`: `Side`, `2`: `Left`, `3`: `Right`, `4`: `Min`, `5`: `Max`.
- **multiband_compressor** | `band4SidechainSource` (Enum) - Default: `0` - Source for sidechain in Band 4. Choices: `0`: `Middle`, `1`: `Side`, `2`: `Left`, `3`: `Right`, `4`: `Min`, `5`: `Max`.
- **multiband_compressor** | `band5SidechainSource` (Enum) - Default: `0` - Source for sidechain in Band 5. Choices: `0`: `Middle`, `1`: `Side`, `2`: `Left`, `3`: `Right`, `4`: `Min`, `5`: `Max`.
- **multiband_compressor** | `band6SidechainSource` (Enum) - Default: `0` - Source for sidechain in Band 6. Choices: `0`: `Middle`, `1`: `Side`, `2`: `Left`, `3`: `Right`, `4`: `Min`, `5`: `Max`.
- **multiband_compressor** | `band7SidechainSource` (Enum) - Default: `0` - Source for sidechain in Band 7. Choices: `0`: `Middle`, `1`: `Side`, `2`: `Left`, `3`: `Right`, `4`: `Min`, `5`: `Max`.

#### Stereo Split Source
- **multiband_compressor** | `band0StereoSplitSource` (Enum) - Default: `0` - Stereo split source for Band 0. Choices: `0`: `Left/Right`, `1`: `Right/Left`, `2`: `Mid/Side`, `3`: `Side/Mid`, `4`: `Min`, `5`: `Max`.
- **multiband_compressor** | `band1StereoSplitSource` (Enum) - Default: `0` - Stereo split source for Band 1. Choices: `0`: `Left/Right`, `1`: `Right/Left`, `2`: `Mid/Side`, `3`: `Side/Mid`, `4`: `Min`, `5`: `Max`.
- **multiband_compressor** | `band2StereoSplitSource` (Enum) - Default: `0` - Stereo split source for Band 2. Choices: `0`: `Left/Right`, `1`: `Right/Left`, `2`: `Mid/Side`, `3`: `Side/Mid`, `4`: `Min`, `5`: `Max`.

### Request Example
```json
{
  "multiband_compressor": {
    "inputToSidechain": -40.0,
    "band1Enable": true,
    "band1SplitFrequency": 600,
    "band1SidechainType": 1,
    "band1SidechainMode": 0,
    "band1SidechainSource": 2,
    "band1StereoSplitSource": 2
  }
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of the operation.
- **message** (String) - Provides details about the operation.

#### Response Example
```json
{
  "status": "success",
  "message": "Multiband compressor settings updated successfully."
}
```
```

--------------------------------

### Exciter Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Endpoints for managing the exciter module settings.

```APIDOC
## GET /exciter

### Description
Retrieves the current configuration for the exciter module.

### Method
GET

### Endpoint
/exciter

### Response
#### Success Response (200)
- **bypass** (Bool) - Bypass status
- **inputGain** (Double) - Input gain
- **outputGain** (Double) - Output gain
- **amount** (Double) - Exciter amount
- **harmonics** (Double) - Harmonics level
- **scope** (Double) - Scope frequency
- **ceil** (Double) - Ceiling frequency
- **blend** (Double) - Blend level
- **ceilActive** (Bool) - Ceiling active status
- **listen** (Bool) - Listen mode status
```

--------------------------------

### Gate Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Configuration options for the Gate audio effect.

```APIDOC
## Gate Configuration

### Description
Configures the parameters for the Gate audio effect, controlling noise reduction and signal gating.

### Parameters
#### Request Body
- **sidechainMode** (Enum) - Optional - Controls the sidechain mode. Choices: `Internal`, `External`, `Link`.
- **stereoSplit** (Bool) - Optional - Enables stereo splitting for the sidechain.
- **sidechainSource** (Enum) - Optional - Specifies the source for the sidechain. Choices: `Middle`, `Side`, `Left`, `Right`, `Min`, `Max`.
- **stereoSplitSource** (Enum) - Optional - Defines the source for stereo splitting. Choices: `Left/Right`, `Right/Left`, `Mid/Side`, `Side/Mid`, `Min`, `Max`.
- **sidechainPreamp** (Double) - Optional - Adjusts the preamp gain for the sidechain.
- **sidechainReactivity** (Double) - Optional - Sets the reactivity of the sidechain.
- **sidechainLookahead** (Double) - Optional - Configures the lookahead time for the sidechain.
- **hpfMode** (Enum) - Optional - Sets the High-Pass Filter mode. Choices: `Off`, `12 dB/oct`, `24 dB/oct`, `36 dB/oct`.
- **hpfFrequency** (Double) - Optional - Sets the High-Pass Filter frequency.
- **lpfMode** (Enum) - Optional - Sets the Low-Pass Filter mode. Choices: `Off`, `12 dB/oct`, `24 dB/oct`, `36 dB/oct`.
- **lpfFrequency** (Double) - Optional - Sets the Low-Pass Filter frequency.
- **sidechainInputDevice** (String) - Optional - Specifies the input device for the sidechain.
- **inputToSidechain** (Double) - Optional - Gain adjustment from input to sidechain.
- **inputToLink** (Double) - Optional - Gain adjustment from input to link.
- **sidechainToInput** (Double) - Optional - Gain adjustment from sidechain to input.
- **sidechainToLink** (Double) - Optional - Gain adjustment from sidechain to link.
- **linkToSidechain** (Double) - Optional - Gain adjustment from link to sidechain.
- **linkToInput** (Double) - Optional - Gain adjustment from link to input.

### Response
#### Success Response (200)
- **gate** (Object) - Contains the gate configuration parameters.
```

--------------------------------

### Pitch Plugin Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Settings for the pitch shifting plugin, including gain, dry/wet mix, and pitch adjustment parameters.

```APIDOC
## Pitch Plugin Parameters

### Parameters
- **bypass** (Bool) - Default: false
- **inputGain** (Double) - Default: 0
- **outputGain** (Double) - Default: 0
- **dry** (Double) - Default: -100
- **wet** (Double) - Default: 0
- **cents** (Double) - Default: 0.0
- **semitones** (Double) - Default: 0.0
- **octaves** (Double) - Default: 0.0
- **quickSeek** (Bool) - Default: false
- **antiAlias** (Bool) - Default: false
- **sequenceLength** (Int) - Default: 40
- **seekWindow** (Int) - Default: 15
- **overlapLength** (Int) - Default: 8
- **tempoDifference** (Double) - Default: 0
- **rateDifference** (Double) - Default: 0
```

--------------------------------

### Gate Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Endpoints for managing the gate module settings.

```APIDOC
## GET /gate

### Description
Retrieves the current configuration for the gate module.

### Method
GET

### Endpoint
/gate

### Response
#### Success Response (200)
- **bypass** (Bool) - Bypass status
- **mode** (Enum) - 0: Downward, 1: Upward, 2: Boosting
- **attack** (Double) - Attack time
- **release** (Double) - Release time
- **reduction** (Double) - Reduction level
```

--------------------------------

### Loudness Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Configuration options for the Loudness audio effect.

```APIDOC
## Loudness Configuration

### Description
Configures the parameters for the Loudness audio effect, used for measuring and adjusting perceived loudness.

### Parameters
#### Request Body
- **bypass** (Bool) - Optional - Bypasses the loudness effect.
- **inputGain** (Double) - Optional - Adjusts the input gain.
- **outputGain** (Double) - Optional - Adjusts the output gain.
- **mode** (Enum) - Optional - Sets the loudness measurement mode. Choices: `FFT`, `IIR`.
- **fft** (Enum) - Optional - Sets the FFT size for loudness measurement. Choices: `256`, `512`, `1024`, `2048`, `4096`, `8192`, `16384`.
- **std** (Enum) - Optional - Sets the standard for loudness measurement. Choices: `Flat`, `ISO226-2003`, `Fletcher-Munson`, `Robinson-Dadson`, `ISO226-2023`.
- **volume** (Double) - Optional - Adjusts the perceived volume.
- **clipping** (Bool) - Optional - Enables clipping detection.
- **clippingRange** (Double) - Optional - Sets the range for clipping detection.
- **iirApproximation** (Enum) - Optional - Sets the IIR filter approximation quality. Choices: `Fastest`, `Low`, `Normal`, `High`, `Best`.

### Response
#### Success Response (200)
- **loudness** (Object) - Contains the loudness configuration parameters.
```

--------------------------------

### Multiband Gate Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Parameters for configuring the multiband gate module, including sidechain and split frequency settings.

```APIDOC
## Multiband Gate Parameters

### Description
Configuration settings for the multiband gate, including global settings, band enabling, and sidechain routing.

### Parameters
- **bypass** (Bool) - Bypass the gate module.
- **inputGain** (Double) - Input gain level.
- **outputGain** (Double) - Output gain level.
- **gateMode** (Enum) - 0: Classic, 1: Modern, 2: Linear Phase.
- **band[1-7]Enable** (Bool) - Enable or disable specific bands.
- **band[1-7]SplitFrequency** (Double) - Crossover frequency for the band.
- **band[0-7]SidechainType** (Enum) - 0: Internal, 1: External, 2: Link.
```

--------------------------------

### Maximizer Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Configuration options for the Maximizer audio effect.

```APIDOC
## Maximizer Configuration

### Description
Configures the parameters for the Maximizer audio effect, used to increase perceived loudness without introducing distortion.

### Parameters
#### Request Body
- **bypass** (Bool) - Optional - Bypasses the maximizer effect.
- **inputGain** (Double) - Optional - Adjusts the input gain.
- **outputGain** (Double) - Optional - Adjusts the output gain.
- **release** (Double) - Optional - Sets the release time.
- **threshold** (Double) - Optional - Sets the threshold level.

### Response
#### Success Response (200)
- **maximizer** (Object) - Contains the maximizer configuration parameters.
```

--------------------------------

### Multiband Compressor Configuration

Source: https://wwmm.github.io/easyeffects/database/plugins_properties.html

Configuration parameters for the multiband compressor bands.

```APIDOC
## Multiband Compressor Configuration

### Description
Settings for controlling stereo split sources, sidechain behavior, and custom filters for specific frequency bands (0-7).

### Parameters
#### Request Body
- **band[n]StereoSplitSource** (Enum) - 0: Left/Right, 1: Right/Left, 2: Mid/Side, 3: Side/Mid, 4: Min, 5: Max
- **band[n]SidechainLookahead** (Double) - Lookahead time for sidechain processing
- **band[n]SidechainReactivity** (Double) - Reactivity setting for sidechain
- **band[n]SidechainPreamp** (Double) - Preamp gain for sidechain
- **band[n]SidechainCustomLowcutFilter** (Bool) - Enable/disable custom lowcut filter
- **band[n]SidechainCustomHighcutFilter** (Bool) - Enable/disable custom highcut filter
- **band[n]SidechainLowcutFrequency** (Double) - Frequency for lowcut filter
- **band[n]SidechainHighcutFrequency** (Double) - Frequency for highcut filter
```
Tokens:
Raw