Interface: SerializedPlayerState

Represents the full serialized state of a Player, written to and read from the configured state storage backend (Memory, Redis, or JSON).
Used internally by PlayerUtils.serializePlayer() and Manager.loadPlayerStates() to persist and restore players across restarts.

---

SerializedPlayerState

Property	Type	Description	Optional
clusterId	number	The cluster ID of the manager instance that owned this player.
guildId	string	The guild ID this player belongs to.
voiceChannelId	string | null	The voice channel ID, or null if not connected.
textChannelId	string | null	The text channel ID, or null if unset.
volume	number	The player's volume level at time of serialization.
position	number	The playback position in milliseconds at time of serialization.
paused	boolean	Whether the player was paused.
playing	boolean	Whether the player was actively playing.
trackRepeat	boolean	Whether track repeat was enabled.
queueRepeat	boolean	Whether queue repeat was enabled.
dynamicRepeat	boolean	Whether dynamic repeat was enabled.
isAutoplay	boolean	Whether autoplay was enabled.
autoplayTries	number	The number of autoplay retry attempts at time of serialization.
dynamicLoopInterval	number	The dynamic loop interval in milliseconds, if set.
voiceState	VoiceState	The voice state at time of serialization.
options	PlayerOptions	The player options used to create the player.
node	SerializedNode | null	The node the player was connected to, or null if no node was assigned.
queue	SerializedQueue	The serialized queue state.
filters	SerializedFilters | null	The active filter state, or null if no filters were applied.
data	SerializedData	Optional developer-defined data attached to the player, including client user and now-playing message.

---

SerializedNode

The node the player was connected to at time of serialization.

Property	Type	Description	Optional
sessionId	string	The Lavalink session ID for this node connection.
options.identifier	string	The identifier of the node.

---

SerializedQueue

The serialized queue state at time of serialization.

Property	Type	Description	Optional
current	Track | null	The track currently playing, or null if none.
tracks	Track[]	The upcoming tracks in the queue.
previous	Array<Track | null>	Previously played tracks.

---

SerializedFilters

The active filter state at time of serialization.

Property	Type	Description	Optional
bassBoostlevel	number | null	The bass boost level, or null if not set.
equalizer	EqualizerBand[]	The equalizer band configuration.
distortion	DistortionOptions	The distortion filter settings.
karaoke	KaraokeOptions	The karaoke filter settings.
timescale	TimescaleOptions	The timescale filter settings.
vibrato	VibratoOptions	The vibrato filter settings.
rotation	RotationOptions	The rotation filter settings.
reverb	ReverbOptions	The reverb filter settings.
volume	number	The filter volume level.
filterStatus	Record<string, boolean>	A map of filter names to their enabled state.

---

SerializedData

Optional developer-defined data persisted with the player.

Property	Type	Description	Optional
clientUser	AnyUser	The bot's own user object at time of serialization.
nowPlayingMessage	NowPlayingMessage | null	A minimal reference to the now-playing message, or null if none.
...	unknown	Any additional developer-defined keys.

---

NowPlayingMessage

A minimal serializable reference to a now-playing message.

Property	Type	Description	Optional
id	string	The message ID.
channelId	string	The channel ID the message was sent in.
guildId	string	The guild ID the message belongs to.