HoshimiEvents
The events for the manager.
Signature
export interface HoshimiEventsProperties
28debugerrornodeRawnodeErrornodeReadynodeDisconnectnodeReconnectingnodeDestroynodeResumednodeCreateplayerCreateplayerUpdateplayerDestroyplayerErrorplayerPausedplayerResumedplayerDisconnectplayerMovetrackStarttrackEndtrackStucktrackErrorlyricsFoundlyricsNotFoundlyricsLinequeueEndqueueUpdatesocketClosed
Methods
0No methods.
Properties
debug: [ level: DebugLevels, message: string];Emitted when the manager emits a debug message.
Parameters
level- The debug level of the message.
message- The message that was emitted.
error: [ error: Error | unknown];Emitted when the manager emits an error.
Parameters
error- The error that was emitted.
nodeRaw: [ node: NodeStructure, message: LavalinkEventPayload];Emitted when the node gives a response.
Parameters
node- The node that emitted the event.
message- The message that was received.
nodeError: [ node: NodeStructure, error: Error | unknown];Emitted when the node gives an error.
Parameters
node- The node that emitted the event.
error- The error that was received.
nodeReady: [ node: NodeStructure, retries: number, payload: Ready];Emitted when the node is ready.
Parameters
node- The node that emitted the event.
retries- The number of retries after the node was ready.
payload- The payload of the event.
nodeDisconnect: [ node: NodeStructure];Emitted when the node is disconnected.
Parameters
node- The node that was disconnected.
nodeReconnecting: [ node: NodeStructure, retriesLeft: number, delay: number];Emitted when the node reconnects.
Parameters
node- The node that was reconnected.
retriesLeft- The number of retries left.
delay- The delay before the next retry.
nodeDestroy: [ node: NodeStructure, destroy: NodeDestroyInfo];Emitted when the node is destroyed.
Parameters
node- The node that was destroyed.
options- The options for the destroy.
nodeResumed: [ node: NodeStructure, players: LavalinkPlayer[], payload: Ready];Emitted when the node is resumed.
Parameters
node- The node that was resumed.
players- The players that were resumed.
payload- The payload of the event.
nodeCreate: [ node: NodeStructure];Emitted when the node is created.
Parameters
node- The node that was created.
playerCreate: [ player: PlayerStructure];Emitted when the player is created.
Parameters
player- The player that was created.
playerUpdate: [ newPlayer: PlayerStructure, oldPlayer: PlayerJSON, payload: PlayerUpdate];Emitted when the player updates.
Parameters
newPlayer- The new player.
oldPlayer- The old player.
playerDestroy: [ player: PlayerStructure, reason: string];Emitted when the player is destroyed.
Parameters
player- The player that was destroyed.
reason- The reason for the destroy.
playerError: [ player: PlayerStructure, error: Error | unknown];Emitted when the player has an error.
Parameters
player- The player that emitted the event.
error- The error that was emitted.
playerPaused: [ player: PlayerStructure, track: TrackStructure | null];Emitted when the player is paused.
Parameters
player- The player that was paused.
track- The track that was paused.
playerResumed: [ player: PlayerStructure, track: TrackStructure | null];Emitted when the player is resumed.
Parameters
player- The player that was resumed.
track- The track that was resumed.
playerDisconnect: [ player: PlayerStructure];Emitted when the player is disconnected from the voice channel.
Parameters
player- The player that was disconnected.
playerMove: [ player: PlayerStructure, oldChannelId: string, newChannelId: string];Emitted when the player is moved to a different voice channel.
Parameters
player- The player that was moved.
oldChannelId- The voice channel id the player was moved from.
newChannelId- The voice channel id the player was moved to.
trackStart: [ player: PlayerStructure, track: TrackStructure | null, payload: TrackStartEvent];Emitted when a track starts playing.
Parameters
player- The player that emitted the event.
track- The track that was started.
payload- The payload of the event.
trackEnd: [ player: PlayerStructure, track: TrackStructure | null, payload: TrackEndEvent];Emitted when a track ends.
Parameters
player- The player that emitted the event.
track- The track that ended.
payload- The payload of the event.
trackStuck: [ player: PlayerStructure, track: TrackStructure | null, payload: TrackStuckEvent];Emitted when the track is stuck.
Parameters
player- The player that emitted the event.
track- The track that was stuck.
payload- The payload of the event.
trackError: [ player: PlayerStructure, track: TrackStructure | null, payload: TrackExceptionEvent];Emitted when a track is errored.
Parameters
player- The player that emitted the event.
track- The track that was errored.
payload- The payload of the event.
lyricsFound: [ player: PlayerStructure, track: TrackStructure | null, payload: LyricsFoundEvent];Emitted when lyrics are found.
Parameters
player- The player that emitted the event.
track- The track that was found.
payload- The lyrics that were found.
lyricsNotFound: [ player: PlayerStructure, track: TrackStructure | null, payload: LyricsNotFoundEvent];Emitted when lyrics are not found.
Parameters
player- The player that emitted the event.
track- The track that was not found.
payload- The lyrics that were not found.
lyricsLine: [ player: PlayerStructure, track: TrackStructure | null, payload: LyricsLineEvent];Emitted when a line of lyrics is updated.
Parameters
player- The player that emitted the event.
track- The track that was updated.
payload- The lyrics that were updated.
queueEnd: [ player: PlayerStructure, queue: QueueStructure];Emitted when the queue ends.
Parameters
player- The player that emitted the event.
queue- The queue that ended.
queueUpdate: [ player: PlayerStructure, queue: QueueStructure];Emitted when the queue updates.
Parameters
player- The player that emitted the event.
queue- The queue that updated.
socketClosed: [ player: PlayerStructure, payload: WebSocketClosedEvent];Emitted when the socket is closed.
Parameters
player- The player that emitted the event.
payload- The payload of the event.