Skip to main content
Version: v2.10.3 (current)

ManagerEvents

Tuple elements are the exact callback arguments. Lyrics, chapter, and SponsorBlock callbacks may receive track: null. playerUpdate is emitted for both backends.

Definition​

export interface ManagerEvents {
	[ManagerEventTypes.ChapterStarted]: [player: Player, track: Track | null, payload: SponsorBlockChapterStarted];
	[ManagerEventTypes.ChaptersLoaded]: [player: Player, track: Track | null, payload: SponsorBlockChaptersLoaded];
	[ManagerEventTypes.Debug]: [info: string];
	[ManagerEventTypes.LyricsFound]: [player: Player, track: Track | null, payload: LyricsFoundEvent];
	[ManagerEventTypes.LyricsLine]: [player: Player, track: Track | null, payload: LyricsLineEvent];
	[ManagerEventTypes.LyricsNotFound]: [player: Player, track: Track | null, payload: LyricsNotFoundEvent];
	[ManagerEventTypes.NodeConnect]: [node: Node];
	[ManagerEventTypes.NodeCreate]: [node: Node];
	[ManagerEventTypes.NodeDestroy]: [node: Node];
	[ManagerEventTypes.NodeDisconnect]: [node: Node, reason: { code?: number; reason?: string }];
	[ManagerEventTypes.NodeError]: [node: Node, error: Error];
	[ManagerEventTypes.NodeRaw]: [payload: unknown];
	[ManagerEventTypes.NodeReconnect]: [node: Node];
	[ManagerEventTypes.PlayerCreate]: [player: Player];
	[ManagerEventTypes.PlayerDestroy]: [player: Player];
	[ManagerEventTypes.PlayerDisconnect]: [player: Player, oldChannel: string];
	[ManagerEventTypes.PlayerMove]: [player: Player, oldChannel: string, newChannel: string];
	[ManagerEventTypes.PlayerRestored]: [player: Player, node: Node];
	[ManagerEventTypes.PlayerStateUpdate]: [oldPlayer: Player, newPlayer: Player, changeType: PlayerStateUpdateEvent];
	[ManagerEventTypes.QueueEnd]: [player: Player, track: Track, payload: TrackEndEvent];
	[ManagerEventTypes.RestoreComplete]: [node: Node];
	[ManagerEventTypes.SegmentSkipped]: [player: Player, track: Track | null, payload: SponsorBlockSegmentSkipped];
	[ManagerEventTypes.SegmentsLoaded]: [player: Player, track: Track | null, payload: SponsorBlockSegmentsLoaded];
	[ManagerEventTypes.SocketClosed]: [player: Player, payload: WebSocketClosedEvent];
	[ManagerEventTypes.TrackEnd]: [player: Player, track: Track, payload: TrackEndEvent];
	[ManagerEventTypes.TrackError]: [player: Player, track: Track, payload: TrackExceptionEvent];
	[ManagerEventTypes.TrackStart]: [player: Player, track: Track, payload: TrackStartEvent];
	[ManagerEventTypes.TrackStuck]: [player: Player, track: Track, payload: TrackStuckEvent];
	[ManagerEventTypes.MixStarted]: [player: Player, payload: NodeLinkMixStartedEvent];
	[ManagerEventTypes.MixEnded]: [player: Player, payload: NodeLinkMixEndedEvent];
	[ManagerEventTypes.NodeLinkConnectionStatus]: [node: Node, payload: NodeLinkConnectionStatusEvent];
	[ManagerEventTypes.NodeLinkEternalBoxInfo]: [player: Player, payload: NodeLinkEternalBoxInfoEvent];
	[ManagerEventTypes.NodeLinkEternalBoxJump]: [player: Player, payload: NodeLinkEternalBoxJumpEvent];
	[ManagerEventTypes.NodeLinkEvent]: [node: Node, payload: NodeLinkEvent];
	[ManagerEventTypes.NodeLinkFiltersChanged]: [player: Player, payload: NodeLinkFiltersChangedEvent];
	[ManagerEventTypes.NodeLinkPause]: [player: Player, payload: NodeLinkPauseEvent];
	[ManagerEventTypes.NodeLinkPlayerConnected]: [player: Player, payload: NodeLinkPlayerConnectedEvent];
	[ManagerEventTypes.NodeLinkPlayerCreated]: [player: Player, payload: NodeLinkPlayerCreatedEvent];
	[ManagerEventTypes.NodeLinkPlayerDestroyed]: [player: Player, payload: NodeLinkPlayerDestroyedEvent];
	[ManagerEventTypes.NodeLinkPlayerReconnecting]: [player: Player, payload: NodeLinkPlayerReconnectingEvent];
	[ManagerEventTypes.NodeLinkSeek]: [player: Player, payload: NodeLinkSeekEvent];
	[ManagerEventTypes.NodeLinkStreamMetadata]: [player: Player, payload: NodeLinkStreamMetadataEvent];
	[ManagerEventTypes.NodeLinkVolumeChanged]: [player: Player, payload: NodeLinkVolumeChangedEvent];
	[ManagerEventTypes.NodeLinkWorkerFailed]: [node: Node, payload: NodeLinkWorkerFailedEvent];
	[ManagerEventTypes.PlayerUpdate]: [player: Player, payload: PlayerUpdateMessage];
	[ManagerEventTypes.VoiceReceiverDisconnect]: [player: Player];
	[ManagerEventTypes.VoiceReceiverConnect]: [player: Player];
	[ManagerEventTypes.VoiceReceiverError]: [player: Player, error: Error];
	[ManagerEventTypes.VoiceReceiverStartSpeaking]: [player: Player, data: unknown];
	[ManagerEventTypes.VoiceReceiverData]: [player: Player, data: VoiceReceiverData];
	[ManagerEventTypes.VoiceReceiverEndSpeaking]: [player: Player, data: unknown];
}