Class FilterManager<PluginFilters>

Utility class for managing filters

Type Parameters

PluginFilters extends JsonObject = CommonPluginFilters

Index

Constructors

Methods

get set has remove clear merge override

Constructors

constructor

new FilterManager<PluginFilters extends JsonObject = CommonPluginFilters>(
player: Player,
guildId: string,
): FilterManager<PluginFilters>
Type Parameters
- PluginFilters extends JsonObject = CommonPluginFilters
Parameters
- player: Player
- guildId: string
Returns FilterManager<PluginFilters>
- Defined in Queue/FilterManager.ts:13

Methods

get

get<Name extends string | number | symbol>(
name: Name,
): FilterValue<Name, PluginFilters> | null
Get the value of a filter
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
  Name of the filter
Returns FilterValue<Name, PluginFilters> | null
- Defined in Queue/FilterManager.ts:30

set

set<
    Name extends string
    | number
    | symbol,
    Value extends

            | JsonLike
            | CommonPluginFilters
            | EqualizerFilter
            | KaraokeFilter
            | TimescaleFilter
            | TremoloFilter
            | VibratoFilter
            | RotationFilter
            | DistortionFilter
            | ChannelMixFilter
            | LowPassFilter,
>(
    name: Name,
    value: Value,
    isPlugin?: boolean,
): Promise<FilterValue<Name, PluginFilters> | null>
Set the value of a filter
Type Parameters
- Name extends string | number | symbol
- Value extends
      | JsonLike
      | CommonPluginFilters
      | EqualizerFilter
      | KaraokeFilter
      | TimescaleFilter
      | TremoloFilter
      | VibratoFilter
      | RotationFilter
      | DistortionFilter
      | ChannelMixFilter
      | LowPassFilter
Parameters
- name: Name
  Name of the filter
- value: Value
  Value for the filter
- isPlugin: boolean = false
  Whether the filter comes from a plugin
Returns Promise<FilterValue<Name, PluginFilters> | null>
- Defined in Queue/FilterManager.ts:42

has

has<Name extends string | number | symbol>(name: Name): boolean
Check if a filter is active
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
  Name of the filter
Returns boolean
- Defined in Queue/FilterManager.ts:61

remove

remove<Name extends string | number | symbol>(
...names: Name[],
): Promise<Filters<PluginFilters>>
Remove filter(s)
Type Parameters
- Name extends string | number | symbol
Parameters
- ...names: Name[]
  Name(s) of filter(s) to remove
Returns Promise<Filters<PluginFilters>>
- Defined in Queue/FilterManager.ts:72

clear

clear(type?: "plugin" | "native"): Promise<Filters<PluginFilters>>
Clear filters by type (all if none specified)
Parameters
- Optionaltype: "plugin" | "native"
  Type of filters to clear (native for built-in, plugin for plugins)
Returns Promise<Filters<PluginFilters>>
- Defined in Queue/FilterManager.ts:88

merge

merge(filters: Filters<PluginFilters>): Promise<Filters<PluginFilters>>
Shallow merge an object of filters
Parameters
- filters: Filters<PluginFilters>
  Object of filters
Returns Promise<Filters<PluginFilters>>
- Defined in Queue/FilterManager.ts:100

override

override(filters: Filters<PluginFilters>): Promise<Filters<PluginFilters>>
Set an object of filters
Parameters
- filters: Filters<PluginFilters>
  Object of filters
Returns Promise<Filters<PluginFilters>>
- Defined in Queue/FilterManager.ts:108