ManagerOptions
Defined in: src/structures/Types/Manager.ts:260
Manager Options used to create the manager
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
CustomPlayerT extends Player | Player |
Properties
Section titled “Properties”| Property (defined in) | Type | Description |
|---|---|---|
advancedOptions? (src/structures/Types/Manager.ts:295) | object | Advanced Options for the Library, which may or may not be “library breaking” |
advancedOptions.debugOptions? (src/structures/Types/Manager.ts:301) | object | optional |
advancedOptions.debugOptions.logCustomSearches? (src/structures/Types/Manager.ts:303) | boolean | For logging custom searches |
advancedOptions.debugOptions.noAudio? (src/structures/Types/Manager.ts:305) | boolean | logs for debugging the “no-Audio” playing error |
advancedOptions.debugOptions.playerDestroy? (src/structures/Types/Manager.ts:307) | object | For Logging the Destroy function |
advancedOptions.debugOptions.playerDestroy.debugLog? (src/structures/Types/Manager.ts:309) | boolean | To show the debug reason at all times. |
advancedOptions.debugOptions.playerDestroy.dontThrowError? (src/structures/Types/Manager.ts:311) | boolean | If you get ‘Error: Use Player#destroy(“reason”) not LavalinkManager#deletePlayer() to stop the Player’ put it on true |
advancedOptions.enableDebugEvents? (src/structures/Types/Manager.ts:299) | boolean | Enable Debug event |
advancedOptions.maxFilterFixDuration? (src/structures/Types/Manager.ts:297) | number | Max duration for that the filter fix duration works (in ms) - default is 8mins |
autoChecks? (src/structures/Types/Manager.ts:288) | object | If the library should automatically check something, on default everything is enabled |
autoChecks.pluginValidations? (src/structures/Types/Manager.ts:290) | boolean | Wether or not the client should check if the requested source’s plugin is available on the node. |
autoChecks.sourcesValidations? (src/structures/Types/Manager.ts:292) | boolean | Wether or not the client should check if the requested source is available on the node |
autoMove? (src/structures/Types/Manager.ts:276) | boolean | If it should automatically move the player to the next node when node is down |
autoSkip? (src/structures/Types/Manager.ts:274) | boolean | If it should skip to the next Track on TrackEnd / TrackError etc. events |
autoSkipOnResolveError? (src/structures/Types/Manager.ts:278) | boolean | If it should skip to the next Track if track.resolve errors while trying to play a track. |
client? (src/structures/Types/Manager.ts:266) | BotClientOptions | The Bot Client’s Data for Authorization |
emitNewSongsOnly? (src/structures/Types/Manager.ts:280) | boolean | If it should emit only new (unique) songs and not when a looping track (or similar) is plaid, default false |
linksAllowed? (src/structures/Types/Manager.ts:286) | boolean | If links should be allowed or not. If set to false, it will throw an error if a link was provided. |
linksBlacklist? (Never allow link requests with links either matching some of that regExp or including some of that string (doesn’t even allow if it’s whitelisted)) | (string \ | RegExp)[] |
linksWhitelist? (Only allow link requests with links either matching some of that regExp or including some of that string) | (string \ | RegExp)[] |
nodes (src/structures/Types/Manager.ts:262) | LavalinkNodeOptions[] | The Node Options, for all Nodes! (on init) |
playerClass? (src/structures/Types/Manager.ts:272) | PlayerConstructor<CustomPlayerT> | The player class you want to use when creating a player. (can be extendable) |
playerOptions? (src/structures/Types/Manager.ts:270) | ManagerPlayerOptions<CustomPlayerT> | PlayerOptions for all Players |
queueOptions? (src/structures/Types/Manager.ts:268) | ManagerQueueOptions | QueueOptions for all Queues |
sendToShard (src/structures/Types/Manager.ts:264) | (guildId: string, payload: GuildShardPayload) => void | Async The Function to send the voice connection changes from Lavalink to Discord |