Skip to content

feat: add optional transition support to filter payloads #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ParrotXray merged 1 commit into from
Aug 26, 2026
Merged

feat: add optional transition support to filter payloads #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/hdi/filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,18 @@ by all filters.

:::

:::{note}

Every filter also takes an optional keyword-only `transition: dict`, not listed below since it's
shared by all filters. Use it to smoothly animate the filter's parameters instead of applying
them instantly. Only honored by NodeLink v3.7.0+, ignored on plain Lavalink or older NodeLink.
Accepted keys: `durationMs` (int, must be greater than `0`) and `curve` (str, one of `linear`,
`exponential`, `sinusoidal`). NodeLink falls back to `sinusoidal` server-side if `curve` is
omitted or not one of these. `transition` is ignored entirely if `durationMs` is missing or
`<= 0` — the filter is applied instantly in that case, same as when `transition` isn't passed
at all.
:::

:::{list-table}
:header-rows: 1

Expand All @@ -141,7 +153,7 @@ by all filters.

* - `LowPass`
- `smoothing=20`
- No validation. Payload key is `lowPass`.
- No validation. Sent under both `lowPass` (Lavalink) and `lowpass` (NodeLink < 3.7.0) keys.

* - `Rotation`
- `rotation_hertz=5`
Expand Down
Loading