Skip to content

Commit

Permalink
update significant changes & fix plugin filters link
Browse files Browse the repository at this point in the history
  • Loading branch information
@topi314
topi314 committed Dec 9, 2023
1 parent 031a9fb commit 9ff9f07
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
26 changes: 13 additions & 13 deletions docs/api/rest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -361,19 +361,19 @@ with the Voice Server Update. Please refer to https://discord.com/developers/doc

Filters are used in above requests and look like this

| Field | Type | Description |
|----------------|------------------------------------------------|----------------------------------------------------------------------------------------------|
| volume? | float | Adjusts the player volume from 0.0 to 5.0, where 1.0 is 100%. Values >1.0 may cause clipping |
| equalizer? | array of [Equalizer](#equalizer) objects | Adjusts 15 different bands |
| karaoke? | [Karaoke](#karaoke) object | Eliminates part of a band, usually targeting vocals |
| timescale? | [Timescale](#timescale) object | Changes the speed, pitch, and rate |
| tremolo? | [Tremolo](#tremolo) object | Creates a shuddering effect, where the volume quickly oscillates |
| vibrato? | [Vibrato](#vibrato) object | Creates a shuddering effect, where the pitch quickly oscillates |
| rotation? | [Rotation](#rotation) object | Rotates the audio around the stereo channels/user headphones (aka Audio Panning) |
| distortion? | [Distortion](#distortion) object | Distorts the audio |
| channelMix? | [Channel Mix](#channel-mix) object | Mixes both channels (left and right) |
| lowPass? | [Low Pass](#low-pass) object | Filters higher frequencies |
| pluginFilters? | map of [Plugin Filter](#plugin-filter) objects | Filter plugin configurations |
| Field | Type | Description |
|----------------|--------------------------------------------------|----------------------------------------------------------------------------------------------|
| volume? | float | Adjusts the player volume from 0.0 to 5.0, where 1.0 is 100%. Values >1.0 may cause clipping |
| equalizer? | array of [Equalizer](#equalizer) objects | Adjusts 15 different bands |
| karaoke? | [Karaoke](#karaoke) object | Eliminates part of a band, usually targeting vocals |
| timescale? | [Timescale](#timescale) object | Changes the speed, pitch, and rate |
| tremolo? | [Tremolo](#tremolo) object | Creates a shuddering effect, where the volume quickly oscillates |
| vibrato? | [Vibrato](#vibrato) object | Creates a shuddering effect, where the pitch quickly oscillates |
| rotation? | [Rotation](#rotation) object | Rotates the audio around the stereo channels/user headphones (aka Audio Panning) |
| distortion? | [Distortion](#distortion) object | Distorts the audio |
| channelMix? | [Channel Mix](#channel-mix) object | Mixes both channels (left and right) |
| lowPass? | [Low Pass](#low-pass) object | Filters higher frequencies |
| pluginFilters? | map of [Plugin Filters](#plugin-filters) objects | Filter plugin configurations |

##### Equalizer

Expand Down
2 changes: 1 addition & 1 deletion docs/changelog/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The most noteworthy of these, as well as any features and breaking changes, are

All websocket ops are removed as of `v4.0.0` and replaced with the following endpoints and json fields:

* `play` -> [Update Player Endpoint](#update-player) `encodedTrack` or `identifier` field
* `play` -> [Update Player Endpoint](#update-player) `track`->`encoded` or `track`->`identifier` field
* `stop` -> [Update Player Endpoint](#update-player) `encodedTrack` field with `null`
* `pause` -> [Update Player Endpoint](#update-player) `pause` field
* `seek` -> [Update Player Endpoint](#update-player) `position` field
Expand Down

0 comments on commit 9ff9f07

Please sign in to comment.