hoshimi
    Preparing search index...

    Interface HoshimiEvents

    The events for the manager.

    interface HoshimiEvents {
        debug: [level: DebugLevels, message: string];
        error: [error: unknown];
        lyricsFound: [
            player: Player,
            track: Track
            | null,
            payload: LyricsFoundEvent,
        ];
        lyricsLine: [player: Player, track: Track | null, payload: LyricsLineEvent];
        lyricsNotFound: [
            player: Player,
            track: Track
            | null,
            payload: LyricsNotFoundEvent,
        ];
        nodeCreate: [node: Node];
        nodeDestroy: [node: Node, destroy: NodeDestroyInfo];
        nodeDisconnect: [node: Node];
        nodeError: [node: Node, error: unknown];
        nodeRaw: [node: Node, message: LavalinkEventPayload];
        nodeReady: [node: Node, retries: number, payload: Ready];
        nodeReconnecting: [node: Node, retriesLeft: number, delay: number];
        nodeResumed: [node: Node, players: LavalinkPlayer[], payload: Ready];
        playerCreate: [player: Player];
        playerDestroy: [player: Player, reason: string];
        playerError: [player: Player, error: unknown];
        playerUpdate: [
            newPlayer: Player,
            oldPlayer: PlayerJson,
            payload: PlayerUpdate,
        ];
        queueEnd: [player: Player, queue: Queue];
        queueUpdate: [player: Player, queue: Queue];
        socketClosed: [player: Player, payload: WebSocketClosedEvent];
        trackEnd: [player: Player, track: Track | null, payload: TrackEndEvent];
        trackError: [
            player: Player,
            track: Track
            | null,
            payload: TrackExceptionEvent,
        ];
        trackStart: [player: Player, track: Track | null, payload: TrackStartEvent];
        trackStuck: [player: Player, track: Track | null, payload: TrackStuckEvent];
    }
    Index

    Properties

    debug error lyricsFound lyricsLine lyricsNotFound nodeCreate nodeDestroy nodeDisconnect nodeError nodeRaw nodeReady nodeReconnecting nodeResumed playerCreate playerDestroy playerError playerUpdate queueEnd queueUpdate socketClosed trackEnd trackError trackStart trackStuck

    Properties

    debug: [level: DebugLevels, message: string]

    Emitted when the manager emits a debug message.

    The debug level of the message.

    The message that was emitted.

    error: [error: unknown]

    Emitted when the manager emits an error.

    The error that was emitted.

    lyricsFound: [player: Player, track: Track | null, payload: LyricsFoundEvent]

    Emitted when lyrics are found.

    The player that emitted the event.

    The track that was found.

    The lyrics that were found.

    lyricsLine: [player: Player, track: Track | null, payload: LyricsLineEvent]

    Emitted when a line of lyrics is updated.

    The player that emitted the event.

    The track that was updated.

    The lyrics that were updated.

    lyricsNotFound: [
        player: Player,
        track: Track
        | null,
        payload: LyricsNotFoundEvent,
    ]

    Emitted when lyrics are not found.

    The player that emitted the event.

    The track that was not found.

    The lyrics that were not found.

    nodeCreate: [node: Node]

    Emitted when the node is created.

    The node that was created.

    nodeDestroy: [node: Node, destroy: NodeDestroyInfo]

    Emitted when the node is destroyed.

    The node that was destroyed.

    The options for the destroy.

    nodeDisconnect: [node: Node]

    Emitted when the node is disconnected.

    The node that was disconnected.

    nodeError: [node: Node, error: unknown]

    Emitted when the node gives an error.

    The node that emitted the event.

    The error that was received.

    nodeRaw: [node: Node, message: LavalinkEventPayload]

    Emitted when the node gives a response.

    The node that emitted the event.

    The message that was received.

    nodeReady: [node: Node, retries: number, payload: Ready]

    Emitted when the node is ready.

    The node that emitted the event.

    The number of retries after the node was ready.

    The payload of the event.

    nodeReconnecting: [node: Node, retriesLeft: number, delay: number]

    Emitted when the node reconnects.

    The node that was reconnected.

    The number of retries left.

    The delay before the next retry.

    nodeResumed: [node: Node, players: LavalinkPlayer[], payload: Ready]

    Emitted when the node is resumed.

    The node that was resumed.

    The players that were resumed.

    The payload of the event.

    playerCreate: [player: Player]

    Emitted when the player is created.

    The player that was created.

    playerDestroy: [player: Player, reason: string]

    Emitted when the player is destroyed.

    The player that was destroyed.

    The reason for the destroy.

    playerError: [player: Player, error: unknown]

    Emitted when the player has an error.

    The player that emitted the event.

    The error that was emitted.

    playerUpdate: [newPlayer: Player, oldPlayer: PlayerJson, payload: PlayerUpdate]

    Emitted when the player updates.

    The new player.

    The old player.

    queueEnd: [player: Player, queue: Queue]

    Emitted when the queue ends.

    The player that emitted the event.

    The queue that ended.

    queueUpdate: [player: Player, queue: Queue]

    Emitted when the queue updates.

    The player that emitted the event.

    The queue that updated.

    socketClosed: [player: Player, payload: WebSocketClosedEvent]

    Emitted when the socket is closed.

    The player that emitted the event.

    The payload of the event.

    trackEnd: [player: Player, track: Track | null, payload: TrackEndEvent]

    Emitted when a track ends.

    The player that emitted the event.

    The track that ended.

    The payload of the event.

    trackError: [player: Player, track: Track | null, payload: TrackExceptionEvent]

    Emitted when a track is errored.

    The player that emitted the event.

    The track that was errored.

    The payload of the event.

    trackStart: [player: Player, track: Track | null, payload: TrackStartEvent]

    Emitted when a track starts playing.

    The player that emitted the event.

    The track that was started.

    The payload of the event.

    trackStuck: [player: Player, track: Track | null, payload: TrackStuckEvent]

    Emitted when the track is stuck.

    The player that emitted the event.

    The track that was stuck.

    The payload of the event.

    Settings

    Member Visibility

    On This Page

    Properties