Class FilterManager

Manage filters of a playing Queue

Hierarchy (view full)

BaseManager<Filter>
- FilterManager

Index

Constructors

Properties

collection distube queue

Accessors

client ffmpegArgs handler names options queues size values voices

Methods

#apply #removeFn #resolve add clear emit emitError has remove set toString

Constructors

constructor

new FilterManager(queue): FilterManager
Parameters
- queue: Queue
Returns FilterManager
Overrides BaseManager.constructor
- Defined in src/core/manager/FilterManager.ts:13

Properties

collection

collection: Collection<string, Filter> = ...

The collection of items for this manager.

distube

distube: DisTube

queue

queue: Queue

Collection of Filter.

Accessors

client

get client(): Client<boolean>
Discord.js client

Returns Client<boolean>
Inherited from BaseManager.client
- Defined in src/core/DisTubeBase.ts:48

ffmpegArgs

get ffmpegArgs(): FFmpegArgs
Returns FFmpegArgs
- Defined in src/core/manager/FilterManager.ts:118

handler

get handler(): DisTubeHandler
DisTube handler

Returns DisTubeHandler
Inherited from BaseManager.handler
- Defined in src/core/DisTubeBase.ts:60

names

get names(): string[]
Array of enabled filter names

Returns string[]
- Defined in src/core/manager/FilterManager.ts:107

options

get options(): Options
DisTube options

Returns Options
Inherited from BaseManager.options
- Defined in src/core/DisTubeBase.ts:54

queues

get queues(): QueueManager
The queue manager

Returns QueueManager
Inherited from BaseManager.queues
- Defined in src/core/DisTubeBase.ts:36

size

get size(): number
The size of the collection.

Returns number
Inherited from BaseManager.size
- Defined in src/core/manager/BaseManager.ts:17

values

get values(): Filter[]
Array of enabled filters

Returns Filter[]
- Defined in src/core/manager/FilterManager.ts:114

voices

get voices(): DisTubeVoiceManager
The voice manager

Returns DisTubeVoiceManager
Inherited from BaseManager.voices
- Defined in src/core/DisTubeBase.ts:42

Methods

`Private` #apply

#apply(): void
Returns void
- Defined in src/core/manager/FilterManager.ts:31

`Private` #removeFn

#removeFn(f): boolean
Parameters
- f: FilterResolvable
Returns boolean
- Defined in src/core/manager/FilterManager.ts:79

`Private` #resolve

#resolve(filter): Filter
Parameters
- filter: FilterResolvable
Returns Filter
- Defined in src/core/manager/FilterManager.ts:18

add

add(filterOrFilters, override?): FilterManager
Enable a filter or multiple filters to the manager
Parameters
- filterOrFilters: FilterResolvable | FilterResolvable[]
  The filter or filters to enable
- override: boolean = false
  Wether or not override the applied filter with new filter value
Returns FilterManager
- Defined in src/core/manager/FilterManager.ts:42

clear

clear(): FilterManager
Clear enabled filters of the manager

Returns FilterManager
- Defined in src/core/manager/FilterManager.ts:59

emit

emit(eventName, ...args): boolean
Emit the DisTube of this base
Parameters
- eventName: keyof DisTubeEvents
  Event name
- Rest ...args: any
  arguments
Returns boolean
Inherited from BaseManager.emit
- Defined in src/core/DisTubeBase.ts:21

emitError

emitError(error, channel?): void
Emit error event
Parameters
- error: Error
  error
- Optional channel: GuildTextBasedChannel
  Text channel where the error is encountered.
Returns void
Inherited from BaseManager.emitError
- Defined in src/core/DisTubeBase.ts:30

has

has(filter): boolean
Check whether a filter enabled or not
Parameters
- filter: FilterResolvable
  The filter to check
Returns boolean
- Defined in src/core/manager/FilterManager.ts:100

remove

remove(filterOrFilters): FilterManager
Disable a filter or multiple filters
Parameters
- filterOrFilters: FilterResolvable | FilterResolvable[]
  The filter or filters to disable
Returns FilterManager
- Defined in src/core/manager/FilterManager.ts:88

set

set(filters): FilterManager
Set the filters applied to the manager
Parameters
- filters: FilterResolvable[]
  The filters to apply
Returns FilterManager
- Defined in src/core/manager/FilterManager.ts:68

toString

toString(): string
Returns string
- Defined in src/core/manager/FilterManager.ts:122