LavaKord

interface LavaKord : CoroutineScope, EventSource<Event>

Representation of a Lavalink cluster.

Properties

open override val coroutineScope: CoroutineScope

This simply returns this. It is required for implementations of EventSource

abstract override val events: Flow<Event>

A merged Flow of Events produced by this instance's Nodes

abstract val nodes: List<Node>

list of Nodes in this cluster

Configuration options (See LavaKordOptions

abstract val userId: ULong

the id of the Discord bot user

abstract fun addNode(serverUri: Url, password: String, name: String? = null, session: String? = null)

open fun addNode(serverUri: String, password: String, name: String? = null, session: String? = null)

Adds a new node to this cluster.

abstract fun createRestNode(serverUri: Url, password: String, name: String? = null): RestNode

Creates and returns a new rest-only node.

open fun getLink(guildId: String): Link

abstract fun getLink(guildId: ULong): Link

Returns the corresponding Link for the guildId.

inline fun <T : Any, E : T> EventSource<T>.on(scope: CoroutineScope = coroutineScope, noinline consumer: suspend E.() -> Unit): Job

Convenience method that will invoke the consumer on every event T created by EventSource.events.

inline fun <T : Event> EventSource<Event>.on(scope: CoroutineScope = coroutineScope, noinline consumer: suspend T.() -> Unit): Job

Listens for a TrackEvent

open fun removeNode(node: Node)

Removes the node.

abstract fun removeNode(name: String)

Removes a node from the cluster by its name.