Class RainlinkFilter

constructor

• new RainlinkFilter(player): RainlinkFilter

• Parameters

  • player: RainlinkPlayer

  Returns RainlinkFilter

currentFilter

set

• set(filter): Promise<RainlinkPlayer>

• Set a filter that prebuilt in rainlink

  Parameters

  • filter:
        | "pop"
        | "clear"
        | "eightD"
        | "soft"
        | "speed"
        | "karaoke"
        | "nightcore"
        | "vaporwave"
        | "bass"
        | "party"
        | "earrape"
        | "equalizer"
        | "electronic"
        | "radio"
        | "tremolo"
        | "treblebass"
        | "vibrato"
        | "china"
        | "chimpunk"
        | "darthvader"
        | "daycore"
        | "doubletime"
        | "pitch"
        | "rate"
        | "slow"

    The filter name

  Returns Promise<RainlinkPlayer>

  RainlinkPlayer

clear

• clear(): Promise<RainlinkPlayer>

• Clear all the filter

  Returns Promise<RainlinkPlayer>

  RainlinkPlayer

setVolume

• setVolume(volume): Promise<RainlinkPlayer>

• Sets the filter volume of the player

  Parameters

  • volume: number

    Target volume 0.0-5.0

  Returns Promise<RainlinkPlayer>

setEqualizer

• setEqualizer(equalizer): Promise<RainlinkPlayer>

• Change the equalizer settings applied to the currently playing track

  Parameters

  • equalizer: Band[]

    An array of objects that conforms to the Bands type that define volumes at different frequencies

  Returns Promise<RainlinkPlayer>

setKaraoke

• setKaraoke(karaoke?): Promise<RainlinkPlayer>

• Change the karaoke settings applied to the currently playing track

  Parameters

  • Optionalkaraoke: Karaoke

    An object that conforms to the KaraokeSettings type that defines a range of frequencies to mute

  Returns Promise<RainlinkPlayer>

setTimescale

• setTimescale(timescale?): Promise<RainlinkPlayer>

• Change the timescale settings applied to the currently playing track

  Parameters

  • Optionaltimescale: Timescale

    An object that conforms to the TimescaleSettings type that defines the time signature to play the audio at

  Returns Promise<RainlinkPlayer>

setTremolo

• setTremolo(tremolo?): Promise<RainlinkPlayer>

• Change the tremolo settings applied to the currently playing track

  Parameters

  • Optionaltremolo: Freq

    An object that conforms to the FreqSettings type that defines an oscillation in volume

  Returns Promise<RainlinkPlayer>

setVibrato

• setVibrato(vibrato?): Promise<RainlinkPlayer>

• Change the vibrato settings applied to the currently playing track

  Parameters

  • Optionalvibrato: Freq

    An object that conforms to the FreqSettings type that defines an oscillation in pitch

  Returns Promise<RainlinkPlayer>

setRotation

• setRotation(rotation?): Promise<RainlinkPlayer>

• Change the rotation settings applied to the currently playing track

  Parameters

  • Optionalrotation: Rotation

    An object that conforms to the RotationSettings type that defines the frequency of audio rotating round the listener

  Returns Promise<RainlinkPlayer>

setDistortion

• setDistortion(distortion?): Promise<RainlinkPlayer>

• Change the distortion settings applied to the currently playing track

  Parameters

  • Optionaldistortion: Distortion

    An object that conforms to DistortionSettings that defines distortions in the audio

  Returns Promise<RainlinkPlayer>

  The current player instance

setChannelMix

• setChannelMix(channelMix?): Promise<RainlinkPlayer>

• Change the channel mix settings applied to the currently playing track

  Parameters

  • OptionalchannelMix: ChannelMix

    An object that conforms to ChannelMixSettings that defines how much the left and right channels affect each other (setting all factors to 0.5 causes both channels to get the same audio)

  Returns Promise<RainlinkPlayer>

setLowPass

• setLowPass(lowPass?): Promise<RainlinkPlayer>

• Change the low pass settings applied to the currently playing track

  Parameters

  • OptionallowPass: LowPass

    An object that conforms to LowPassSettings that defines the amount of suppression on higher frequencies

  Returns Promise<RainlinkPlayer>

setRaw

• setRaw(filter): Promise<RainlinkPlayer>

• Set a custom filter

  Parameters

  • filter: FilterOptions

    The filter name

  Returns Promise<RainlinkPlayer>

  RainlinkPlayer