Filters

Table of contents

Constructors

• constructor

Accessors

• active
• enabled

Methods

• apply
• clear
• set
• setChannelMix
• setDistortion
• setEqualizer
• setKaraoke
• setLowPass
• setRotation
• setTimescale
• setTremolo
• setVibrato
• setVolume

Constructors

constructor

• new Filters(player)

創建一個 Filters 實例

Parameters

Name	Type
player	Player

Defined in

lib/Filters.ts:25

Accessors

active

• get active(): FilterOptions

獲取活動 Filters 物件的副本

Returns

FilterOptions

Defined in

lib/Filters.ts:36

---

enabled

• get enabled(): boolean

檢查某個 Filters 是否已啟用

Returns

boolean

Defined in

lib/Filters.ts:31

Methods

apply

▸ apply(): void

將 Filters 設置傳送到 Lavalink 節點

Returns

void

Defined in

lib/Filters.ts:245

---

clear

▸ clear(): void

清除所有活動的 Filters

Returns

void

Defined in

lib/Filters.ts:238

---

set

▸ set(filters): void

設置所有 Filters

Parameters

Name	Type
filters	FilterOptions

Returns

void

Defined in

lib/Filters.ts:224

---

setChannelMix

▸ setChannelMix(options, apply?): Filters

設置 ChannelMix Filter

Parameters

Name	Type	Default value	Description
options	null | ChannelMixOptions	undefined	channel mix 選項
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:50

---

setDistortion

▸ setDistortion(options, apply?): Filters

設置 Distortion Filter

Parameters

Name	Type	Default value	Description
options	null | DistortionOptions	undefined	distortion 選項
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:73

---

setEqualizer

▸ setEqualizer(options, apply?): Filters

設置 Equalizer Filter

Parameters

Name	Type	Default value	Description
options	null | number[]	undefined	等化器陣列
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:88

---

setKaraoke

▸ setKaraoke(options, apply?): Filters

設置 Karaoke Filter

Parameters

Name	Type	Default value	Description
options	null | KaraokeOptions	undefined	karaoke 選項
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:114

---

setLowPass

▸ setLowPass(options, apply?): Filters

設置 LowPass Filter

Parameters

Name	Type	Default value	Description
options	null | LowPassOptions	undefined	lowpass 選項
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:130

---

setRotation

▸ setRotation(options, apply?): Filters

設置 Rotation Filter

Parameters

Name	Type	Default value	Description
options	null | RotationOptions	undefined	rotation 選項
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:146

---

setTimescale

▸ setTimescale(options, apply?): Filters

設置 Timescale Filter

Parameters

Name	Type	Default value	Description
options	null | TimescaleOptions	undefined	timescale 選項
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:164

---

setTremolo

▸ setTremolo(options, apply?): Filters

設置 Tremolo filter

Parameters

Name	Type	Default value	Description
options	null | TremoloOptions	undefined	tremolo 選項
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:181

---

setVibrato

▸ setVibrato(options, apply?): Filters

設置 Vibrato filter

Parameters

Name	Type	Default value	Description
options	null | VibratoOptions	undefined	vibrato 選項
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:198

---

setVolume

▸ setVolume(vol, apply?): Filters

設置音量

Parameters

Name	Type	Default value	Description
vol	number	undefined	要設置的音量 [0,500]
apply	boolean	true	是否將 Filter 設置傳送到 Lavalink 節點

Returns

Filters

Filter 實例，用於鏈式呼叫

Defined in

lib/Filters.ts:213