Skip to main content

musicConnection.js

musicConnection#

Example

new MusicConnection(    joinVoiceChannel(...),);

musicConnection~MusicConnection#

Kind: inner class of musicConnection
Properties

NameTypeDescription
voiceConnectionobject

The @discordjs/voice VoiceConnection

audioPlayerobject

The @discordjs/voice audio player

queueLockboolean

Queue Lock

readyLockboolean

Ready Lock

currentTrackObject

Currently playing track

queueArray

Array of tracks queued

loopstring

Loop mode

shuffleboolean

Shuffle mode

new MusicConnection(voiceConnection)#

Creates and returns a MusicConnection class

ParamTypeDescription
voiceConnectionobject

discord.js voice connection

musicConnection~addToQueue(track)#

Adds a Track class to the queue

Kind: inner method of musicConnection

ParamTypeDescription
trackobject

Track Class

musicConnection~stop()#

Stops the player and clears the queue.

Kind: inner method of musicConnection

musicConnection~processQueue()#

Processes the queue, plays the next track if there is one.

Kind: inner method of musicConnection

musicConnection~changeMode()#

Change queue mode to radio or queue (in the future playlists?)

Kind: inner method of musicConnection