Skip to content

Commit

Permalink
Merge branch 'master' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
@topi314
topi314 authored Feb 5, 2024
2 parents c4351be + c2431ce commit 15fd02b
Show file tree
Hide file tree
Showing 9 changed files with 59 additions and 52 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ A [basic example bot](Testbot) is available.
* Basic authentication
* Prometheus metrics
* Docker images
* [Plugin support](PLUGINS.md)
* [Plugin support](https://lavalink.dev/plugins.html)

## Requirements

Expand Down
68 changes: 34 additions & 34 deletions docs/api/rest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ When Lavalink encounters an error, it will respond with a JSON object containing
| message | string | The error message |
| path | string | The request path |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -128,7 +128,7 @@ Response:

[Track](#track) object with the loaded track.

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand All @@ -153,7 +153,7 @@ Response:
| pluginInfo | Object | Addition playlist info provided by plugins |
| tracks | array of [Track](#track) objects | The tracks of the playlist |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand All @@ -173,7 +173,7 @@ Response:

Array of [Track](#track) objects from the search result.

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand All @@ -197,7 +197,7 @@ Array of [Track](#track) objects from the search result.

Empty object.

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand All @@ -213,7 +213,7 @@ Empty object.

[Exception](websocket.md#exception-object) object with the error.

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand Down Expand Up @@ -243,7 +243,7 @@ Response:

[Track](#track) object

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand Down Expand Up @@ -281,7 +281,7 @@ Request:

Array of track data strings

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand All @@ -297,7 +297,7 @@ Response:

Array of [Track](#track) objects

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand Down Expand Up @@ -361,27 +361,27 @@ 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

There are 15 bands (0-14) that can be changed.
"gain" is the multiplier for the given band. The default value is 0. Valid values range from -0.25 to 1.0,
where -0.25 means the given band is completely muted, and 0.25 means it is doubled. Modifying the gain could also change the volume of the output.

<details>
<details markdown="1">
<summary>Band Frequencies</summary>

| Band | Frequency |
Expand Down Expand Up @@ -498,7 +498,7 @@ Any smoothing values equal to or less than 1.0 will disable the filter.

Plugins can add their own filters. The key is the name of the plugin, and the value is the configuration for that plugin. The configuration is plugin specific. See [Plugins](plugins.md) for more plugin information.

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -571,7 +571,7 @@ Returns a list of players in this specific session.
GET /v4/sessions/{sessionId}/players
```

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand Down Expand Up @@ -631,7 +631,7 @@ Response:

[Player](#Player) object

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand Down Expand Up @@ -724,7 +724,7 @@ Request:

When `identifier` is used, Lavalink will try to resolve the identifier as a single track. An HTTP `400` error is returned when resolving a playlist, search result, or no tracks.

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand Down Expand Up @@ -753,7 +753,7 @@ Response:

[Player](#Player) object

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand Down Expand Up @@ -827,7 +827,7 @@ Request:
| resuming? | bool | Whether resuming is enabled for this session or not |
| timeout? | int | The timeout in seconds (default is 60s) |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand All @@ -846,7 +846,7 @@ Response:
| resuming | bool | Whether resuming is enabled for this session or not |
| timeout | int | The timeout in seconds (default is 60s) |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -911,7 +911,7 @@ Parsed [Semantic Versioning 2.0.0](https://semver.org/)
| name | string | The name of the plugin |
| version | string | The version of the plugin |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -988,7 +988,7 @@ Response:
`frameStats` is always missing for this endpoint.
[Stats](websocket.md#stats-object) object

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -1079,7 +1079,7 @@ Response:
| class | ?[Route Planner Type](#route-planner-types) | The name of the RoutePlanner implementation being used by this server |
| details | ?[Details](#details-object) object | The status details of the RoutePlanner |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -1119,7 +1119,7 @@ Request:
|---------|--------|-----------------------------------------------------------------------------|
| address | string | The address to unmark as failed. This address must be in the same ip block. |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down
22 changes: 11 additions & 11 deletions docs/api/websocket.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ When opening a websocket connection, you must supply 3 required headers:

**\*For more information on resuming see [Resuming](index.md#resuming)**

<details>
<details markdown="1">
<summary>Example Headers</summary>

```
Expand All @@ -37,7 +37,7 @@ Websocket messages all follow the following standard format:
| op | [OP Type](#op-types) | The op type |
| ... | ... | Extra fields depending on the op type |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand Down Expand Up @@ -67,7 +67,7 @@ Dispatched by Lavalink upon successful connection and authorization. Contains fi
| resumed | bool | Whether this session was resumed |
| sessionId | string | The Lavalink session id of this connection. Not to be confused with a Discord voice session id |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -100,7 +100,7 @@ Dispatched every x seconds (configurable in `application.yml`) with the current
| connected | bool | Whether Lavalink is connected to the voice gateway |
| ping | int | The ping of the node to the Discord voice server in milliseconds (`-1` if not connected) |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -162,7 +162,7 @@ A collection of statistics sent every minute.

\* The expected amount of frames is 3000 (1 every 20 ms) per player. If the `deficit` is negative, too many frames were sent, and if it's positive, not enough frames got sent.

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -204,7 +204,7 @@ Server dispatched an event. See the [Event Types](#event-types) section for more
| guildId | string | The guild id |
| ... | ... | Extra fields depending on the event |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```yaml
Expand Down Expand Up @@ -236,7 +236,7 @@ Dispatched when a track starts playing.
|-------|-------------------------------|--------------------------------|
| track | [Track](rest.md#track) object | The track that started playing |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -287,7 +287,7 @@ Dispatched when a track ends.
| `replaced` | The track was replaced | false |
| `cleanup` | The track was cleaned up | false |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -345,7 +345,7 @@ Dispatched when a track throws an exception.
| `suspicious` | The cause might not be exactly known, but is possibly caused by outside factors. For example when an outside service responds in a format that we do not expect |
| `fault` | The probable cause is an issue with the library or there is no way to tell what the cause might be. This is the default level and other levels are used in cases where the thrower has more in-depth knowledge about the error |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -391,7 +391,7 @@ Dispatched when a track gets stuck while playing.
| track | [Track](rest.md#track) object | The track that got stuck |
| thresholdMs | int | The threshold in milliseconds that was exceeded |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
Expand Down Expand Up @@ -437,7 +437,7 @@ See the [Discord Docs](https://discord.com/developers/docs/topics/opcodes-and-st
| reason | string | The close reason |
| byRemote | bool | Whether the connection was closed by Discord |

<details>
<details markdown="1">
<summary>Example Payload</summary>

```json
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
4 changes: 3 additions & 1 deletion docs/clients.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ description: A list of Lavalink client libraries.
| [Lavalink-Client](https://github.com/lavalink-devs/Lavalink-Client) | Java/Kotlin/JVM | JDA/Discord4J/**Any** | Uses reactor |
| [Lavalink.kt](https://github.com/DRSchlaubi/Lavalink.kt) | Kotlin | Kord/JDA/**Any** | Kotlin Coroutines |
| [DisGoLink](https://github.com/disgoorg/disgolink) | Go | **Any** | |
| [lavalink.py](https://github.com/devoxin/lavalink.py) | Python | **Any** | |
| [Mafic](https://github.com/ooliver1/mafic) | Python | discord.py **V2**/nextcord/disnake/py-cord | |
| [Wavelink](https://github.com/PythonistaGuild/Wavelink) | Python | discord.py **V2** | |
| [Moonlink.js](https://github.com/1Lucas1apk/moonlink.js) | Node.js | **Any** | |
Expand All @@ -20,8 +21,10 @@ description: A list of Lavalink client libraries.
| [Riffy](https://github.com/riffy-team/riffy) | Node.js | **Any** | |
| [DisCatSharp](https://github.com/Aiko-IT-Systems/DisCatSharp) | .NET | DisCatSharp | v10.4.2+ |
| [Lavalink4NET](https://github.com/angelobreuer/Lavalink4NET) | .NET | Discord.Net/DSharpPlus/Remora | v4+ |
| [Nomia](https://github.com/DHCPCD9/Nomia) | .NET | DSharpPlus | |
| [Coglink](https://github.com/PerformanC/Coglink) | C | Concord | |
| [lavalink-rs](https://gitlab.com/vicky5124/lavalink-rs) | Rust, Python | **Any** | `tokio`-based, `asyncio`-based |
| [lavalink](https://github.com/nyxx-discord/nyxx_lavalink) | Dart | nyxx/**Any** | |

<details markdown="1">
<summary>v3.7 supporting Client Libraries</summary>
Expand All @@ -38,7 +41,6 @@ description: A list of Lavalink client libraries.
| [Shoukaku](https://github.com/Deivu/Shoukaku) | Node.js | **Any** | |
| [Cosmicord.js](https://github.com/SudhanPlayz/Cosmicord.js) | Node.js | **Any** | |
| [DisCatSharp](https://github.com/Aiko-IT-Systems/DisCatSharp) | .NET | DisCatSharp | Only prior v10.4.1 |
| [Nomia](https://github.com/DHCPCD9/Nomia) | .NET | DSharpPlus | |
| [Lavalink4NET](https://github.com/angelobreuer/Lavalink4NET) | .NET | Discord.Net/DSharpPlus | < v4 |
| [DisGoLink](https://github.com/disgoorg/disgolink) | Go | **Any** | |

Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The server configuration is done in `application.yml`. You can find an example b

## Example application.yml

<details>
<details markdown="1">
<summary>application.yml</summary>

```yaml title="application.yml"
Expand All @@ -22,7 +22,7 @@ For arrays, the index is appended to the key, starting at 0. For example, `LAVAL

## Example environment variables

<details>
<details markdown="1">
<summary>environment variables</summary>

```env title="enviroment variables"
Expand Down
4 changes: 3 additions & 1 deletion ROUTEPLANNERS.md → docs/configuration/routeplanner.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# RoutePlanner Strategies
---
description: Lavalink RoutePlanner Strategies
---

## Terminology

Expand Down
1 change: 1 addition & 0 deletions docs/mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ nav:
- Binary: configuration/binary.md
- Systemd: configuration/systemd.md
- Docker: configuration/docker.md
- RoutePlanner: configuration/routeplanner.md
- Clients: clients.md
- Plugins: plugins.md
- API:
Expand Down
Loading

0 comments on commit 15fd02b

Please sign in to comment.