Package dev.arbjerg.lavalink.api

Interface AudioFilterExtension

public interface AudioFilterExtension
This interface allows defining custom Lavaplayer audio filters. It is configured via the "filters" WebSocket op. The extension is used when a "filters" operation is received which has a value equal to getName()

  • Method Summary

    Modifier and Type Method Description
    default com.sedmelluq.discord.lavaplayer.filter.FloatPcmAudioFilter build​(com.fasterxml.jackson.databind.JsonNode data, com.sedmelluq.discord.lavaplayer.format.AudioDataFormat format, com.sedmelluq.discord.lavaplayer.filter.FloatPcmAudioFilter output)
    Builds a filter for a particular player.
    default com.sedmelluq.discord.lavaplayer.filter.FloatPcmAudioFilter build​(org.json.JSONObject data, com.sedmelluq.discord.lavaplayer.format.AudioDataFormat format, com.sedmelluq.discord.lavaplayer.filter.FloatPcmAudioFilter output)
    Deprecated.
    As of v3.7 Jackson is the preferred way of JSON serialization, use build(JsonNode, AudioDataFormat, FloatPcmAudioFilter) instead.
    java.lang.String getName()  
    default boolean isEnabled​(com.fasterxml.jackson.databind.JsonNode data)  
    default boolean isEnabled​(org.json.JSONObject data)
    Deprecated.
    As of v3.7 Jackson is the preferred way of JSON serialization, use isEnabled(JsonNode) instead.

  • Method Details

    • getName

      java.lang.String getName()
      Returns:
      The key of the filter

    • build

      @Deprecated default com.sedmelluq.discord.lavaplayer.filter.FloatPcmAudioFilter build​(org.json.JSONObject data, com.sedmelluq.discord.lavaplayer.format.AudioDataFormat format, com.sedmelluq.discord.lavaplayer.filter.FloatPcmAudioFilter output)
      Deprecated.
      As of v3.7 Jackson is the preferred way of JSON serialization, use build(JsonNode, AudioDataFormat, FloatPcmAudioFilter) instead.
      Builds a filter for a particular player.
      Parameters:
      data - JSON data received from the client under the extension name key.
      format - format as specified by Lavaplayer.
      output - the output to be used by the produced filter.
      Returns:
      a filter which produces the desired audio effect.

    • build

      default com.sedmelluq.discord.lavaplayer.filter.FloatPcmAudioFilter build​(com.fasterxml.jackson.databind.JsonNode data, com.sedmelluq.discord.lavaplayer.format.AudioDataFormat format, com.sedmelluq.discord.lavaplayer.filter.FloatPcmAudioFilter output)
      Builds a filter for a particular player.
      Parameters:
      data - JSON data received from the client under the extension name key.
      format - format as specified by Lavaplayer.
      output - the output to be used by the produced filter.
      Returns:
      a filter which produces the desired audio effect.

    • isEnabled

      @Deprecated default boolean isEnabled​(org.json.JSONObject data)
      Deprecated.
      As of v3.7 Jackson is the preferred way of JSON serialization, use isEnabled(JsonNode) instead.
      Parameters:
      data - JSON data received from the client under the extension name key.
      Returns:
      whether to build a filter. Returning false makes this extension do nothing.

    • isEnabled

      default boolean isEnabled​(com.fasterxml.jackson.databind.JsonNode data)
      Parameters:
      data - JSON data received from the client under the extension name key.
      Returns:
      whether to build a filter. Returning false makes this extension do nothing.