LithiumX / Filters
Class: Filters
Defined in: src/Structures/Filters.ts:4
Constructors
new Filters()
new Filters(
player):Filters
Defined in: src/Structures/Filters.ts:18
Parameters
player
Returns
Filters
Properties
distortion
distortion:
DistortionOptions
Defined in: src/Structures/Filters.ts:5
equalizer
equalizer:
Band[]
Defined in: src/Structures/Filters.ts:6
karaoke
karaoke:
KaraokeOptions
Defined in: src/Structures/Filters.ts:7
player
player:
LithiumXPlayer
Defined in: src/Structures/Filters.ts:8
rotation
rotation:
RotationOptions
Defined in: src/Structures/Filters.ts:9
timescale
timescale:
TimescaleOptions
Defined in: src/Structures/Filters.ts:10
vibrato
vibrato:
VibratoOptions
Defined in: src/Structures/Filters.ts:11
volume
volume:
number
Defined in: src/Structures/Filters.ts:12
Methods
clearFilters()
clearFilters():
Promise<Filters>
Defined in: src/Structures/Filters.ts:282
Removes the audio effects and resets the filter status.
Returns
Promise<Filters>
distort()
distort():
this
Defined in: src/Structures/Filters.ts:85
Applies the distortion audio effect.
Returns
this
getFilterStatus()
getFilterStatus(
filter):boolean
Defined in: src/Structures/Filters.ts:309
Returns the status of the specified filter .
Parameters
filter
keyof AvailableFilters
Returns
boolean
setBassBoost()
setBassBoost(
status):this
Defined in: src/Structures/Filters.ts:212
Set the treble bass options
Parameters
status
boolean
The status to set.
Returns
this
setDistort()
setDistort(
status):this
Defined in: src/Structures/Filters.ts:221
Set the distort options
Parameters
status
boolean
The status to set.
Returns
this
setDistortion()
setDistortion(
distortion?):this
Defined in: src/Structures/Filters.ts:122
Applies the distortion options specified by the filter.
Parameters
distortion?
Returns
this
setEightD()
setEightD(
status):this
Defined in: src/Structures/Filters.ts:130
Set the 8D options
Parameters
status
boolean
The status to set.
Returns
this
setEqualizer()
setEqualizer(
bands?):this
Defined in: src/Structures/Filters.ts:80
Sets the equalizer bands and updates the filters.
Parameters
bands?
Band[]
The equalizer bands.
Returns
this
setFilter()
setFilter(
filter,status):Promise<Filters>
Defined in: src/Structures/Filters.ts:244
Set filter
Parameters
filter
string
status
boolean
Returns
Promise<Filters>
setKaraoke()
setKaraoke(
status,karaoke?):this
Defined in: src/Structures/Filters.ts:99
Applies the karaoke options specified by the filter.
Parameters
status
boolean
karaoke?
Returns
this
setNightcore()
setNightcore(
status):this
Defined in: src/Structures/Filters.ts:142
Set the nightcore options
Parameters
status
boolean
The status to set.
Returns
this
setRotation()
setRotation(
rotation?):this
Defined in: src/Structures/Filters.ts:117
Applies the rotation options specified by the filter.
Parameters
rotation?
Returns
this
setSlowmo()
setSlowmo(
status):this
Defined in: src/Structures/Filters.ts:158
Set the slowmo options
Parameters
status
boolean
The status to set.
Returns
this
setSoft()
setSoft(
status):this
Defined in: src/Structures/Filters.ts:174
Set the soft options
Parameters
status
boolean
The status to set.
Returns
this
setTimescale()
setTimescale(
timescale?):this
Defined in: src/Structures/Filters.ts:107
Applies the timescale options specified by the filter.
Parameters
timescale?
Returns
this
setTrebleBass()
setTrebleBass(
status):this
Defined in: src/Structures/Filters.ts:182
Set the treble bass options
Parameters
status
boolean
The status to set.
Returns
this
setTV()
setTV(
status):this
Defined in: src/Structures/Filters.ts:190
Set the TV options
Parameters
status
boolean
The status to set.
Returns
this
setVaporwave()
setVaporwave(
status):this
Defined in: src/Structures/Filters.ts:199
Set the vaporwave options
Parameters
status
boolean
The status to set.
Returns
this
setVibrato()
setVibrato(
vibrato?):this
Defined in: src/Structures/Filters.ts:112
Applies the vibrato options specified by the filter.
Parameters
vibrato?
Returns
this