Interface AudioFilterExtension

  • All Implemented Interfaces:

    
    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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      FloatPcmAudioFilter build(JsonElement data, AudioDataFormat format, FloatPcmAudioFilter output) Builds a filter for a particular player.
      Boolean isEnabled(JsonElement data) Checks if this filter is enabled.
      abstract String getName() The key of the filter.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • build

         FloatPcmAudioFilter build(JsonElement data, AudioDataFormat format, 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.
      • isEnabled

         Boolean isEnabled(JsonElement data)

        Checks if this filter is enabled.

        Parameters:
        data - JSON data received from the client under the extension name key.