LithiumX v1.0.8

---

LithiumX / LithiumXPlayer

Class: LithiumXPlayer

Defined in: src/Structures/Player.ts:8

Constructors

new LithiumXPlayer()

new LithiumXPlayer(options): LithiumXPlayer

Defined in: src/Structures/Player.ts:76

Creates a new player, returns one if it already exists.

Parameters

options

PlayerOptions

Returns

LithiumXPlayer

Properties

bands

bands: number[]

Defined in: src/Structures/Player.ts:38

The equalizer bands array.

---

dynamicRepeat

dynamicRepeat: boolean = false

Defined in: src/Structures/Player.ts:18

Whether the queue repeats and shuffles after each song.

---

filters

filters: Filters

Defined in: src/Structures/Player.ts:12

The filters applied to the audio.

---

guild

guild: string

Defined in: src/Structures/Player.ts:30

The guild for the player.

---

isAutoplay

isAutoplay: boolean = false

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

The autoplay state of the player.

---

manager

manager: LithiumXManager

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

The Manager.

---

node

node: LithiumXNode

Defined in: src/Structures/Player.ts:28

The Node for the Player.

---

options

options: PlayerOptions

Defined in: src/Structures/Player.ts:76

---

paused

paused: boolean = false

Defined in: src/Structures/Player.ts:24

Whether the player is paused.

---

playing

playing: boolean = false

Defined in: src/Structures/Player.ts:22

Whether the player is playing.

---

position

position: number = 0

Defined in: src/Structures/Player.ts:20

The time the player is in the track.

---

queue

readonly queue: LithiumXQueue

Defined in: src/Structures/Player.ts:10

The Queue for the Player.

---

queueRepeat

queueRepeat: boolean = false

Defined in: src/Structures/Player.ts:16

Whether the queue repeats the queue.

---

state

state: State = "DISCONNECTED"

Defined in: src/Structures/Player.ts:36

The current state of the player.

---

textChannel

textChannel: string = null

Defined in: src/Structures/Player.ts:34

The text channel for the player.

---

trackRepeat

trackRepeat: boolean = false

Defined in: src/Structures/Player.ts:14

Whether the queue repeats the track.

---

voiceChannel

voiceChannel: string = null

Defined in: src/Structures/Player.ts:32

The voice channel for the player.

---

voiceState

voiceState: VoiceState

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

The voice state object from Discord.

---

volume

volume: number

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

The volume for the player

Methods

connect()

connect(): this

Defined in: src/Structures/Player.ts:110

Connect to the voice channel.

Returns

this

---

destroy()

destroy(disconnect): void

Defined in: src/Structures/Player.ts:209

Destroys the player.

Parameters

disconnect

boolean = true

Returns

void

---

disconnect()

disconnect(): this

Defined in: src/Structures/Player.ts:188

Disconnect from the voice channel.

Returns

this

---

get()

get<T>(key): T

Defined in: src/Structures/Player.ts:63

Get custom data.

Type Parameters

T

T

Parameters

key

string

Returns

T

---

getRecommended()

getRecommended(track, requester?): Promise<Track[]>

Defined in: src/Structures/Player.ts:307

Gets recommended tracks and returns an array of tracks.

Parameters

track

Track

requester?

string

Returns

Promise<Track[]>

---

moveNode()

moveNode(node?): Promise<LithiumXPlayer>

Defined in: src/Structures/Player.ts:133

Moves the player to a different node.

Parameters

node?

string

The ID of the node to move to.

Returns

Promise<LithiumXPlayer>

• The player instance.

---

pause()

pause(pause): this

Defined in: src/Structures/Player.ts:507

Pauses the current track.

Parameters

pause

boolean

Returns

this

---

play()

Call Signature

play(): Promise<void>

Defined in: src/Structures/Player.ts:239

Plays the next track.

Returns

Promise<void>

Call Signature

play(track): Promise<void>

Defined in: src/Structures/Player.ts:245

Plays the specified track.

Parameters

track

Track | UnresolvedTrack

Returns

Promise<void>

Call Signature

play(options): Promise<void>

Defined in: src/Structures/Player.ts:251

Plays the next track with some options.

Parameters

options

PlayOptions

Returns

Promise<void>

Call Signature

play(track, options): Promise<void>

Defined in: src/Structures/Player.ts:258

Plays the specified track with some options.

Parameters

track

Track | UnresolvedTrack

options

PlayOptions

Returns

Promise<void>

---

previous()

previous(): this

Defined in: src/Structures/Player.ts:529

Go back to the previous song.

Returns

this

---

restart()

restart(): void

Defined in: src/Structures/Player.ts:471

Restarts the current track to the start.

Returns

void

---

search()

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

Defined in: src/Structures/Player.ts:105

Same as Manager#search() but a shortcut on the player itself.

Parameters

query

The query to search.

string | SearchQuery

requester?

string

The user who requested the search.

Returns

Promise<SearchResult>

---

seek()

seek(position): this

Defined in: src/Structures/Player.ts:540

Seeks to the position in the current track.

Parameters

position

number

Returns

this

---

set()

set(key, value): void

Defined in: src/Structures/Player.ts:55

Set custom data.

Parameters

key

string

value

unknown

Returns

void

---

setAutoplay()

setAutoplay(autoplayState, botUser): LithiumXPlayer

Defined in: src/Structures/Player.ts:294

Sets the autoplay-state of the player.

Parameters

autoplayState

boolean

botUser

object

Returns

LithiumXPlayer

---

setDynamicRepeat()

setDynamicRepeat(repeat, ms): this

Defined in: src/Structures/Player.ts:435

Sets the queue to repeat and shuffles the queue after each song.

Parameters

repeat

boolean

"true" or "false".

ms

number

After how many milliseconds to trigger dynamic repeat.

Returns

this

---

setQueueRepeat()

setQueueRepeat(repeat): this

Defined in: src/Structures/Player.ts:411

Sets the queue repeat.

Parameters

repeat

boolean

Returns

this

---

setTextChannel()

setTextChannel(channel): this

Defined in: src/Structures/Player.ts:232

Sets the player text channel.

Parameters

channel

string

Returns

this

---

setTrackRepeat()

setTrackRepeat(repeat): this

Defined in: src/Structures/Player.ts:391

Sets the track repeat.

Parameters

repeat

boolean

Returns

this

---

setVoiceChannel()

setVoiceChannel(channel): this

Defined in: src/Structures/Player.ts:221

Sets the player voice channel.

Parameters

channel

string

Returns

this

---

setVolume()

setVolume(volume): this

Defined in: src/Structures/Player.ts:375

Sets the player volume.

Parameters

volume

number

Returns

this

---

stop()

stop(amount?): this

Defined in: src/Structures/Player.ts:487

Stops the current track, optionally give an amount to skip to, e.g 5 would play the 5th song.

Parameters

amount?

number

Returns

this