core/dev.schlaubi.lavakord.audio.player

Package-level declarations

Types

@Serializable

data class Equalizer(val band: Int, val gain: Float)

There are 15 equalizers (0-14) that can be changed.

EqualizerBuilder

interface EqualizerBuilder

Builder for equalizer settings.

interface Filters : EqualizerBuilder

Representation of the filter configuration.

LavaplayerTrack

data class LavaplayerTrack(val version: Byte, val track: String, val title: String, val author: String, val length: Duration, val identifier: String, val isStream: Boolean, val isSeekable: Boolean, val uri: String?, val source: String, val position: Duration)

Representation of a Lavalink audio track.

interface Player : EventSource<Event>

Interface allowing interaction with Lavalink player.

class PlayOptions

Options for playing a new track.

Properties

const val DEFAULT_GAIN: Float = 0.0f

The default gain of all equalizers

val Player.guildId: ULong

Returns the guildId for a Player.

val Player.node: Node

Retrieves the RestNode behind a Player.

Functions

suspend fun Player.applyFilters(block: Filters.() -> Unit)

Applies all Filters to this player.

fun Filters.channelMix(block: Filters.ChannelMix.() -> Unit)

Configures the Filters.ChannelMix filter.

fun Filters.distortion(block: Filters.Distortion.() -> Unit)

Configures the Filters.Distortion filter.

infix fun EqualizerBuilder.BandConfigurator.gain(gain: Float)

Sets the gain of this band to gain.

fun Filters.karaoke(block: Filters.Karaoke.() -> Unit)

Configures the Filters.Karaoke filter.

fun Filters.lowPass(block: Filters.LowPass.() -> Unit)

Configures the Filters.LowPass filter.

inline fun Filters.pluginFilter(name: String, builder: JsonObjectBuilder.() -> Unit)

Registers a plugin based filter with name.

fun EqualizerBuilder.BandConfigurator.reset()

Resets the gain of this band to default.

suspend fun Player.resetFilters()

Resets all applied filters.

fun Filters.rotation(block: Filters.Rotation.() -> Unit)

Configures the Filters.Rotation filter.

fun Filters.timescale(block: Filters.Timescale.() -> Unit)

Configures the Filters.Timescale filter.

fun Filters.tremolo(block: Filters.Tremolo.() -> Unit)

Configures the Filters.Tremolo filter.

fun Filters.vibrato(block: Filters.Vibrato.() -> Unit)

Configures the Filters.Vibrato filter.