Skip to main content
Version: 2.0.0

FiltersOptions

ruvyrias


ruvyrias / FiltersOptions

Interface: FiltersOptions

Defined in: types/Filters.ts:114

Represents the options for applying various filters to the currently player

Properties

_8d?

optional _8d: null | boolean

Defined in: types/Filters.ts:148

Whether to apply 8D effect.


bassBoost?

optional bassBoost: number

Defined in: types/Filters.ts:136

The bass boost level.


channelMix?

optional channelMix: null | ChannelMixOptions

Defined in: types/Filters.ts:130

The channel mix of the filters effect to apply.


chipmunk?

optional chipmunk: null | boolean

Defined in: types/Filters.ts:146

Whether to apply chipmunk effect.


daycore?

optional daycore: null | boolean

Defined in: types/Filters.ts:142

Whether to apply daycore effect.


distortion?

optional distortion: null | DistortionOptions

Defined in: types/Filters.ts:128

The distortion of the filters effect to apply.


equalizer?

optional equalizer: null | Band[]

Defined in: types/Filters.ts:118

The equalizer of the filters effect to apply.


karaoke?

optional karaoke: null | KaraokeOptions

Defined in: types/Filters.ts:120

The karaoke of the filters effect to apply.


lowPass?

optional lowPass: null | LowPassOptions

Defined in: types/Filters.ts:132

The low-pass filter options to apply.


nightcore?

optional nightcore: null | boolean

Defined in: types/Filters.ts:140

Whether to apply nightcore effect.


rotation?

optional rotation: null | RotationOptions

Defined in: types/Filters.ts:126

The rotation of the filters effect to apply.


slowMode?

optional slowMode: null | boolean

Defined in: types/Filters.ts:138

Whether to apply slow mode.


timescale?

optional timescale: null | TimescaleOptions

Defined in: types/Filters.ts:134

The time-scale options to apply.


tremolo?

optional tremolo: null | TremoloOptions

Defined in: types/Filters.ts:122

The tremolo of the filters effect to apply.


vaporwave?

optional vaporwave: null | boolean

Defined in: types/Filters.ts:144

Whether to apply vaporwave effect.


vibrato?

optional vibrato: null | VibratoOptions

Defined in: types/Filters.ts:124

The vibrato of the filters effect to apply.


volume?

optional volume: number

Defined in: types/Filters.ts:116

The volume of the filters effect to apply.