Skip to content

Commit 836103b

Browse files
committed
Merge branch 'master' into dev
# Conflicts: # CHANGELOG.md # docs/changelog/v4.md
2 parents 8888cef + f77c8f5 commit 836103b

File tree

4 files changed

+34
-32
lines changed

4 files changed

+34
-32
lines changed

docs/api/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ What happens after your client disconnects is dependent on whether the session h
2222
* If resuming is disabled all voice connections are closed immediately.
2323
* If resuming is enabled all music will continue playing. You will then be able to resume your session, allowing you to control the players again.
2424

25-
To enable resuming, you must call the [Update Session](#update-session) endpoint with the `resuming` and `timeout`.
25+
To enable resuming, you must call the [Update Session](../api/rest.md#update-session) endpoint with the `resuming` and `timeout`.
2626

2727
To resume a session, specify the session id in your WebSocket handshake request headers:
2828

@@ -36,7 +36,7 @@ You can tell if your session was resumed by looking at the handshake response he
3636
Session-Resumed: true
3737
```
3838

39-
In case your websocket library doesn't support reading headers you can listen for the [ready op](#ready-op) and check the `resumed` field.
39+
In case your websocket library doesn't support reading headers you can listen for the [ready op](../api/websocket.md#ready-op) and check the `resumed` field.
4040

4141
When a session is paused, any events that would normally have been sent are queued up. When the session is resumed, this
4242
queue is then emptied and the events are replayed.

docs/api/rest.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ When Lavalink encounters an error, it will respond with a JSON object containing
5353

5454
#### Track
5555

56-
| Field | Type | Description |
57-
|------------|----------------------------------|-------------------------------------------------------------------------------|
58-
| encoded | string | The base64 encoded track data |
59-
| info | [Track Info](#track-info) object | Info about the track |
56+
| Field | Type | Description |
57+
|------------|----------------------------------|---------------------------------------------------------------------------------|
58+
| encoded | string | The base64 encoded track data |
59+
| info | [Track Info](#track-info) object | Info about the track |
6060
| pluginInfo | object | Additional track info provided by plugins |
6161
| userData | object | Additional track data provided via the [Update Player](#update-player) endpoint |
6262

docs/changelog/index.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,24 @@ The most noteworthy of these, as well as any features and breaking changes, are
1717
* `v4` uses the `sessionId` instead of the `resumeKey` for resuming.
1818
* `v4` now returns the tracks `artworkUrl` and `isrc` if the source supports it.
1919
* removal of deprecated json fields like `track`.
20-
* addition of `artworkUrl` and `isrc` fields to the [Track Info](#track-info) object.
21-
* addition of the full [Track](#track) object in [TrackStartEvent](#trackstartevent), [TrackEndEvent](#trackendevent), [TrackExceptionEvent](#trackexceptionevent) and [TrackStuckEvent](#trackstuckevent).
22-
* updated capitalization of [Track End Reason](#track-end-reason) and [Severity](#severity)
23-
* reworked [Load Result](#track-loading-result) object
20+
* addition of `artworkUrl` and `isrc` fields to the [Track Info](../api/rest.md#track-info) object.
21+
* addition of the full [Track](../api/rest.md#track) object in [TrackStartEvent](../api/websocket.md#trackstartevent), [TrackEndEvent](../api/websocket.md#trackendevent), [TrackExceptionEvent](../api/websocket.md#trackexceptionevent) and [TrackStuckEvent](../api/websocket.md#trackstuckevent).
22+
* updated capitalization of [Track End Reason](../api/websocket.md#track-end-reason) and [Severity](../api/websocket.md#severity)
23+
* reworked [Load Result](../api/rest.md#track-loading-result) object
2424
* allow setting user data on tracks in the REST API. For more info see [here](https://lavalink.dev/api/rest.html#update-player-track)
2525

2626

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

29-
* `play` -> [Update Player Endpoint](#update-player) `track`->`encoded` or `track`->`identifier` field
30-
* `stop` -> [Update Player Endpoint](#update-player) `encodedTrack` field with `null`
31-
* `pause` -> [Update Player Endpoint](#update-player) `pause` field
32-
* `seek` -> [Update Player Endpoint](#update-player) `position` field
33-
* `volume` -> [Update Player Endpoint](#update-player) `volume` field
34-
* `filters` -> [Update Player Endpoint](#update-player) `filters` field
35-
* `destroy` -> [Destroy Player Endpoint](#destroy-player)
36-
* `voiceUpdate` -> [Update Player Endpoint](#update-player) `voice` field
37-
* `configureResuming` -> [Update Session Endpoint](#update-session)
29+
* `play` -> [Update Player Endpoint](../api/rest.md#update-player) `track`->`encoded` or `track`->`identifier` field
30+
* `stop` -> [Update Player Endpoint](../api/rest.md#update-player) `encodedTrack` field with `null`
31+
* `pause` -> [Update Player Endpoint](../api/rest.md#update-player) `pause` field
32+
* `seek` -> [Update Player Endpoint](../api/rest.md#update-player) `position` field
33+
* `volume` -> [Update Player Endpoint](../api/rest.md#update-player) `volume` field
34+
* `filters` -> [Update Player Endpoint](../api/rest.md#update-player) `filters` field
35+
* `destroy` -> [Destroy Player Endpoint](../api/rest.md#destroy-player)
36+
* `voiceUpdate` -> [Update Player Endpoint](../api/rest.md#update-player) `voice` field
37+
* `configureResuming` -> [Update Session Endpoint](../api/rest.md#update-session)
3838

3939
</details>
4040

@@ -46,24 +46,24 @@ All websocket ops are removed as of `v4.0.0` and replaced with the following end
4646
* WebSocket handshakes should be done with `/v3/websocket`. Handshakes on `/` are now deprecated.
4747
* Deprecation of all client-to-server messages (play, stop, pause, seek, volume, filters, destroy, voiceUpdate & configureResuming).
4848
* Addition of REST endpoints intended to replace client requests.
49-
* Addition of new WebSocket dispatch [Ready OP](#ready-op) to get `sessionId` and `resume` status.
50-
* Addition of new [Session](#update-session)/[Player](#get-player) REST API.
49+
* Addition of new WebSocket dispatch [Ready OP](../api/websocket.md#ready-op) to get `sessionId` and `resume` status.
50+
* Addition of new [Session](../api/rest.md#update-session)/[Player](../api/rest.md#get-player) REST API.
5151
* Addition of `/v3/info`, replaces `/plugins`.
5252
* Deprecation of `Track.track` in existing endpoints. Use `Track.encoded` instead.
5353
* Deprecation of `TrackXEvent.track` in WebSocket dispatches. Use `TrackXEvent.encodedTrack` instead.
5454
* Player now has a `state` field which contains the same structure as returned by the `playerUpdate` OP.
5555

5656
All websocket ops are deprecated as of `v3.7.0` and replaced with the following endpoints and json fields:
5757

58-
* `play` -> [Update Player Endpoint](#update-player) `track` or `identifier` field
59-
* `stop` -> [Update Player Endpoint](#update-player) `track` field with `null`
60-
* `pause` -> [Update Player Endpoint](#update-player) `pause` field
61-
* `seek` -> [Update Player Endpoint](#update-player) `position` field
62-
* `volume` -> [Update Player Endpoint](#update-player) `volume` field
63-
* `filters` -> [Update Player Endpoint](#update-player) `filters` field
64-
* `destroy` -> [Destroy Player Endpoint](#destroy-player)
65-
* `voiceUpdate` -> [Update Player Endpoint](#update-player) `voice` field
66-
* `configureResuming` -> [Update Session Endpoint](#update-session)
58+
* `play` -> [Update Player Endpoint](../api/rest.md#update-player) `track` or `identifier` field
59+
* `stop` -> [Update Player Endpoint](../api/rest.md#update-player) `track` field with `null`
60+
* `pause` -> [Update Player Endpoint](../api/rest.md#update-player) `pause` field
61+
* `seek` -> [Update Player Endpoint](../api/rest.md#update-player) `position` field
62+
* `volume` -> [Update Player Endpoint](../api/rest.md#update-player) `volume` field
63+
* `filters` -> [Update Player Endpoint](../api/rest.md#update-player) `filters` field
64+
* `destroy` -> [Destroy Player Endpoint](../api/rest.md#destroy-player)
65+
* `voiceUpdate` -> [Update Player Endpoint](../api/rest.md#update-player) `voice` field
66+
* `configureResuming` -> [Update Session Endpoint](../api/rest.md#update-session)
6767

6868
</details>
6969

@@ -72,7 +72,7 @@ All websocket ops are deprecated as of `v3.7.0` and replaced with the following
7272

7373
* Added filters
7474
* The `error` string on the `TrackExceptionEvent` has been deprecated and replaced by
75-
the [Exception](#exception-object) object following the same structure as the `LOAD_FAILED` error on [`/loadtracks`](#track-loading).
75+
the [Exception](../api/websocket.md#exception-object) object following the same structure as the `LOAD_FAILED` error on [`/loadtracks`](../api/rest.md#track-loading).
7676
* Added the `connected` boolean to player updates.
7777
* Added source name to REST api track objects
7878
* Clients are now requested to make their name known during handshake

docs/clients.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ description: A list of Lavalink client libraries.
1212
| [lavalink.py](https://github.com/devoxin/lavalink.py) | Python | **Any** | |
1313
| [Mafic](https://github.com/ooliver1/mafic) | Python | discord.py **V2**/nextcord/disnake/py-cord | |
1414
| [Wavelink](https://github.com/PythonistaGuild/Wavelink) | Python | discord.py **V2** | |
15+
| [Pomice](https://github.com/cloudwithax/pomice) | Python | discord.py **V2** | |
16+
| [hikari-ongaku](https://github.com/MPlatypus/hikari-ongaku) | Python | Hikari | `asyncio`-based |
1517
| [Moonlink.js](https://github.com/1Lucas1apk/moonlink.js) | Node.js | **Any** | |
1618
| [Magmastream](https://github.com/Blackfort-Hosting/magmastream) | Node.js | **Any** | |
1719
| [Lavacord](https://github.com/lavacord/Lavacord) | Node.js | **Any** | |
@@ -20,7 +22,7 @@ description: A list of Lavalink client libraries.
2022
| [FastLink](https://github.com/PerformanC/FastLink) | Node.js | **Any** | |
2123
| [Riffy](https://github.com/riffy-team/riffy) | Node.js | **Any** | |
2224
| [DisCatSharp](https://github.com/Aiko-IT-Systems/DisCatSharp) | .NET | DisCatSharp | v10.4.2+ |
23-
| [Lavalink4NET](https://github.com/angelobreuer/Lavalink4NET) | .NET | Discord.Net/DSharpPlus/Remora | v4+ |
25+
| [Lavalink4NET](https://github.com/angelobreuer/Lavalink4NET) | .NET | Discord.Net/DSharpPlus/Remora/NetCord | v4+ |
2426
| [Nomia](https://github.com/DHCPCD9/Nomia) | .NET | DSharpPlus | |
2527
| [Coglink](https://github.com/PerformanC/Coglink) | C | Concord | |
2628
| [lavalink-rs](https://gitlab.com/vicky5124/lavalink-rs) | Rust, Python | **Any** | `tokio`-based, `asyncio`-based |

0 commit comments

Comments
 (0)