core/dev.schlaubi.lavakord.audio.player/Filters

Filters

interface Filters : EqualizerBuilder

Representation of the filter configuration.

Types

interface ChannelMix : Filters.Filter

Mixes both channels (left and right), with a configurable factor on how much each channel affects the other. With the defaults, both channels are kept independent from each other. Setting all factors to 0.5 means both channels get the same audio.

interface Distortion : Filters.Filter

Distortion effect. It can generate some pretty unique audio effects.

interface Filter

Root interface for a resettable filter.

interface Karaoke : Filters.Filter

Uses equalization to eliminate part of a band, usually targeting vocals.

interface LowPass : Filters.Filter

Higher frequencies get suppressed, while lower frequencies pass through this filter, thus the name low pass.

interface Rotation : Filters.Filter

Rotates the sound around the stereo channels/user headphones aka Audio Panning. It can produce an effect similar to: https://youtu.be/QB9EB8mTKcc (without the reverb)

interface Timescale : Filters.Filter

Changes the speed, pitch, and rate. All default to 1.

interface Tremolo : Filters.Filter

Uses amplification to create a shuddering effect, where the volume quickly oscillates. Example: https://en.wikipedia.org/wiki/File:Fuse_Electronics_Tremolo_MK-III_Quick_Demo.ogv

interface Vibrato : Filters.Tremolo

Similar to Tremolo. While tremolo oscillates the volume, vibrato oscillates the pitch.

Properties

abstract val channelMix: Filters.ChannelMix?

abstract val distortion: Filters.Distortion?

abstract val equalizers: MutableList<Equalizer>

The equalizers to modify.

abstract val karaoke: Filters.Karaoke?

abstract val lowPass: Filters.LowPass?

abstract val pluginFilters: MutableMap<String, JsonElement>

abstract val rotation: Filters.Rotation?

abstract val timescale: Filters.Timescale?

abstract val tremolo: Filters.Tremolo?

abstract val vibrato: Filters.Vibrato?

abstract var volume: Float?

Functions

open fun band(band: Int): EqualizerBuilder.BandConfigurator

Gives you a BandConfigurator to configure this band.

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

Configures the Filters.ChannelMix filter.

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

Configures the Filters.Distortion filter.

open infix fun Int.gain(gain: Float)

Sets the gain of the band with this int as it's id 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.

open override fun reset()

Unsets all filters and resets equalizer equalizers

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.

unsetChannelMix

abstract fun unsetChannelMix()

Unsets the ChannelMix filter, this disables the filter

unsetDistortion

abstract fun unsetDistortion()

Unsets the Distortion filter, this disables the filter

abstract fun unsetKaraoke()

Unsets the Karaoke filter, this disables the filter

abstract fun unsetLowPass()

Unsets the LowPass filter, this disables the filter

abstract fun unsetRotation()

Unsets the Rotation filter, this disables the filter

abstract fun unsetTimescale()

Unsets the Timescale filter, this disables the filter

abstract fun unsetTremolo()

Unsets the Tremolo filter, this disables the filter

abstract fun unsetVibrato()

Unsets the Vibrato filter, this disables the filter

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

Configures the Filters.Vibrato filter.