andesitejs / Exports / api/player/Player / Player

Class: Player

api/player/Player.Player

Hierarchy

• EventEmitter

  ↳ Player

  ↳↳ RESTPlayer

  ↳↳ WebSocketPlayer

Table of contents

Constructors

• constructor

Properties

• #_server
• #_sessionId
• #node
• channelId
• connected
• guildId
• playing
• state
• timestamp
• track

Accessors

• filters
• manager
• node

Methods

• connect
• debug
• destroy
• disconnect
• emit
• fetchState
• handleEvent
• handleVoiceUpdate
• off
• on
• once
• playTrack
• resume
• seekTo
• sendVoiceServerUpdate
• setFilters
• setPaused
• setVolume
• stop
• update
• create

Constructors

constructor

+ new Player(node: Node, guildId: string): Player

Parameters:

Name	Type	Description
node	Node	The node instance.
guildId	string	The guild id instance.

Returns: Player

Defined in: api/player/Player.ts:76

Properties

#_server

• Private #_server: null | DiscordVoiceServer= null

The current voice server.

Defined in: api/player/Player.ts:70

---

#_sessionId

• Private #_sessionId: null | string= null

The session id to use for the VoiceServerUpdate method..

Defined in: api/player/Player.ts:64

---

#node

• Private Readonly #node: Node

The node this player is hosted on.

Defined in: api/player/Player.ts:76

---

channelId

• channelId: null | string

The ID of the channel this player is connected to.

Defined in: api/player/Player.ts:33

---

connected

• connected: boolean

Whether this player is connected to a voice channel or not.

Defined in: api/player/Player.ts:38

---

guildId

• Readonly guildId: string

The ID of the guild this player is for.

Defined in: api/player/Player.ts:28

---

playing

• playing: boolean

Whether this player is playing or not.

Defined in: api/player/Player.ts:48

---

state

• state: null | PlayerState

The state of this player.

Defined in: api/player/Player.ts:43

---

timestamp

• timestamp: null | number

The timestamp in which this player started playing.

Defined in: api/player/Player.ts:58

---

track

• track: null | string

The current track that is playing.

Defined in: api/player/Player.ts:53

Accessors

filters

• filters(): FilterChain

The current filters that are applied.

Returns: FilterChain

Defined in: api/player/Player.ts:125

---

manager

• manager(): PlayerManager

The player manager.

Returns: PlayerManager

Defined in: api/player/Player.ts:118

---

node

• node(): Node

The node this player is hosted on.

Returns: Node

Defined in: api/player/Player.ts:111

Methods

connect

▸ connect(channel: null | string | { id: string }, options?: ConnectOptions): Player

Connects this player to a voice channel.

Parameters:

Name	Type	Default value	Description
channel	null | string | { id: string }	-	A voice channel object or id.
options	ConnectOptions	...	Options for self deafening or muting.

Returns: Player

Defined in: api/player/Player.ts:158

---

debug

▸ Protecteddebug(message: string): void

Used for general debugging.

Parameters:

Name	Type	Description
message	string	The debug message.

Returns: void

Defined in: api/player/Player.ts:314

---

destroy

▸ Abstractdestroy(): Promise<Player>

Destroys this player.

Returns: Promise<Player>

Defined in: api/player/Player.ts:301

---

disconnect

▸ disconnect(): Player

Disconnects this player from the voice channel.

Returns: Player

Defined in: api/player/Player.ts:179

---

emit

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

Type parameters:

Name	Type
E	trackStart | trackStuck | trackEnd | trackException | webSocketClosed | move

Parameters:

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

Returns: boolean

Defined in: api/player/Player.ts:149

---

fetchState

▸ fetchState(): Promise<PlayerState>

Fetches the player state from the andesite instance.

Returns: Promise<PlayerState>

Defined in: api/player/Player.ts:186

---

handleEvent

▸ handleEvent(event: Event): Promise<boolean>

Handles an event sent by the andesite instance.

Parameters:

Name	Type	Description
event	Event	The received event

Returns: Promise<boolean>

Defined in: api/player/Player.ts:195

