LithiumX

Appearance

LithiumX v1.0.8

LithiumX / LithiumXManager

Class: LithiumXManager ​

Defined in: src/Structures/Manager.ts:26

The main hub for interacting with Lavalink and using Magmastream,

Extends ​

Constructors ​

new LithiumXManager() ​

new LithiumXManager(options): LithiumXManager

Defined in: src/Structures/Manager.ts:95

Initiates the Manager class.

Parameters ​

options ​

ManagerOptions

Returns ​

LithiumXManager

Overrides ​

TypedEmitter<ManagerEvents>.constructor

Properties ​

caches ​

caches: Collection<string, SearchResult>

Defined in: src/Structures/Manager.ts:46

nodes ​

readonly nodes: Collection<string, LithiumXNode>

Defined in: src/Structures/Manager.ts:42

The map of nodes.

options ​

readonly options: ManagerOptions

Defined in: src/Structures/Manager.ts:44

The options that were set.

players ​

readonly players: Collection<string, LithiumXPlayer>

Defined in: src/Structures/Manager.ts:40

The map of players.

DEFAULT_SOURCES ​

readonly static DEFAULT_SOURCES: Record<SearchPlatform, string>

Defined in: src/Structures/Manager.ts:27

Accessors ​

leastLoadNode ​

Get Signature ​

get leastLoadNode(): Collection<string, LithiumXNode>

Defined in: src/Structures/Manager.ts:49

Returns the nodes that has the least load.

Returns ​

Collection<string, LithiumXNode>

useableNodes ​

Get Signature ​

get useableNodes(): LithiumXNode

Defined in: src/Structures/Manager.ts:87

Returns the node to use.

Returns ​

LithiumXNode

Methods ​

create() ​

create(options): LithiumXPlayer

Defined in: src/Structures/Manager.ts:292

Creates a player or returns one if it already exists.

Parameters ​

options ​

PlayerOptions

Returns ​

LithiumXPlayer

createNode() ​

createNode(options): LithiumXNode

Defined in: src/Structures/Manager.ts:320

Creates a node or returns one if it already exists.

Parameters ​

options ​

NodeOptions

Returns ​

LithiumXNode

decodeTrack() ​

decodeTrack(track): Promise<TrackData>

Defined in: src/Structures/Manager.ts:283

Decodes the base64 encoded track and returns a TrackData.

Parameters ​

track ​

string

Returns ​

Promise<TrackData>

decodeTracks() ​

decodeTracks(tracks): Promise<TrackData[]>

Defined in: src/Structures/Manager.ts:263

Decodes the base64 encoded tracks and returns a TrackData array.

Parameters ​

tracks ​

string[]

Returns ​

Promise<TrackData[]>

destroy() ​

destroy(guild): void

Defined in: src/Structures/Manager.ts:312

Destroys a player if it exists.

Parameters ​

guild ​

string

Returns ​

void

destroyNode() ​

destroyNode(identifier): void

Defined in: src/Structures/Manager.ts:332

Destroys a node if it exists.

Parameters ​

identifier ​

string

Returns ​

void

get() ​

get(guild): LithiumXPlayer

Defined in: src/Structures/Manager.ts:304

Returns a player or undefined if it does not exist.

Parameters ​

guild ​

string

Returns ​

LithiumXPlayer

init() ​

init(clientId?): this

Defined in: src/Structures/Manager.ts:151

Initiates the Manager.

Parameters ​

clientId? ​

string

Returns ​

this

search(query, requester?): Promise<SearchResult>

Defined in: src/Structures/Manager.ts:174

Searches the enabled sources based off the URL or the source property.

Parameters ​

query ​

string | SearchQuery

requester? ​

string

The user who requested the search.

Returns ​

Promise<SearchResult>

The search result.

updateVoiceState() ​

updateVoiceState(data): Promise<void>

Defined in: src/Structures/Manager.ts:343

Sends voice data to the Lavalink server.

Parameters ​

data ​

VoiceState | VoiceServer | VoicePacket

Returns ​

Promise<void>