Player

Table of contents

Constructors

• constructor

Properties

• current
• filters
• guildId
• moving
• node
• paused
• playing
• position
• queue
• repeatMode
• selfDeaf
• selfMute
• state
• textChannelId
• voiceChannelId
• voiceState

Accessors

• exactPosition
• queueDuration
• volume

Methods

• addTracks
• connect
• destroy
• disconnect
• moveNode
• pause
• ping
• play
• resume
• seek
• sendVoiceUpdate
• setRepeatMode
• setSelfDeaf
• setSelfMute
• setVoiceChannel
• skip
• update
• checkOptions

Constructors

constructor

• new Player(lavashark, options)

Create a new Player instance

Parameters

Name	Type	Description
lavashark	LavaShark	The lavashark instance
options	PlayerOptions	The player options

Defined in

lib/Player.ts:88

Properties

current

• current: null | Track

Defined in

lib/Player.ts:50

---

filters

• Readonly filters: Filters

Defined in

lib/Player.ts:40

---

guildId

• Readonly guildId: string

Defined in

lib/Player.ts:38

---

moving

• moving: boolean

Defined in

lib/Player.ts:64

---

node

• node: null | Node

Defined in

lib/Player.ts:36

---

paused

• paused: boolean

Defined in

lib/Player.ts:59

---

playing

• playing: boolean

Defined in

lib/Player.ts:58

---

position

• position: number

Defined in

lib/Player.ts:55

---

queue

• queue: Queue

Defined in

lib/Player.ts:51

---

repeatMode

• repeatMode: RepeatMode

Defined in

lib/Player.ts:53

---

selfDeaf

• Optional selfDeaf: boolean

Defined in

lib/Player.ts:47

---

selfMute

• Optional selfMute: boolean

Defined in

lib/Player.ts:48

---

state

• state: ConnectionState

Defined in

lib/Player.ts:61

---

textChannelId

• Optional textChannelId: null | string

Defined in

lib/Player.ts:45

---

voiceChannelId

• voiceChannelId: string

Defined in

lib/Player.ts:44

---

voiceState

• voiceState: VoiceState

Defined in

lib/Player.ts:62

Accessors

exactPosition

• get exactPosition(): number

Gets the exact track position based on the last playerUpdate packet

Returns

number

Defined in

lib/Player.ts:127

---

queueDuration

• get queueDuration(): number

Gets the queue duration in milliseconds

Deprecated

• Use queue.duration instead

Returns

number

Defined in

lib/Player.ts:142

---

volume

• get volume(): number

Gets the volume of the player

Returns

number

Defined in

lib/Player.ts:149

Methods

addTracks

▸ addTracks(tracks, requester): void

Adds one or more tracks to the queue

Parameters

Name	Type	Description
tracks	default | Track | (default | Track)[]	The track(s) to add to the queue
requester	unknown	The requester of the track(s)

Returns

void

Defined in

lib/Player.ts:169

---

connect

▸ connect(): Promise<void>

Connects to the voice channel

Returns

Promise<void>

Defined in

lib/Player.ts:188

---

destroy

▸ destroy(): Promise<void>

Destroys the player

Returns

Promise<void>

Defined in

lib/Player.ts:239

---

disconnect

▸ disconnect(): void

Disconnects from the voice channel

Returns

void

Defined in

lib/Player.ts:218

---

moveNode

▸ moveNode(node): Promise<void>

Parameters

Name	Type	Description
node	Node	The target node to move the player

Returns

Promise<void>

Defined in

lib/Player.ts:258

---

pause

▸ pause(state?): Promise<boolean>

Pause or unpause the player

Parameters

Name	Type	Default value	Description
state?	boolean	true	Whether to pause or unpause the player

Returns

Promise<boolean>

Defined in

lib/Player.ts:358

---

ping

▸ ping(): Promise<number>

Gets the latency between lavalink client & node

Returns

Promise<number>

• In milliseconds

Defined in

lib/Player.ts:297

---

play

▸ play(options?): Promise<void>

Plays a track

Parameters

Name	Type	Description
options?	PlayOptions	Play options

Returns

Promise<void>

Defined in

lib/Player.ts:319

---

resume

▸ resume(): Promise<boolean>

Resume the player

Returns

Promise<boolean>

Defined in

lib/Player.ts:379

---

seek

▸ seek(position): Promise<void>

Seek to a specific position in the track

Parameters

Name	Type	Description
position	number	The position to seek, in milliseconds

Returns

Promise<void>

Defined in

lib/Player.ts:415

---

sendVoiceUpdate

▸ sendVoiceUpdate(): Promise<void>

Returns

Promise<void>

Defined in

lib/Player.ts:512

---

setRepeatMode

▸ setRepeatMode(mode): void

Set repeat mode for this queue

Parameters

Name	Type	Description
mode	RepeatMode	The repeat mode to apply

Returns

void

Defined in

lib/Player.ts:435

---

setSelfDeaf

▸ setSelfDeaf(state): void

Sets the bot's self deaf state

Parameters

Name	Type	Description
state	boolean	Whether to self deaf or not

Returns

void

Defined in

lib/Player.ts:477

---

setSelfMute

▸ setSelfMute(state): void

Sets the bot's self mute state

Parameters

Name	Type	Description
state	boolean	Whether to self mute or not

Returns

void

Defined in

lib/Player.ts:490

---

setVoiceChannel

▸ setVoiceChannel(channelId): void

Sets the player voice channel

Parameters

Name	Type	Description
channelId	string	The voice channel id

Returns

void

Defined in

lib/Player.ts:503

---

skip

▸ skip(amount?): Promise<boolean>

Skips the current playing track

Parameters

Name	Type	Description
amount?	number	The amount of tracks to skip

Returns

Promise<boolean>

Defined in

lib/Player.ts:387

---

update

▸ update(state): void

Parameters

Name	Type
state	PlayerState

Returns

void

Defined in

lib/Player.ts:535

---

checkOptions

▸ Static checkOptions(options): void

Parameters

Name	Type
options	PlayerOptions

Returns

void

Defined in

lib/Player.ts:66