Player

Constructor

Player : options

new Magmastream.Player(options: PlayerOptions)

Parameter	Type	Description
selfDeafen	boolean	If the player should deaf itself.
selfMute	boolean	If the player should mute itself.
node	string as NodeIdentifier	The node the Player uses.
textChannel	string as GuildTextChannelID	The text channel the Player belongs to.
volume	number	The initial volume the Player will use.
voiceChannel	string as GuildVoiceChannelID	The voice channel the Player belongs to.
guildId	string as GuildID	The guild ID the Player belongs to.

Table of contents

Properties	Methods
autoplayTries	connect()
bands	deleteSponsorBlock()
dynamicRepeat	destroy()
guildId	disconnect()
isAutoplay	get()
manager	getRecommended()
node	getSponsorBlock()
nowPlayingMessage	pause()
paused	play()
playing	previous()
position	restart()
queue	search()
queueRepeat	seek()
state	set()
textChannel	setAutoplay()
trackRepeat	setDynamicRepeat()
voiceChannel	setNowPlayingMessage()
voiceState	setQueueRepeat()
volume	setSponsorBlock()
	setTextChannel()
	setTrackRepeat()
	setVoiceChannel()
	setVolume()
	stop()

Properties

autoplayTries

The number of times to try autoplay before emitting queueEnd.

Returns: number | 3 (default value)

bands

The equalizer bands array.

Returns: number[]

dynamicRepeat

Whether the queue repeats and shuffles after each song.

Returns: boolean

guildId

The guild ID for the player.

Returns: string as GuildID

isAutoplay

The autoplay state of the player.

Returns: boolean

manager

The Manager for the player.

Returns: Manager

node

The Node for the Player.

Returns: Node

nowPlayingMessage

The now playing message for the player.

Returns: Message

paused

Whether the player is paused.

Returns: boolean

playing

Whether the player is playing.

Returns: boolean

position

The time the player is in the track.

Returns: number

queue

The Queue for the Player.

Returns: Queue

queueRepeat

Whether the queue repeats the queue.

Returns: boolean

state

The current state of the player.

Returns: StateTypes

textChannel

The text channel id for the player.

Returns: string as GuildTextChannelID

trackRepeat

Whether the queue repeats the track.

Returns: boolean

voiceChannel

The voice channel id for the player.

Returns: string as GuildVoiceChannelID

voiceState

The voice state object from Discord.

Returns: VoiceState

volume

The volume for the player.

Returns: number

Methods

connect()

Connect to the voice channel.

Returns: this

deleteSponsorBlock()

Deletes the sponsorblock for the player. This will remove all sponsorblock segments that have been set for the player.

Returns: Promise<this>

destroy()

Destroys the player.

Returns: void

Parameter	Type	Description
disconnect	boolean	If true, disconnects the player from the voice channel before destroying it.

disconnect()

Disconnects the player from the voice channel.

Returns: this

get()

Retrieves custom data associated with a given key.

Returns: boolean

Parameter	Type	Description
key	string	The key to retrieve the data for.

getRecommended()

Gets recommended tracks and returns an array of tracks.

Returns: Promise<track[]>

Parameter	Type	Description
track	Track	The track to find recommendations for.
requester	User | ClientUser	The user who requested the track.

getSponsorBlock()

Gets the sponsorblock for the player.

Returns: Promise<SponsorBlockSegment[]>

pause()

Pauses or resumes the current track.

Returns: this

Parameter	Type	Description
pause	boolean	A boolean indicating whether to pause (true) or resume (false) the track.

play()

Plays the next track.

If a track is provided, it will be played. Otherwise, the next track in the queue will be played.
If the queue is not empty, but the current track has not finished yet, it will be replaced with the provided track.

Returns: Promise<void>

Start playing after add track to queue

const { Manager } = require('magmastream');

const manager = new Manager({
    ...ManagerOptions
})

const searchResponse = await manager.search('Never Gonna Give You Up');

const player = client.lavalink.create({
    ...PlayerOptions
});

player.connect()
player.queue.add(searchResponse.tracks);

player.play();

Start playing with track

Parameter	Type
track	Track | UnresolvedTrack

const { Manager } = require('magmastream');

const manager = new Manager({
    ...ManagerOptions
})

const searchResponse = await manager.search('Never Gonna Give You Up');

const player = client.lavalink.create({
    ...PlayerOptions
});

player.connect()
player.play(searchResponse.tracks[0]);

Start playing with play options

Parameter	Type
options	PlayOptions

Start playing with track and options

Parameter	Type
track	Track | UnresolvedTrack
options	PlayOptions

const { Manager } = require('magmastream');

const manager = new Manager({
    ...ManagerOptions
})

const searchResponse = await manager.search('Never Gonna Give You Up');

const player = client.lavalink.create({
    ...PlayerOptions
});

player.connect()
player.play(searchResponse.tracks[0], {
    ...PlayOptions
});

previous()

Goes back to the previous song in the queue.

Returns: this

restart()

Restarts the current track to the start.

If there's no current track and there are tracks in the queue, it plays the next track.

Returns: void

search()

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

Returns: Promise<searchResult{}>

Parameter	Type	Description
query	string | searchQuery{}	Query to search.
requester	User | ClientUser	The user who requested the track.

seek()

Seeks to the specified position in the current track.

Returns: this

Parameter	Type	Description
position	number	The position in milliseconds to seek to.

set()

Set custom data.

Returns: void

Parameter	Type	Description
key	string	The key to set the data for.
value	unknown	The value to set the data to.

setAutoplay()

Sets the autoplay-state of the player.

Autoplay is a feature that makes the player play a recommended track when the current track ends.

Returns: this

Parameter	Type	Description
autoplayState	boolean	Whether or not autoplay should be enabled.
botUser	object	The user-object that should be used as the bot-user.
tries	number	The number of times the player should try to find a recommended track if the first one doesn't work.

setDynamicRepeat()

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

Returns: this

Parameter	Type	Description
repeat	boolean	Whether to repeat the queue or not
ms	number	After how many milliseconds to trigger dynamic repeat.

setNowPlayingMessage()

Sets the now playing message.

Returns: Message

Parameter	Type	Description
message	Message	The message of the now playing message.

setQueueRepeat()

Sets the queue repeat.

Returns: this

Parameter	Type	Description
repeat	boolean	Whether to repeat the queue or not

setSponsorBlock()

Sets the sponsorblock for the player. This will set the sponsorblock segments for the player to the given segments.

Returns: Promise<void>

Parameter	Type	Description
segments	SponsorBlockSegment[]	The sponsorblock segments to set. Defaults to ["sponsor", "selfpromo"] if not provided.

setTextChannel()

Sets the player text channel.

This method updates the text channel associated with the player. It also emits a player state update event indicating the change in the channel.

Returns: this

Parameter	Type	Description
channel	string as GuildTextChannelID	The new text channel ID.

setTrackRepeat()

Sets the track repeat mode.

When track repeat is enabled, the current track will replay after it ends.
Disables queueRepeat and dynamicRepeat modes if enabled.

Returns: this

Parameter	Type	Description
repeat	boolean	Whether to repeat the queue or not

setVoiceChannel()

Sets the player voice channel.

Returns: this

Parameter	Type	Description
channel	string as GuildVoiceChannelID	The new voice channel ID.

setVolume()

Sets the player volume.

Returns: this

Parameter	Type	Description
volume	number	The volume to set the player to. Must be between 0 and 100.

stop()

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

Returns: this

Parameter	Type	Description
amount	number	The amount of tracks to skip, e.g 5 would play the 5th song.