LavalinkManagerEvents

Defined in: src/structures/Types/Manager.ts:29

The events from the lavalink Manager

Type Parameters

Type Parameter	Default type
CustomPlayerT extends Player	Player

Properties

Property (defined in)	Type
playerPaused (UnresolvedTrack )	(player: CustomPlayerT, track: \
playerResumed (UnresolvedTrack )	(player: CustomPlayerT, track: \

Events

Event	Type	Description	Defined in
ChaptersLoaded	(player: CustomPlayerT, track: | UnresolvedTrack | Track, payload: SponsorBlockChaptersLoaded) => void	SPONSORBLOCK-PLUGIN EVENT Emitted when Chapters are loaded Link https://github.com/topi314/Sponsorblock-Plugin#chaptersloaded Manager#trackError	src/structures/Types/Manager.ts:212
ChapterStarted	(player: CustomPlayerT, track: | UnresolvedTrack | Track, payload: SponsorBlockChapterStarted) => void	SPONSORBLOCK-PLUGIN EVENT Emitted when a specific Chapter starts playing Link https://github.com/topi314/Sponsorblock-Plugin#chapterstarted Manager#trackError	src/structures/Types/Manager.ts:200
debug	(eventKey: DebugEvents, eventData: object) => void	Lavalink-Client Debug Event Emitted for several erros, and logs within lavalink-client, if managerOptions.advancedOptions.enableDebugEvents is true Useful for debugging the lavalink-client Manager#debug	src/structures/Types/Manager.ts:225
LyricsFound	(player: CustomPlayerT, track: | UnresolvedTrack | Track, payload: LyricsFoundEvent) => void	Emitted when a Lyrics is found Link https://github.com/topi314/LavaLyrics Manager#LyricsFound	src/structures/Types/Manager.ts:247
LyricsLine	(player: CustomPlayerT, track: | UnresolvedTrack | Track, payload: LyricsLineEvent) => void	Emitted when a Lyrics line is received Link https://github.com/topi314/LavaLyrics Manager#LyricsLine	src/structures/Types/Manager.ts:240
LyricsNotFound	(player: CustomPlayerT, track: | UnresolvedTrack | Track, payload: LyricsNotFoundEvent) => void	Emitted when a Lyrics is not found Link https://github.com/topi314/LavaLyrics Manager#LyricsNotFound	src/structures/Types/Manager.ts:254
playerClientUpdate	(oldPlayerJson: PlayerJson, newPlayer: CustomPlayerT) => void	Always emits when the player (on client side) got updated via a function-call. This is useful for example, if you want to save the player data on every update, or similar. Manager#playerClientUpdate Emits only when you call one of those functions: player.pause() player.resume() player.seek() player.setRepeatMode() player.setVolume() and on every call of the filterManager.	src/structures/Types/Manager.ts:120
playerCreate	(player: CustomPlayerT) => void	Emitted when a Player is created. Manager#playerCreate	src/structures/Types/Manager.ts:63
playerDeafChange	(player: CustomPlayerT, selfDeafed: boolean, serverDeafed: boolean) => void	Emitted when the player’s selfDeafed or serverDeafed state changed (true -> false	false -> true) Manager#playerDeafChange
playerDestroy	(player: CustomPlayerT, destroyReason?: string) => void	Emitted when a Player get’s destroyed Manager#playerDestroy	src/structures/Types/Manager.ts:99
playerDisconnect	(player: CustomPlayerT, voiceChannelId: string) => void	Emitted when a Player is disconnected from a channel. Manager#playerDisconnect	src/structures/Types/Manager.ts:73
playerMove	(player: CustomPlayerT, oldVoiceChannelId: string, newVoiceChannelId: string) => void	Emitted when a Player is moved within the channel. Manager#playerMove	src/structures/Types/Manager.ts:68
playerMuteChange	(player: CustomPlayerT, selfMuted: boolean, serverMuted: boolean) => void	Emitted when the player’s selfMuted or serverMuted state changed (true -> false	false -> true) Manager#playerMuteChange
playerQueueEmptyCancel	(player: CustomPlayerT) => void	Emitted when the player’s queue got empty, and the timeout got cancelled becuase a track got re-added to it. Manager#playerQueueEmptyEnd	src/structures/Types/Manager.ts:156
playerQueueEmptyEnd	(player: CustomPlayerT) => void	Emitted when the player’s queue got empty, and the timeout finished leading to destroying the player Manager#playerQueueEmptyEnd	src/structures/Types/Manager.ts:150
playerQueueEmptyStart	(player: CustomPlayerT, timeoutMs: number) => void	Emitted when the player’s queue got empty, and the timeout started Manager#playerQueueEmptyStart	src/structures/Types/Manager.ts:144
playerReconnect	(player: CustomPlayerT, voiceChannelId: string) => void	Emitted when a Player automatically reconnects after a disconnect. This event is triggered when the player successfully reconnects to the voice channel and resumes playback after being disconnected (requires onDisconnect.autoReconnect to be enabled). Manager#playerReconnect	src/structures/Types/Manager.ts:80
playerSocketClosed	(player: CustomPlayerT, payload: WebSocketClosedEvent) => void	Emitted when a Node-Socket got closed for a specific Player. Usually emits when the audio websocket to discord is closed, This can happen for various reasons (normal and abnormal), e.g. when using an expired voice server update. 4xxx codes are usually bad. So this is just information, normally lavalink should handle disconnections Discord Docs: Link https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-close-event-codes Lavalink Docs: Link https://lavalink.dev/api/websocket.html#websocketclosedevent Manager#playerSocketClosed	src/structures/Types/Manager.ts:94
playerSuppressChange	(player: CustomPlayerT, suppress: boolean) => void	Emitted when the player’s suppressed (true -> false	false -> true) Manager#playerSuppressChange
playerUpdate	(oldPlayerJson: PlayerJson, newPlayer: CustomPlayerT) => void	Always emits when the player (on lavalink side) got updated Manager#playerUpdate	src/structures/Types/Manager.ts:105
playerVoiceJoin	(player: CustomPlayerT, userId: string) => void	Emitted, when a user joins the voice channel, while there is a player existing Manager#playerQueueEmptyStart	src/structures/Types/Manager.ts:162
playerVoiceLeave	(player: CustomPlayerT, userId: string) => void	Emitted, when a user leaves the voice channel, while there is a player existing Manager#playerQueueEmptyEnd	src/structures/Types/Manager.ts:168
queueEnd	(player: CustomPlayerT, track: | UnresolvedTrack | Track, payload: | TrackEndEvent | TrackStuckEvent | TrackExceptionEvent) => void	Emitted when the Playing finished and no more tracks in the queue. Manager#queueEnd	src/structures/Types/Manager.ts:54
SegmentSkipped	(player: CustomPlayerT, track: | UnresolvedTrack | Track, payload: SponsorBlockSegmentSkipped) => void	SPONSORBLOCK-PLUGIN EVENT Emitted when a specific Segment was skipped Link https://github.com/topi314/Sponsorblock-Plugin#segmentskipped Manager#trackError	src/structures/Types/Manager.ts:188
SegmentsLoaded	(player: CustomPlayerT, track: | UnresolvedTrack | Track, payload: SponsorBlockSegmentsLoaded) => void	SPONSORBLOCK-PLUGIN EVENT Emitted when Segments are loaded Link https://github.com/topi314/Sponsorblock-Plugin#segmentsloaded Manager#trackError	src/structures/Types/Manager.ts:176
trackEnd	(player: CustomPlayerT, track: Track, payload: TrackEndEvent) => void	Emitted when a Track finished. Manager#trackEnd	src/structures/Types/Manager.ts:39
trackError	(player: CustomPlayerT, track: | UnresolvedTrack | Track, payload: TrackExceptionEvent) => void	Emitted when a Track errored. Manager#trackError	src/structures/Types/Manager.ts:49
trackStart	(player: CustomPlayerT, track: Track, payload: TrackStartEvent) => void	Emitted when a Track started playing. Manager#trackStart	src/structures/Types/Manager.ts:34
trackStuck	(player: CustomPlayerT, track: Track, payload: TrackStuckEvent) => void	Emitted when a Track got stuck while playing. Manager#trackStuck	src/structures/Types/Manager.ts:44