🌋
Vulkava
  • Introduction
  • Getting started
  • Custom Queue
  • Filters example
  • Common issues
  • 📚Docs
    • 🌋Vulkava
    • 🎵Player
    • 🎙️Recorder
    • 📑DefaultQueue
    • 🎛️Filters
    • 🪢Node
    • 💿Track
    • 💿UnresolvedTrack
  • 🖌️Abstract Classes
    • 📶AbstractExternalSource
    • 🎹AbstractQueue
  • 🔖Typedefs
    • 🔍SearchResult
    • 🌋VulkavaOptions
    • 🎛️FilterOptions
    • 🪢NodeOptions
    • 📡NodeStats
    • 🔎SEARCH_SOURCE
  • 📑Enums
    • ConnectionState
    • NodeState
Powered by GitBook
On this page
  • Constructor
  • Properties
  • Methods
  • Versions
  1. Docs

Node

Represents a lavalink node structure

Methods

Constructor

new Node(options)

Parameter
Description
Type

options

The Node options

Properties

Name
Description
Type

state

The connection state between client and lavalink

stats

The stats of the node

versions

The versions object *

options

The node options

identifier

The node identifier

Methods

connect()

Connects to the lavalink node (this method is called automatically on Vulkava#start() )

disconnect()

Disconnects the lavalink node

ping()

Returns
Description

The latency value

send()

Sends a payload to the lavalink node via WebSocket

Parameter
Description

payload

getRecord()

Gets the recorded audio file

Parameter
Description

guildId

id

Returns
Description

The audio file buffer

getAllRecords()

Gets a list with the ids of all recordings from the guild.

Parameter
Description

guildId

Returns
Description

An array of ids

deleteRecord()

Deletes one specific recorded audio file.

Parameter
Description

guildId

id

deleteAllRecords()

Deletes all records from the guild.

Parameter
Description

guildId

Versions

Property
Description

LAVAPLAYER

JVM

BUILD

BUILDTIME

SPRING

KOTLIN

PreviousFiltersNextTrack

Last updated 2 years ago

|

* Only works on

Gets the latency between client and the lavalink node (this function only works on )

<>

The payload object

The guild id

The record id

<>

The guild id

<<>>

The guild id

The record id

The guild id

The lavaplayer version

The java version

The build number

Timestamp of when .jar was built

The spring boot version

The kotlin version

📚
🪢
my custom lavalink version
my custom lavalink version
NodeOptions
NodeState
NodeStats
NodeOptions
String
Promise
Number
Object
String
String
Promise
Buffer
String
Promise
Array
String
String
String
String
String
String
String
Number
String
String
connect
disconnect
ping
send
getRecord
getAllRecords
deleteRecord
deleteAllRecords
null
Versions