Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OutgoingFilterPayload

note

This is not available in Lavalink v3.3.

Hierarchy

Index

Properties

channelMix?: ChannelMixOptions

The channel mix options.

distortion?: DistortionOptions

The distortion options.

equalizer?: readonly EqualizerBand[]

The equalizer bands, there are 15 bands (0-14) that can be changed.

guildId: string

The guild's ID to identify the player.

karaoke?: KaraokeOptions

The karaoke options, uses equalization to eliminate a part of a band, usually targeting vocals.

lowPass?: LowPassOptions

The low pass options.

op: "filters"
rotation?: RotationOptions

The rotation options. This rotates the sound around the stereo channels/user headphones, also known as Audio Panning.

timescale?: TimescaleOptions

The timescale options, used to change the speed, pitch, and rate.

The tremolo options, uses amplification to create a shuddering effect, where the volume quickly oscillates, example.

The vibrato options. Similar to tremolo, while tremolo oscillates the volume, vibrato oscillates the pitch.

volume?: number

The volume to set the track. Valid values range from 0 to 5.0, where 0 means the stream is completely muted, and 2 means it is doubled.

range

[0, 5]

Generated using TypeDoc