LavaShark

Table of contents

Constructors

• constructor

Properties

• clientId
• nodes
• on
• once
• players
• sendWS
• unresolvedSearchSource
• useISRC

Methods

• addExternalSource
• bestNode
• createPlayer
• decodeTrack
• decodeTracks
• getPlayer
• handleVoiceUpdate
• nodePing
• nodesPing
• search
• start
• checkOptions

Constructors

constructor

• new LavaShark(options)

創建一個 LavaShark 實例

Parameters

Name	Type	Description
options	LavaSharkOptions	LavaShark 選項

Returns

LavaShark

Overrides

EventEmitter.constructor

Defined in

lib/LavaShark.ts:109

Properties

clientId

• clientId: string

Defined in

lib/LavaShark.ts:28

---

nodes

• nodes: Node[]

Defined in

lib/LavaShark.ts:29

---

players

• players: Map<string, Player>

<guildId, Player>

Defined in

lib/LavaShark.ts:30

---

sendWS

• Readonly sendWS: (guildId: string, payload: OutgoingDiscordPayload) => void

範例

sendWS: (guildId, payload) => {
    client.guilds.cache.get(guildId)?.shard.send(payload); 
}

Type declaration

▸ (guildId, payload): void

Parameters

Name	Type	Description
guildId	string	guildId
payload	OutgoingDiscordPayload	payload

Returns

void

Defined in

lib/LavaShark.ts:51

---

unresolvedSearchSource

• Readonly unresolvedSearchSource: SEARCH_SOURCE

Defined in

lib/LavaShark.ts:37

---

useISRC

• Readonly useISRC: boolean

Defined in

lib/LavaShark.ts:38

Methods

addExternalSource

▸ addExternalSource(extSource): void

添加一個外部來源，生成帶有 UnresolvedTracks 的 SearchResult

Parameters

Name	Type	Description
extSource	AbstractExternalSource	外部來源

Returns

void

Defined in

lib/LavaShark.ts:198

---

bestNode

▸ bestNode(): Promise<Node>

取得最佳可用節點

Returns

Promise<Node>

Defined in

lib/LavaShark.ts:163

---

createPlayer

▸ createPlayer(options): Player

創建一個新的 Player 或返回一個現有的 Player

Parameters

Name	Type	Description
options	PlayerOptions	The player options

Returns

Player

Defined in

lib/LavaShark.ts:283

---

decodeTrack

▸ decodeTrack(encoded): Promise<Track>

解碼以 base64 字串表示的音軌

Parameters

Name	Type	Description
encoded	string	該音軌的 base64 編碼

Returns

Promise<Track>

Defined in

lib/LavaShark.ts:211

---

decodeTracks

▸ decodeTracks(encodedTracks): Promise<Track[]>

解碼多個音軌的 base64 字串

Parameters

Name	Type	Description
encodedTracks	string[]	The base64 encoded tracks

Returns

Promise<Track[]>

Defined in

lib/LavaShark.ts:223

---

emit

▸ emit<EventName>(event, ...args): boolean

Type parameters

Name	Type
EventName	extends keyof LavaSharkEvents

Parameters

Name	Type
event	EventName
...args	Parameters<LavaSharkEvents[EventName]>

Returns

boolean

Overrides

EventEmitter.emit

Defined in

lib/LavaShark.ts:146

---

getPlayer

▸ getPlayer(guildId): null | Player

使用 guild ID 檢索現有的 Player

Parameters

Name	Type	Description
guildId	string	該 Player 所屬的 guild ID

Returns

null | Player

Defined in

lib/LavaShark.ts:301

---

handleVoiceUpdate

▸ handleVoiceUpdate(payload): void

Handles voice state & voice server update packets

Parameters

Name	Type	Description
payload	IncomingDiscordPayload	The voice packet

Returns

void

Defined in

lib/LavaShark.ts:404

---

nodePing

▸ nodePing(node, timeout?): Promise<number>

獲取單個節點的 ping 值

Parameters

Name	Type	Default value	Description
node	Node	undefined	要 ping 的節點
timeout	number	1500	超時值，以毫秒為單位

Returns

Promise<number>

• 節點的延遲，以毫秒為單位

Defined in

lib/LavaShark.ts:460

---

nodesPing

▸ nodesPing(timeout?): Promise<number[]>

獲取所有節點的 ping 值

Parameters

Name	Type	Default value	Description
timeout	number	1500	超時值，以毫秒為單位

Returns

Promise<number[]>

• 所有節點的延遲，以毫秒為單位

Defined in

lib/LavaShark.ts:473

---

on

▸ on<EventName>(event, listener): this

Type parameters

Name	Type
EventName	extends keyof LavaSharkEvents

Parameters

Name	Type
event	EventName
listener	LavaSharkEvents[EventName]

Returns

this

Overrides

EventEmitter.on

Defined in

lib/LavaShark.ts:150

---

once

▸ once<EventName>(event, listener): this

Type parameters

Name	Type
EventName	extends keyof LavaSharkEvents

Parameters

Name	Type
event	EventName
listener	LavaSharkEvents[EventName]

Returns

this

Overrides

EventEmitter.once

Defined in

lib/LavaShark.ts:154

---

search

▸ search(query, source?): Promise<SearchResult>

通過歌曲名稱進行搜索或使用歌曲連結

Parameters

Name	Type	Description
query	string	要搜索的內容
source?	SEARCH_SOURCE	搜尋來源

Returns

Promise<SearchResult>

Defined in

lib/LavaShark.ts:322

---

start

▸ start(clientId): void

連接到所有 Lavalink 節點

Parameters

Name	Type	Description
clientId	string	The client id (BOT)

Returns

void

Defined in

lib/LavaShark.ts:385

---

stopCheckNodeState

▸ stopCheckNodeState(nodeIdentifier): void

停止節點的自動重連檢查

Parameters

Name	Type	Description
nodeIdentifier	string	The identifier of the node

Returns

void

Defined in

lib/LavaShark.ts:262

---

checkOptions

▸ Static checkOptions(options): void

Parameters

Name	Type
options	LavaSharkOptions

Returns

void

Defined in

lib/LavaShark.ts:53