Table of Contents

Class LavalinkConfiguration

Namespace
DSharpPlus.Lavalink
Assembly
DSharpPlus.Lavalink.dll

Lavalink connection configuration.

public sealed class LavalinkConfiguration
Inheritance
object
LavalinkConfiguration

Constructors

LavalinkConfiguration()

Creates a new instance of LavalinkConfiguration.

LavalinkConfiguration(LavalinkConfiguration)

Creates a new instance of LavalinkConfiguration, copying the properties of another configuration.

Properties

Password

Sets the password for the Lavalink connection.

Defaults to "youshallnotpass".

Region

Sets the voice region ID for the Lavalink connection.

This should be used if nodes should be filtered by region with GetIdealNodeConnection(DiscordVoiceRegion).

RestEndpoint

Sets the endpoint for Lavalink REST.

Defaults to 127.0.0.1 on port 2333.

ResumeKey

Sets the resume key for the Lavalink connection.

This will allow existing voice sessions to continue for a certain time after the client is disconnected.

ResumeTimeout

Sets the time in seconds when all voice sessions are closed after the client disconnects.

Defaults to 60 seconds.

SocketAutoReconnect

Sets whether the connection wrapper should attempt automatic reconnects should the connection drop.

Defaults to true.

SocketEndpoint

Sets the endpoint for the Lavalink Websocket connection.

Defaults to 127.0.0.1 on port 2333.

WebSocketCloseTimeout

Sets the time in milliseconds to wait for Lavalink's voice WebSocket to close after leaving a voice channel.

This will be the delay before the guild connection is removed.

Defaults to 3000 milliseconds.