lavalink-client/dev.arbjerg.lavalink.client/Link

Link

class Link(val guildId: Long, node: LavalinkNode)

A "Link" for linking a guild id to a node. Mainly just a data class that contains some shortcuts to the node. You should never store a link as it might be replaced internally without you knowing.

Constructors

Link

constructor(guildId: Long, node: LavalinkNode)

Properties

guildId

val guildId: Long

node

var node: LavalinkNode

state

var state: LinkState

The voice connection state of this link

Functions

createOrUpdatePlayer

fun createOrUpdatePlayer(): PlayerUpdateBuilder

Creates or updates the player for this link.

destroyPlayer

fun destroyPlayer(): Mono<Unit>

Destroys the player for this link. This will also remove the link from the client.

equals

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

getOrAssumePlayer

fun getOrAssumePlayer(): LavalinkPlayer

Gets the cached player for this link. If the player is not cached it will be created locally.

getPlayer

fun getPlayer(): Mono<LavalinkPlayer>

Gets the player for this link. If the player is not cached, it will be retrieved or created on the server.

hashCode

open override fun hashCode(): Int

loadItem

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

Load an item for the player.

onVoiceServerUpdate

fun onVoiceServerUpdate(newVoiceState: VoiceState)

updatePlayer

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