Queue

Queue

Represents a guild queue.

Constructor

new Queue(guildID)

Represents a guild queue.

Parameters:
Name Type Description
guildID string

Members

connection :VoiceConnection

The voice connection.

Type:
  • VoiceConnection

dispatcher :StreamDispatcher

The stream dispatcher.

Type:
  • StreamDispatcher

guildID :Snowflake

The guild ID.

Type:
  • Snowflake

playing :Boolean

Whether the stream is currently playing.

Type:
  • Boolean

repeatMode :Boolean

Whether the repeat mode is enabled.

Type:
  • Boolean

skipped :Boolean

Whether the last song was skipped.

Type:
  • Boolean

songs :Array.<Song>

Songs. The first one is currently playing and the rest is going to be played.

Type:

stopped :Boolean

Whether the stream is currently stopped.

Type:
  • Boolean

volume :Number

The stream volume.

Type:
  • Number

Events

channelEmpty

Emitted when the voice channel is empty.

end

Emitted when the queue is empty.

songChanged

Emitted when the song changes.

Parameters:
Name Type Description
oldSong Song

The old song (playing before)

newSong Song

The new song (currently playing)

skipped Boolean

Whether the change is due to the skip() function