lavalink-client/dev.arbjerg.lavalink.client.player/FilterBuilder

FilterBuilder

class FilterBuilder

Helper class fo builder Filters.

Constructors

constructor()

Functions

fun build(): Filters

Builds the Filters object with the current configuration.

removePluginFilter

fun removePluginFilter(name: String): FilterBuilder

Removes a plugin filter with the given name.

fun setChannelMix(channelMix: ChannelMix?): FilterBuilder

Sets the channel mix filter on the player.

fun setDistortion(distortion: Distortion?): FilterBuilder

Sets the distortion filter on the player.

fun setEqualizer(equalizer: List<Band>): FilterBuilder

Set the equalizer bands on the player.

setEqualizerBand

fun setEqualizerBand(band: Int, gain: Float = 1.0f): FilterBuilder

Set a specific band on the equalizer.

fun setKaraoke(karaoke: Karaoke?): FilterBuilder

Set the karaoke filter on the player.

fun setLowPass(lowPass: LowPass?): FilterBuilder

Sets the low pass filter on the player.

setPluginFilter

fun setPluginFilter(name: String, filter: Any): FilterBuilder

fun setPluginFilter(name: String, filter: JsonElement): FilterBuilder

Set custom filter data for a plugin.

fun setRotation(rotation: Rotation?): FilterBuilder

Sets the rotation filter on the player.

fun setTimescale(timescale: Timescale?): FilterBuilder

Sets the timescale filter on the player.

fun setTremolo(tremolo: Tremolo?): FilterBuilder

Sets the tremolo filter on the player.

fun setVibrato(vibrato: Vibrato?): FilterBuilder

Sets the vibrato filter on the player.

fun setVolume(volume: Float): FilterBuilder

Sets the filter volume. If you just want to change the volume, it is highly recommended to use dev.arbjerg.lavalink.client.IUpdatablePlayer.setVolume instead.