lavalink-client/dev.arbjerg.lavalink.client/LavalinkNode

LavalinkNode

class LavalinkNode(nodeOptions: NodeOptions, val lavalink: LavalinkClient) : Disposable, Closeable

The Node is a physical instance of the lavalink server software.

Constructors

constructor(nodeOptions: NodeOptions, lavalink: LavalinkClient)

Properties

var available: Boolean

val baseUri: String

val flux: Flux<ClientEvent>

val lavalink: LavalinkClient

val name: String

val password: String

val penalties: Penalties

val regionFilter: IRegionFilter?

var sessionId: String?

var stats: Stats?

val ws: LavalinkSocket

Functions

open override fun close()

createOrUpdatePlayer

fun createOrUpdatePlayer(guildId: Long): PlayerUpdateBuilder

Creates or updates a player.

customJsonRequest

inline fun <T> customJsonRequest(builderFn: UnaryOperator<HttpBuilder>): Mono<T>

fun <T> customJsonRequest(decodeTo: Class<T>, builderFn: UnaryOperator<HttpBuilder>): Mono<T>

fun <T> customJsonRequest(deserializer: DeserializationStrategy<T>, builderFn: UnaryOperator<HttpBuilder>): Mono<T>

Send a custom request to the lavalink node. Any host and port you set will be replaced with the node host automatically. The scheme must match your node's scheme, however. The response body will be deserialized using the provided deserializer.

fun customRequest(builderFn: UnaryOperator<HttpBuilder>): Mono<Response>

Send a custom request to the lavalink node. Any host and port you set will be replaced with the node host automatically. The scheme must match your node's scheme, however.

fun decodeTrack(encoded: String): Mono<Track>

Uses the node to decode a base64 encoded track.

fun decodeTracks(encoded: List<String>): Mono<List<Track>>

Uses the node to decode a list of base64 encoded tracks.

destroyPlayerAndLink

fun destroyPlayerAndLink(guildId: Long): Mono<Unit>

Destroy a guild's player and remove it from the cache. This will also remove the associated link from the client.

open override fun dispose()

open operator override fun equals(other: Any?): Boolean

getCachedPlayer

fun getCachedPlayer(guildId: Long): LavalinkPlayer?

Get a LavalinkPlayer from the player cache.

fun getNodeInfo(): Mono<Info>

Get information about the node.

fun getPlayer(guildId: Long): Mono<LavalinkPlayer>

Gets the player from the guild id. If the player is not cached, it will be retrieved from the server. If the player does not exist on the node, it will be created.

fun getPlayers(): Mono<List<LavalinkPlayer>>

Retrieves a list of all players from the lavalink node.

open override fun hashCode(): Int

open fun isDisposed(): Boolean

fun loadItem(identifier: String): Mono<LavalinkLoadResult>

Load an item for the player.

inline fun <T : ClientEvent> on(): Flux<T>

fun <T : ClientEvent> on(type: Class<T>): Flux<T>

Listen to events from the node. Please note that uncaught exceptions will cause the listener to stop emitting events.

open override fun toString(): String

fun updatePlayer(guildId: Long, updateConsumer: Consumer<PlayerUpdateBuilder>): Mono<LavalinkPlayer>