---

handleVoiceUpdate

▸ handleVoiceUpdate(update: DiscordVoiceServer | DiscordVoiceState): Promise<Player>

Handles a voice server or state update.

Parameters:

Name	Type	Description
update	DiscordVoiceServer | DiscordVoiceState	The voice server or state update.

Returns: Promise<Player>

Defined in: api/player/Player.ts:228

---

off

▸ off<E>(event: E, listener: (args: PlayerEvents[E]) => void): any

Type parameters:

Name	Type
E	trackStart | trackStuck | trackEnd | trackException | webSocketClosed | move

Parameters:

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

Returns: any

Defined in: api/player/Player.ts:143

---

on

▸ on<E>(event: E, listener: (args: PlayerEvents[E]) => void): Player

Type parameters:

Name	Type
E	trackStart | trackStuck | trackEnd | trackException | webSocketClosed | move

Parameters:

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

Returns: Player

Defined in: api/player/Player.ts:131

---

once

▸ once<E>(event: E, listener: (args: PlayerEvents[E]) => void): Player

Type parameters:

Name	Type
E	trackStart | trackStuck | trackEnd | trackException | webSocketClosed | move

Parameters:

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

Returns: Player

Defined in: api/player/Player.ts:137

---

playTrack

▸ AbstractplayTrack(track: string | { track: string }, options?: PlayOptions): Promise<Player>

Plays a track on the guild.

Parameters:

Name	Type	Description
track	string | { track: string }	Base64 encoded lavaplayer track. If null, the player is stopped. Only use null for mixer players, for regular players use stop instead.
options?	PlayOptions

Returns: Promise<Player>

Defined in: api/player/Player.ts:261

---

resume

▸ resume(): Promise<Player>

Resumes this player.

Returns: Promise<Player>

Defined in: api/player/Player.ts:251

---

seekTo

▸ AbstractseekTo(pos: number): Promise<Player>

Update the track position.

Parameters:

Name	Type	Description
pos	number	Timestamp to set the current track to, in milliseconds

Returns: Promise<Player>

Defined in: api/player/Player.ts:278

---

sendVoiceServerUpdate

▸ Protected AbstractsendVoiceServerUpdate(update: VoiceServerUpdate): Promise<Player>

Provides a voice server update event to the andesite instance..

Parameters:

Name	Type	Description
update	VoiceServerUpdate	The voice update payload.

Returns: Promise<Player>

Defined in: api/player/Player.ts:307

---

setFilters

▸ AbstractsetFilters(filters: FilterChain | FilterMap): Promise<Player>

Configures the audio filters for the guild

Parameters:

Name	Type	Description
filters	FilterChain | FilterMap	The filter map.

Returns: Promise<Player>

Defined in: api/player/Player.ts:290

---

setPaused

▸ AbstractsetPaused(state?: boolean): Promise<Player>

Update the pause state of this player.

Parameters:

Name	Type	Description
state?	boolean	Whether or not to pause the player

Returns: Promise<Player>

Defined in: api/player/Player.ts:272

---

setVolume

▸ AbstractsetVolume(volume?: number): Promise<Player>

Update the volume of this player.

Parameters:

Name	Type	Description
volume?	number	Volume to set on the player

Returns: Promise<Player>

Defined in: api/player/Player.ts:284

---

stop

▸ Abstractstop(): Promise<Player>

Stops playing audio on the guild.

Returns: Promise<Player>

Defined in: api/player/Player.ts:266

---

update

▸ Abstractupdate(payload: UpdatePlayer): Promise<Player>

Update the player.

Parameters:

Name	Type	Description
payload	UpdatePlayer	The player update data.

Returns: Promise<Player>

Defined in: api/player/Player.ts:296

---

create

▸ Staticcreate(transport: PlayerTransport, node: Node, guildId: string): Player

Creates a player.

Parameters:

Name	Type	Description
transport	PlayerTransport	The transport to use. Either "websocket" or "rest".
node	Node	The node.
guildId	string	The guild id.

Returns: Player

Defined in: api/player/Player.ts:102