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)

Create a new LavaShark instance

Parameters

Name	Type	Description
options	LavaSharkOptions	The LavaShark options

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

Example

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

Adds an external source that produces a SearchResult with UnresolvedTracks

Parameters

Name	Type	Description
extSource	AbstractExternalSource	The external source

Returns

void

Defined in

lib/LavaShark.ts:198

---

bestNode

▸ bestNode(): Promise<Node>

Get the best available node

Returns

Promise<Node>

Defined in

lib/LavaShark.ts:163

---

createPlayer

▸ createPlayer(options): Player

Creates a new player or returns an existing one

Parameters

Name	Type	Description
options	PlayerOptions	The player options

Returns

Player

Defined in

lib/LavaShark.ts:269

---

decodeTrack

▸ decodeTrack(encoded): Promise<Track>

Decodes a track by its base64 string

Parameters

Name	Type	Description
encoded	string	The base64 encoded track

Returns

Promise<Track>

Defined in

lib/LavaShark.ts:211

---

decodeTracks

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

Decodes multiple tracks by their base64 string

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

Retrieve an existing player using the guild id

Parameters

Name	Type	Description
guildId	string	The guild id that player belongs to

Returns

null | Player

Defined in

lib/LavaShark.ts:287

---

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:390

---

nodePing

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

Get the ping for a single node

Parameters

Name	Type	Default value	Description
node	Node	undefined	The node to ping
timeout	number	1500	Timeout value in milliseconds

Returns

Promise<number>

• Node latency, in milliseconds

Defined in

lib/LavaShark.ts:446

---

nodesPing

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

Get the ping for all nodes

Parameters

Name	Type	Default value	Description
timeout	number	1500	Timeout value in milliseconds

Returns

Promise<number[]>

• All node latency, in milliseconds

Defined in

lib/LavaShark.ts:459

---

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>

Search by song name or use music URL

Parameters

Name	Type	Description
query	string	The query to search for
source?	SEARCH_SOURCE	The search source

Returns

Promise<SearchResult>

Defined in

lib/LavaShark.ts:308

---

start

▸ start(clientId): void

Connects to all lavalink nodes

Parameters

Name	Type	Description
clientId	string	The client id (BOT)

Returns

void

Defined in

lib/LavaShark.ts:371

---

checkOptions

▸ Static checkOptions(options): void

Parameters

Name	Type
options	LavaSharkOptions

Returns

void

Defined in

lib/LavaShark.ts:53