Variable RestRoutesConst

Type Declaration

• Connection: "/connection"

  Get the connection endpoint.

  Description

  Used for checking the connection status of the node, only for nodelink nodes.

• DecodeTrack: "/decodetrack"

  Get the decode track endpoint.

• DecodeTracks: "/decodetracks"

  Get the decode tracks endpoint.

• GetLyrics: "/lyrics"

  Get the lyrics endpoint.

• LoadLyrics: "/loadlyrics"

  Get the load lyrics endpoint.

  Description

  Used in NodelinkLyricsManager, only for nodelink nodes.

• LoadTracks: "/loadtracks"

  Get the load tracks endpoint.

• NodeInfo: "/info"

  Get the node info endpoint.

• CurrentLyrics: function

  • CurrentLyrics(
        sessionId: string,
        guildId: string,
    ): `/sessions/${string}/players/${string}/track/lyrics`

    Get the current lyrics endpoint.

    Parameters

    • sessionId: string

      The session id of the node.

    • guildId: string

      The guild id of the player.

    Returns `/sessions/${string}/players/${string}/track/lyrics`

    The endpoint for getting the current lyrics.

• GetPlayers: function

  • GetPlayers(sessionId: string): `/sessions/${string}/players`

    Get the get players endpoint.

    Parameters

    • sessionId: string

      The session id of the node.

    Returns `/sessions/${string}/players`

    The endpoint for getting the players.

• SubscribeLyrics: function

  • SubscribeLyrics(
        sessionId: string,
        guildId: string,
    ): `/sessions/${string}/players/${string}/lyrics/subscribe`

    Subscribe to lyrics endpoint.

    Parameters

    • sessionId: string

      The session id of the node.

    • guildId: string

      The guild id of the player.

    Returns `/sessions/${string}/players/${string}/lyrics/subscribe`

    The endpoint for subscribing to lyrics.

• UpdatePlayer: function

  • UpdatePlayer(
        sessionId: string,
        guildId: string,
    ): `/sessions/${string}/players/${string}`

    Get the updated player endpoint.

    Parameters

    • sessionId: string

      The session id of the node.

    • guildId: string

      The guild id of the player.

    Returns `/sessions/${string}/players/${string}`

    The endpoint for updating the player.

• UpdateSession: function

  • UpdateSession(sessionId: string): `/sessions/${string}`

    Get the update session endpoint.

    Parameters

    • sessionId: string

      The session id of the node.

    Returns `/sessions/${string}`

    The endpoint for updating the session.