How Do I?

This section covers all the basic functions of Lyra and how to use them.

If you find the API Reference section too confusing or would rather have a straightforward explanation as to how to use a certain function, this is for you.

• Use the NodePool class
  • Adding a node
  • Getting a node
  • Getting the best node
  • Disconnecting all nodes from the pool
• Use the Node class
  • Getting a player
  • Getting tracks
  • Getting recommendations
• Use the Player class
  • Getting tracks
  • Getting recommendations
  • Connecting a player
  • Controlling the player
    • Destroying a player
    • Playing a track
    • Seeking to a position
    • Pausing/unpausing the player
    • Setting the player volume
    • Stopping the player
    • Moving the player to another channel
  • Controlling filters
    • Adding a filter
    • Removing a filter
    • Resetting all filters
• Use the Filter class
  • Types of filters
  • Adding a filter
  • Removing a filter
  • Resetting all filters
• Use the Queue class
  • Adding a song to the queue
  • Getting a track from the queue
    • Getting index of track
    • Getting track with its index
  • Getting the next track in the queue
  • Removing a track from the queue
  • Shuffling the queue
  • Looping the queue
    • Resetting the loop mode
  • Jumping to a track in the queue
• Use the Events class
  • Event definitions
    • Track events
    • Websocket events
    • Lyrics events
    • Node events
    • Player state events
• Use Lyrics
  • Fetching lyrics for the current track
    • Fetch parameters
  • Fetching lyrics for a specific track
  • Checking if lyrics are available
  • Getting lyrics near the current playback position
  • Live lyrics (Lavalink v4 only)
    • Subscribing to live lyrics
    • Unsubscribing from live lyrics
  • The Lyrics object
  • Listening for lyrics events
• Use LavaSearch
  • Accessing the SearchManager
  • Performing a search
    • Parameters
  • Search types (LavaSearchType)
  • The SearchResult object
  • Example: search and play the first result
  • Example: search Spotify for a track and album