protocol/dev.arbjerg.lavalink.protocol.v4

Package-level declarations

Types

@Serializable

data class Band(val band: Int, val gain: Float = 1.0f)

@Serializable

data class ChannelMix(val leftToLeft: Float = 1.0f, val leftToRight: Float = 0.0f, val rightToLeft: Float = 0.0f, val rightToRight: Float = 1.0f)

Cpu

@Serializable

data class Cpu(val cores: Int, val systemLoad: Double, val lavalinkLoad: Double)

Cpu statistics.

Distortion

@Serializable

data class Distortion(val sinOffset: Float = 0.0f, val sinScale: Float = 1.0f, val cosOffset: Float = 0.0f, val cosScale: Float = 1.0f, val tanOffset: Float = 0.0f, val tanScale: Float = 1.0f, val offset: Float = 0.0f, val scale: Float = 1.0f)

EncodedTracks

@Serializable

@JvmInline

value class EncodedTracks(val tracks: ArrayList<String>)

Error

@Serializable

data class Error(val timestamp: Timestamp, val status: Int, val error: String, val trace: String? = null, val message: String, val path: String)

Representation of a REST error.

Exception

@Serializable

data class Exception(val message: String?, val severity: Exception.Severity, val cause: String) : LoadResult.Data

Filters

@Serializable

data class Filters(val volume: Omissible<Float> = Omissible.Omitted(), val equalizer: Omissible<List<Band>> = Omissible.Omitted(), val karaoke: Omissible<Karaoke?> = Omissible.Omitted(), val timescale: Omissible<Timescale?> = Omissible.Omitted(), val tremolo: Omissible<Tremolo?> = Omissible.Omitted(), val vibrato: Omissible<Vibrato?> = Omissible.Omitted(), val distortion: Omissible<Distortion?> = Omissible.Omitted(), val rotation: Omissible<Rotation?> = Omissible.Omitted(), val channelMix: Omissible<ChannelMix?> = Omissible.Omitted(), val lowPass: Omissible<LowPass?> = Omissible.Omitted(), val pluginFilters: Map<String, JsonElement> = mutableMapOf())

FrameStats

@Serializable

data class FrameStats(val sent: Int, val nulled: Int, val deficit: Int)

Frame statistics.

Git

@Serializable

data class Git(val branch: String, val commit: String, val commitTime: Long)

Info

@Serializable

data class Info(val version: Version, val buildTime: Long, val git: Git, val jvm: String, val lavaplayer: String, val sourceManagers: List<String>, val filters: List<String>, val plugins: Plugins)

Representation of LavaLink server information.

Karaoke

@Serializable

data class Karaoke(val level: Float = 1.0f, val monoLevel: Float = 1.0f, val filterBand: Float = 220.0f, val filterWidth: Float = 100.0f)

LoadResult

@Serializable(with = LoadResult.Serializer::class)

interface LoadResult

LowPass

@Serializable

data class LowPass(val smoothing: Float = 20.0f)

Memory

@Serializable

data class Memory(val free: Long, val used: Long, val allocated: Long, val reservable: Long)

Memory statistics.

Message

@Serializable(with = Message.Serializer::class)

interface Message

OmissableSerializer

class OmissableSerializer<T>(childSerializer: KSerializer<T>) : KSerializer<Omissible<T>>

Omissible

@Serializable(with = OmissableSerializer::class)

interface Omissible<out T>

Player

@Serializable

data class Player(val guildId: String, val track: Track?, val volume: Int, val paused: Boolean, val state: PlayerState, val voice: VoiceState, val filters: Filters)

Players

@Serializable

@JvmInline

value class Players(val players: List<Player>)

PlayerState

@Serializable

data class PlayerState(val time: Long, val position: Long, val connected: Boolean, val ping: Long)

PlayerUpdate

@Serializable

data class PlayerUpdate(val encodedTrack: Omissible<String?> = Omissible.Omitted(), val identifier: Omissible<String> = Omissible.Omitted(), val track: Omissible<PlayerUpdateTrack> = Omissible.Omitted(), val position: Omissible<Long> = Omissible.Omitted(), val endTime: Omissible<Long?> = Omissible.Omitted(), val volume: Omissible<Int> = Omissible.Omitted(), val paused: Omissible<Boolean> = Omissible.Omitted(), val filters: Omissible<Filters> = Omissible.Omitted(), val voice: Omissible<VoiceState> = Omissible.Omitted())

PlayerUpdateTrack

@Serializable

data class PlayerUpdateTrack(val encoded: Omissible<String?> = Omissible.Omitted(), val identifier: Omissible<String> = Omissible.Omitted(), val userData: Omissible<JsonObject> = Omissible.Omitted())

Playlist

@Serializable

data class Playlist(val info: PlaylistInfo, val pluginInfo: JsonObject = JsonObject(emptyMap()), val tracks: List<Track>) : LoadResult.Data

PlaylistInfo

@Serializable

data class PlaylistInfo(val name: String, val selectedTrack: Int)

Plugin

@Serializable

data class Plugin(val name: String, val version: String)

Plugins

@JvmInline

@Serializable(with = Plugins.Serializer::class)

value class Plugins(val plugins: List<Plugin>)

ResultStatus

@Serializable

enum ResultStatus : Enum<ResultStatus>

Rotation

@Serializable

data class Rotation(val rotationHz: Double = 0.0)

RoutePlannerFreeAddress

@Serializable

data class RoutePlannerFreeAddress(val address: String)

RoutePlannerStatus

@Serializable

interface RoutePlannerStatus

Session

@Serializable

data class Session(val resuming: Boolean, val timeoutSeconds: Long)

Representation of a session.

SessionUpdate

@Serializable

data class SessionUpdate(val resuming: Omissible<Boolean> = Omissible.Omitted(), val timeoutSeconds: Omissible<Long> = Omissible.Omitted())

Request used to update a session.

Stats

interface Stats

Representation of node stats.

StatsData

@Serializable

data class StatsData(val frameStats: FrameStats? = null, val players: Int, val playingPlayers: Int, val uptime: Long, val memory: Memory, val cpu: Cpu) : Stats

Default implementation of Stats.

Timescale

@Serializable

data class Timescale(val speed: Double = 1.0, val pitch: Double = 1.0, val rate: Double = 1.0)

Track

@Serializable

data class Track(val encoded: String, val info: TrackInfo, val pluginInfo: JsonObject = JsonObject(emptyMap()), val userData: JsonObject = JsonObject(emptyMap())) : LoadResult.Data

TrackInfo

@Serializable

data class TrackInfo(val identifier: String, val isSeekable: Boolean, val author: String, val length: Long, val isStream: Boolean, val position: Long, val title: String, val uri: String?, val sourceName: String, val artworkUrl: String?, val isrc: String?)

Tracks

@Serializable

@JvmInline

value class Tracks(val tracks: List<Track>)

Tremolo

@Serializable