andesitejs / Exports / api/PlayerManager / PlayerManager

Class: PlayerManager

api/PlayerManager.PlayerManager

Hierarchy

• EventEmitter

  ↳ PlayerManager

Table of contents

Constructors

• constructor

Properties

• #_nodes
• #_players
• eventBuffer
• nodes
• reconnectionDefaults
• send
• userId

Accessors

• ideal
• players

Methods

• createPlayer
• destroyPlayer
• emit
• init
• off
• on
• once
• serverUpdate
• stateUpdate

Constructors

constructor

+ new PlayerManager(options: PlayerManagerOptions): PlayerManager

Parameters:

Name	Type	Description
options	PlayerManagerOptions	The player manager options.

Returns: PlayerManager

Defined in: api/PlayerManager.ts:61

Properties

#_nodes

• Private Readonly #_nodes: NodeOptions & { id: string | number }[]

The configured nodes.

Defined in: api/PlayerManager.ts:61

---

#_players

• Private #_players: null | Map<string, Player>= null

The current player map.

Defined in: api/PlayerManager.ts:55

---

eventBuffer

• Optional eventBuffer: undefined | number

The default event buffer to use for all configured nodes.

Defined in: api/PlayerManager.ts:49

---

nodes

• Readonly nodes: Map<string | number, Node>

All connected nodes.

Defined in: api/PlayerManager.ts:29

---

reconnectionDefaults

• reconnectionDefaults: Required<ReconnectionOptions>

Default reconnection options.

Defined in: api/PlayerManager.ts:44

---

send

• Readonly send: SendMethod

The send method used for disconnecting/connecting from voice channels.

Defined in: api/PlayerManager.ts:34

---

userId

• userId: null | string= null

The configured user id.

Defined in: api/PlayerManager.ts:39

Accessors

ideal

• ideal(): Node[]

An array of ideal nodes, sorted by the amount of penalties one has.

Returns: Node[]

Defined in: api/PlayerManager.ts:89

---

players

• players(): Map<string, Player>

Every player spanning across each configured node..

Returns: Map<string, Player>

Defined in: api/PlayerManager.ts:96

Methods

createPlayer

▸ createPlayer(guildId: string, options?: CreatePlayerOptions): Player

Creates a new player.

Parameters:

Name	Type	Default value	Description
guildId	string	-	The guild id.
options	CreatePlayerOptions	...	The transport and node to use.

Returns: Player

The created player.

Defined in: api/PlayerManager.ts:139

---

destroyPlayer

▸ destroyPlayer(guildId: string): Promise<boolean>

Destroys a player.

Parameters:

Name	Type	Description
guildId	string	The Guild ID of the player to destroy.

Returns: Promise<boolean>

Whether the player was destroyed.

Defined in: api/PlayerManager.ts:159

---

emit

▸ emit<E>(event: E, ...args: PlayerManagerEvents[E]): boolean

Type parameters:

Name	Type
E	ManagerEvent

Parameters:

Name	Type
event	E
...args	PlayerManagerEvents[E]

Returns: boolean

Defined in: api/PlayerManager.ts:201

---

init

▸ init(userId?: null | string): Promise<void>

Initializes every configured node.

Parameters:

Name	Type	Default value	Description
userId	null | string	...	The user id to use.

Returns: Promise<void>

Defined in: api/PlayerManager.ts:113

---

off

▸ off<E>(event: E, listener: (...args: PlayerManagerEvents[E]) => void): PlayerManager

Type parameters:

Name	Type
E	ManagerEvent

Parameters:

Name	Type
event	E
listener	(...args: PlayerManagerEvents[E]) => void

Returns: PlayerManager

Defined in: api/PlayerManager.ts:199

---

on

▸ on<E>(event: E, listener: (...args: PlayerManagerEvents[E]) => void): PlayerManager

Type parameters:

Name	Type
E	ManagerEvent

Parameters:

Name	Type
event	E
listener	(...args: PlayerManagerEvents[E]) => void

Returns: PlayerManager

Defined in: api/PlayerManager.ts:195

---

once

▸ once<E>(event: E, listener: (...args: PlayerManagerEvents[E]) => void): PlayerManager

Type parameters:

Name	Type
E	ManagerEvent

Parameters:

Name	Type
event	E
listener	(...args: PlayerManagerEvents[E]) => void

Returns: PlayerManager

Defined in: api/PlayerManager.ts:197

---

serverUpdate

▸ serverUpdate(update: DiscordVoiceServer): Promise<void>

Used for providing voice server updates to lavalink.

Parameters:

Name	Type	Description
update	DiscordVoiceServer	The voice server update sent by Discord.

Returns: Promise<void>

Defined in: api/PlayerManager.ts:168

---

stateUpdate

▸ stateUpdate(update: DiscordVoiceState): Promise<void>

Used for providing voice state updates to lavalink

Parameters:

Name	Type	Description
update	DiscordVoiceState	The voice state update sent by Discord.

Returns: Promise<void>

Defined in: api/PlayerManager.ts:181