https://github.com/devoxin/lavadspx-plugin

LavaDSPX filters for Lavalink in the form of a plugin.
https://github.com/devoxin/lavadspx-plugin

Last synced: 12 months ago
JSON representation

LavaDSPX filters for Lavalink in the form of a plugin.

• Host: GitHub
• URL: https://github.com/devoxin/lavadspx-plugin
• Owner: devoxin
• Created: 2023-10-19T16:42:34.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T13:14:41.000Z (about 2 years ago)
• Last Synced: 2024-05-12T06:41:10.271Z (about 2 years ago)
• Language: Java
• Size: 129 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# LavaDSPX-Plugin

A Lavalink plugin for enabling [LavaDSPX](https://github.com/devoxin/LavaDSPX) filters.

## How to use LavaDSPX-Plugin

```yml

lavalink:

  plugins:

    - dependency: com.github.Devoxin:LavaDSPX-Plugin:{VERSION} # replace {VERSION} with the latest version from the "Releases" tab.

      repository: https://jitpack.io

```

Once enabled, you can then send a [player update](https://lavalink.dev/api/rest#update-player) with the desired filters, e.g.

```js

{

  "filters": {

    "pluginFilters": {

      "high-pass": { // Cuts off frequencies lower than the specified {cutoffFrequency}.

        "cutoffFrequency": 80 // Integer, higher than 0, in Hz.

        "boostFactor": 1.0    // Float, higher than 0.0. This alters volume output. A value of 1.0 means no volume change.

      },

      "low-pass": { // Cuts off frequencies higher than the specified {cutoffFrequency}.

        "cutoffFrequency": 80 // Integer, higher than 0, in Hz.

        "boostFactor": 1.0    // Float, higher than 0.0. This alters volume output. A value of 1.0 means no volume change.

      },

      "normalization": { // Attenuates peaking where peaks are defined as having a higher value than {maxAmplitude}. 

        "maxAmplitude": 0.5 // Float, within the range of 0.0 - 1.0. A value of 0.0 mutes the output.

        "adaptive": true    // Boolean, whether peak amplitudes should persist. Refer to the note below for more information.

      },

      "echo": { // Self-explanatory; provides an echo effect.

        "echoLength": 0.3, // Float, higher than 0.0, in seconds (1.0 = 1 second).

        "decay": 0.5       // Float, within the range of 0.0 - 1.0. A value of 1.0 means no decay, and a value of 0.0 means

                           // immediate decay (no echo effect).

    }

  }

}

```

> [!NOTE]

> You can find out more about how the `NormalizationFilter`'s `adaptive` setting works [here](https://github.com/Devoxin/LavaDSPX/blob/main/src/main/java/me/devoxin/lavadspx/NormalizationFilter.java#L39-L43). 

## How to get help

Join the [Lavalink Discord Server](https://discord.gg/wYfsW4HNjb).