Class FilterManager

Manages audio filters for a queue Handles native Lavalink filters and plugin filters

Constructors

constructor

Accessors

data volume equalizer karaoke timescale tremolo vibrato rotation

Methods

get set setVolume setEqualizer setKaraoke setTimescale setTremolo setVibrato setRotation clearEqualizer clearKaraoke clearTimescale clearTremolo clearVibrato clearRotation clearAll has delete clear apply setEQPreset getEQPresetNames isValidEQPreset

Constructors

constructor

Accessors

data

volume

equalizer

karaoke

  • get karaoke(): undefined | KaraokeFilter

  • Get karaoke filter

    Returns undefined | KaraokeFilter

timescale

  • get timescale(): undefined | TimescaleFilter

  • Get timescale filter

    Returns undefined | TimescaleFilter

tremolo

  • get tremolo(): undefined | TremoloFilter

  • Get tremolo filter

    Returns undefined | TremoloFilter

vibrato

  • get vibrato(): undefined | VibratoFilter

  • Get vibrato filter

    Returns undefined | VibratoFilter

rotation

  • get rotation(): undefined | RotationFilter

  • Get rotation filter

    Returns undefined | RotationFilter

Methods

get

  • get<K>(key): undefined | FilterData[K]

  • Get a specific filter

    Type Parameters

    • K extends keyof Filters<CommonPluginFilters>

    Parameters

    • key: K

    Returns undefined | FilterData[K]

set

  • set<K>(key, value): Promise<void>

  • Set a filter

    Type Parameters

    • K extends keyof Filters<CommonPluginFilters>

    Parameters

    • key: K
    • value: FilterData[K]

    Returns Promise<void>

setVolume

  • setVolume(volume): Promise<void>

  • Set volume

    Parameters

    • volume: number

    Returns Promise<void>

setEqualizer

  • setEqualizer(bands): Promise<void>

  • Set equalizer bands

    Parameters

    • bands: EqualizerBand[]

    Returns Promise<void>

setKaraoke

  • setKaraoke(karaoke): Promise<void>

  • Set karaoke filter

    Parameters

    • karaoke: KaraokeFilter

    Returns Promise<void>

setTimescale

  • setTimescale(timescale): Promise<void>

  • Set timescale filter

    Parameters

    • timescale: TimescaleFilter

    Returns Promise<void>

setTremolo

  • setTremolo(tremolo): Promise<void>

  • Set tremolo filter

    Parameters

    • tremolo: TremoloFilter

    Returns Promise<void>

setVibrato

  • setVibrato(vibrato): Promise<void>

  • Set vibrato filter

    Parameters

    • vibrato: VibratoFilter

    Returns Promise<void>

setRotation

  • setRotation(rotation): Promise<void>

  • Set rotation filter

    Parameters

    • rotation: RotationFilter

    Returns Promise<void>

clearEqualizer

clearKaraoke

clearTimescale

clearTremolo

clearVibrato

clearRotation

clearAll

has

  • has(key): boolean

  • Check if a filter is set

    Parameters

    • key: keyof Filters<CommonPluginFilters>

    Returns boolean

delete

  • delete(key): Promise<boolean>

  • Delete a specific filter

    Parameters

    • key: keyof Filters<CommonPluginFilters>

    Returns Promise<boolean>

clear

  • clear(type?): Promise<void>

  • Clear filters

    Parameters

    • Optional type: "plugin" | "native"

      "native" to clear only native filters, "plugin" to clear only plugin filters, undefined to clear all

    Returns Promise<void>

apply

  • apply(filters): Promise<void>

  • Apply multiple filters at once

    Parameters

    • filters: Partial<FilterData>

    Returns Promise<void>

setEQPreset

  • setEQPreset(preset): Promise<void>

  • Set an EQ preset by name

    Parameters

    • preset: "BassboostEarrape" | "BassboostHigh" | "BassboostMedium" | "BassboostLow" | "HighQuality" | "BetterMusic" | "Rock" | "Classic" | "Pop" | "Electronic" | "FullSound" | "Gaming" | "Nightcore" | "Vaporwave" | "TrebleBass" | "Soft" | "TV" | "Radio" | "Normalization"

      The preset name

    Returns Promise<void>

    Promise that resolves when the preset is applied

getEQPresetNames

  • getEQPresetNames(): ("BassboostEarrape" | "BassboostHigh" | "BassboostMedium" | "BassboostLow" | "HighQuality" | "BetterMusic" | "Rock" | "Classic" | "Pop" | "Electronic" | "FullSound" | "Gaming" | "Nightcore" | "Vaporwave" | "TrebleBass" | "Soft" | "TV" | "Radio" | "Normalization")[]

  • Get all available EQ preset names

    Returns ("BassboostEarrape" | "BassboostHigh" | "BassboostMedium" | "BassboostLow" | "HighQuality" | "BetterMusic" | "Rock" | "Classic" | "Pop" | "Electronic" | "FullSound" | "Gaming" | "Nightcore" | "Vaporwave" | "TrebleBass" | "Soft" | "TV" | "Radio" | "Normalization")[]

    Array of preset names

isValidEQPreset

  • isValidEQPreset(name): name is "BassboostEarrape" | "BassboostHigh" | "BassboostMedium" | "BassboostLow" | "HighQuality" | "BetterMusic" | "Rock" | "Classic" | "Pop" | "Electronic" | "FullSound" | "Gaming" | "Nightcore" | "Vaporwave" | "TrebleBass" | "Soft" | "TV" | "Radio" | "Normalization"

  • Check if a preset name is valid

    Parameters

    • name: string

      The preset name to check

    Returns name is "BassboostEarrape" | "BassboostHigh" | "BassboostMedium" | "BassboostLow" | "HighQuality" | "BetterMusic" | "Rock" | "Classic" | "Pop" | "Electronic" | "FullSound" | "Gaming" | "Nightcore" | "Vaporwave" | "TrebleBass" | "Soft" | "TV" | "Radio" | "Normalization"

    True if the preset exists

Settings

Member Visibility

Theme

On This Page

constructordatavolumeequalizerkaraoketimescaletremolovibratorotationgetsetsetVolumesetEqualizersetKaraokesetTimescalesetTremolosetVibratosetRotationclearEqualizerclearKaraokeclearTimescaleclearTremoloclearVibratoclearRotationclearAllhasdeleteclearapplysetEQPresetgetEQPresetNamesisValidEQPreset