TypeDefs

Technical definitions for KawaLink data structures.

ManagerEvents

interface

List of all events emitted by the Manager.

interface ManagerEvents { ... }

nowPlayingMessage

interface

Shape of the now-playing message object sent by the player.

interface nowPlayingMessage { ... }

payload

interface

Raw payload structure sent over the WebSocket to Lavalink.

interface payload { ... }

playOptions

interface

Configuration object used when calling player.play().

interface playOptions { ... }

searchResult

interface

The result object returned from manager.search().

interface searchResult { ... }

stats

interface

Performance metrics from the Lavalink node.

interface stats { ... }

track

interface

The standard track object used throughout the library.

interface track { ... }

trackData

interface

Raw track data returned directly from Lavalink.

interface trackData { ... }

trackExceptionEvent

interface

Fired when a track encounters a playback exception.

interface trackExceptionEvent { ... }

trackStartEvent

interface

Fired when a track begins playing.

interface trackStartEvent { ... }

trackStuckEvent

interface

Fired when a track gets stuck during playback.

interface trackStuckEvent { ... }

unresolvedTrack

interface

A track that requires additional resolution before playback.

interface unresolvedTrack { ... }

voicePacket

interface

Discord voice packet used for connection state.

interface voicePacket { ... }

voiceState

interface

Represents the current voice connection state of a player.

interface voiceState { ... }

webSocketClosedEvent

interface

Fired when the WebSocket connection to Lavalink closes.

interface webSocketClosedEvent { ... }