FilterManager

Constructors

Constructor

new FilterManager(player: Player): FilterManager;

Defined in: src/audio/Filters.ts:132

Parameters

Parameter	Type
`player`	`Player`

Returns

FilterManager

Properties

Property (defined in)	Type	Default value
`data` (src/audio/Filters.ts:126)	`FilterData`	`undefined`
`equalizerBands` (src/audio/Filters.ts:92)	`EQBand`[]	`[]`
`filters` (src/audio/Filters.ts:96)	`PlayerFilters`	`undefined`
`filterUpdatedState` (src/audio/Filters.ts:94)	`boolean`	`false`
`EQList` (src/audio/Filters.ts:90)	`object`	`EQList`
`EQList.BassBoost` (src/config/Constants.ts:326)	`EQBand`[]	`undefined`
`EQList.BassboostEarrape` (src/config/Constants.ts:128)	`EQBand`[]	`undefined`
`EQList.BassboostHigh` (src/config/Constants.ts:146)	`EQBand`[]	`undefined`
`EQList.BassboostLow` (src/config/Constants.ts:182)	`EQBand`[]	`undefined`
`EQList.BassboostMedium` (src/config/Constants.ts:164)	`EQBand`[]	`undefined`
`EQList.BetterMusic` (src/config/Constants.ts:200)	`EQBand`[]	`undefined`
`EQList.Classic` (src/config/Constants.ts:236)	`EQBand`[]	`undefined`
`EQList.Electronic` (src/config/Constants.ts:272)	`EQBand`[]	`undefined`
`EQList.FullSound` (src/config/Constants.ts:290)	`EQBand`[]	`undefined`
`EQList.Gaming` (src/config/Constants.ts:308)	`EQBand`[]	`undefined`
`EQList.Lofi` (src/config/Constants.ts:398)	`EQBand`[]	`undefined`
`EQList.Pop` (src/config/Constants.ts:254)	`EQBand`[]	`undefined`
`EQList.Radio` (src/config/Constants.ts:380)	`EQBand`[]	`undefined`
`EQList.Rock` (src/config/Constants.ts:218)	`EQBand`[]	`undefined`
`EQList.Soft` (src/config/Constants.ts:344)	`EQBand`[]	`undefined`
`EQList.TrebleBass` (src/config/Constants.ts:416)	`EQBand`[]	`undefined`
`EQList.TV` (src/config/Constants.ts:362)	`EQBand`[]	`undefined`

Accessors

player

Get Signature

get player(): Player;

Defined in: src/audio/Filters.ts:128

Returns

Player

Methods

applyPlayerFilters()

applyPlayerFilters(): Promise<void>;

Defined in: src/audio/Filters.ts:176

Returns

Promise<void>

checkFiltersState()

checkFiltersState(): boolean;

Defined in: src/audio/Filters.ts:206

Returns

boolean

clear()

clear(): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:230

Returns

Promise<FilterManager>

get()

get<T>(name: T): AudioFilters[T];

Defined in: src/audio/Filters.ts:139

Get a filter value

Type Parameters

Type Parameter
`T` extends keyof `AudioFilters`

Parameters

Parameter	Type
`name`	`T`

Returns

AudioFilters[T]

override()

override(filters: AudioFilters): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:170

Override all filters

Parameters

Parameter	Type
`filters`	`AudioFilters`

Returns

Promise<FilterManager>

remove()

remove(name: string): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:160

Remove a filter

Parameters

Parameter	Type
`name`	`string`

Returns

Promise<FilterManager>

resetFilters()

resetFilters(): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:223

Returns

Promise<FilterManager>

set()

set<T>(
   name: T,
   value: FilterData[T],
isPlugin?: boolean): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:146

Set a filter directly (hardcore mode)

Type Parameters

Type Parameter
`T` extends keyof `FilterData`

Parameters

Parameter	Type	Default value
`name`	`T`	`undefined`
`value`	`FilterData`[`T`]	`undefined`
`isPlugin`	`boolean`	`false`

Returns

Promise<FilterManager>

setEQ()

setEQ(bands: EQBand[]): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:281

Parameters

Parameter	Type
`bands`	`EQBand`[]

Returns

Promise<FilterManager>

setPitch()

setPitch(pitch?: number): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:249

Parameters

Parameter	Type	Default value
`pitch`	`number`	`1`

Returns

Promise<FilterManager>

setPreset()

setPreset(preset:
  | "BassboostEarrape"
  | "BassboostHigh"
  | "BassboostMedium"
  | "BassboostLow"
  | "BetterMusic"
  | "Rock"
  | "Classic"
  | "Pop"
  | "Electronic"
  | "FullSound"
  | "Gaming"
  | "BassBoost"
  | "Soft"
  | "TV"
  | "Radio"
  | "Lofi"
  | "TrebleBass"
  | "Vaporwave"
  | "Nightcore"
| "Clear"): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:287

Parameters

Parameter	Type
`preset`	\| `"BassboostEarrape"` \| `"BassboostHigh"` \| `"BassboostMedium"` \| `"BassboostLow"` \| `"BetterMusic"` \| `"Rock"` \| `"Classic"` \| `"Pop"` \| `"Electronic"` \| `"FullSound"` \| `"Gaming"` \| `"BassBoost"` \| `"Soft"` \| `"TV"` \| `"Radio"` \| `"Lofi"` \| `"TrebleBass"` \| `"Vaporwave"` \| `"Nightcore"` \| `"Clear"`

Returns

Promise<FilterManager>

setSpeed()

setSpeed(speed?: number): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:243

Parameters

Parameter	Type	Default value
`speed`	`number`	`1`

Returns

Promise<FilterManager>

setVolume()

setVolume(volume: number): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:236

Parameters

Parameter	Type
`volume`	`number`

Returns

Promise<FilterManager>

toggleNightcore()

toggleNightcore(): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:255

Returns

Promise<FilterManager>

toggleVaporwave()

toggleVaporwave(): Promise<FilterManager>;

Defined in: src/audio/Filters.ts:267

Returns

Promise<FilterManager>