Interface VoiceFilter

public interface VoiceFilter
Interface representing a real-time Digital Signal Processing (DSP) voice filter. Operates directly on 16-bit 48kHz PCM audio samples.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    getId()
    Unique identifier of the filter (e.g.
    @NotNull String
    getName()
    Human-readable display name of the filter.
    default int
    getPriority()
    Execution priority when multiple filters are chained (higher runs first).
    short[]
    process(short @NotNull [] samples, @Nullable VPlayer player)
    Processes an array of 16-bit PCM audio samples.
    default void
    resetState(@NotNull UUID playerUuid)
    Resets any stateful DSP history/buffers (e.g.

  • Method Details

    • getId

      @NotNull @NotNull String getId()
      Unique identifier of the filter (e.g. "disguise", "robot", "phone").
      Returns:
      the filter ID

    • getName

      @NotNull @NotNull String getName()
      Human-readable display name of the filter.
      Returns:
      the filter name

    • getPriority

      default int getPriority()
      Execution priority when multiple filters are chained (higher runs first).
      Returns:
      the priority integer

    • process

      short[] process(short @NotNull [] samples, @Nullable @Nullable VPlayer player)
      Processes an array of 16-bit PCM audio samples.
      Parameters:
      samples - raw 16-bit 48kHz audio PCM samples
      player - optional target player context
      Returns:
      modified audio samples

    • resetState

      default void resetState(@NotNull @NotNull UUID playerUuid)
      Resets any stateful DSP history/buffers (e.g. delays, ring modulators) for a specific player.
      Parameters:
      playerUuid - the UUID of the player