Manager

Table of Contents

• Class Definition
• Properties
• Constructor
• Methods

Class Definition

export class Manager extends EventEmitter {}

Properties

Property	Type	Description
initiated	boolean	Whether the manager has been initiated.
nodes	Collection<string, Node>	The nodes.
options	ManagerOptions	The manager options.
players	Collection<string, Player>>	The players.
redis?	RedisClient	The redis client.

Constructor

new Manager(options: ManagerOptions)

Parameter	Type	Description	Optional
options	ManagerOptions	The manager options.

Methods

cleanupInactivePlayer()

async cleanupInactivePlayer(guildId: string): Promise<void>

Cleans up an inactive player.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild id.

---

cleanupInactivePlayers()

async cleanupInactivePlayers(): Promise<void>

Cleans up inactive players.

---

create()

create(options: PlayerOptions): Player

Creates a player.

Parameters

Parameter	Type	Description	Optional
options	PlayerOptions	The player options.

Returns

Type	Description
Player	The new player.

---

createNode()

createNode(options: NodeOptions): Node

Creates a node.

Parameters

Parameter	Type	Description	Optional
options	NodeOptions	The node options.

Returns

Type	Description
Node	The new node.

---

decodeTrack()

async decodeTrack(track: string): Promise<TrackData>

Decodes a track.

Parameters

Parameter	Type	Description	Optional
track	string	The track.

Returns

Type	Description
Promise<TrackData>	The decoded track.

---

decodeTracks()

async decodeTracks(tracks: string[]): Promise<TrackData[]>

Decodes multiple tracks.

Parameters

Parameter	Type	Description	Optional
tracks	string[]	The tracks.

Returns

Type	Description
Promise<TrackData[]>	The decoded tracks.

---

destroy()

async destroy(guildId: string): Promise<void>

Destroys a player.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild id.

---

destroyNode()

async destroyNode(identifier: string): Promise<void>

Destroys a node.

Parameters

Parameter	Type	Description	Optional
identifier	string	The node identifier.

---

getPlayer()

getPlayer(guildId: string): Player | undefined

Gets a player.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild id.

Returns

Type	Description
Player | undefined	The player.

---

handleShutdown()

async handleShutdown(): Promise<void>

Handles the shutdown of the process by saving all active players' states and optionally cleaning up inactive players.

---

init()

async init(options: ManagerInitOptions = {}): Promise<this>

Initializes the manager.

Parameters

Parameter	Type	Description	Optional
options	ManagerInitOptions	The manager init options.

Returns

Type	Description
Promise<this>	The manager.

---

loadPlayerStates()

async loadPlayerStates(nodeId: string): Promise<void>

Loads the player states.

Parameters

Parameter	Type	Description	Optional
nodeId	string	The node id.

---

on()

on<T extends keyof ManagerEvents>(event: T, listener: (...args: ManagerEvents[T]) => void): this

Adds an event listener.

Parameters

Parameter	Type	Description	Optional
event	T extends keyof DebugEvent | LyricsEvent | NodeEvents | PlayerEvents | SponsorBlockEvents | TrackEvents | VoiceReceiverEvents	The event.
listener	(...args: any[]) => void	The listener.

---

savePlayerState()

async savePlayerState(guildId: string): Promise<void>

Saves the player state.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild id.

---

search()

async search<T = unknown>(query: string | SearchQuery, requester?: T): Promise<SearchResult>

Searches for tracks.

Parameters

Parameter	Type	Description	Optional
query	string | SearchQuery	The query.
requester	T = unknown	The requester.

---

send()

warning

⚠️ This method is protected and should not be called directly.

send(packet: GatewayVoiceStateUpdate): unknown

Sends a packet to the discord gateway.

Parameters

Parameter	Type	Description	Optional
packet	GatewayVoiceStateUpdate	The packet.

---

sendPacket()

sendPacket(packet: GatewayVoiceStateUpdate): unknown

Sends a packet to the discord gateway.

Parameters

Parameter	Type	Description	Optional
packet	GatewayVoiceStateUpdate	The packet.

---

resolveUser()

resolveUser(user: PortableUser | string): Promise<PortableUser>

Resolves a PortableUser or ID to a real user object. Can be overridden by wrapper managers to return wrapper-specific User classes.

Parameters

Parameter	Type	Description	Optional
user	PortableUser | string	The packet.

---

updateVoiceState()

async updateVoiceState(data: VoicePacket | VoiceServer | VoiceState): Promise<void>

Updates the voice state.

Parameters

Parameter	Type	Description	Optional
data	VoicePacket | VoiceServer | VoiceState	The data.

---

usableNode()

usableNode(): Node

Returns the node to use based on the configured useNode and enablePriorityMode options.

Returns

Type	Description
Node	The node to use.