Version: v2.10.2 (current)

Interface: ManagerOptions

Represents a configuration object passed to the Manager constructor.
These options control core behavior such as node connections, autoplay logic, and plugin support.

Property Type Description Optional
autoPlaySearchPlatforms AutoPlayPlatform[] Search platforms to use for autoplay, in priority order. Defaults to [AutoPlayPlatform.YouTube].
clientId string Discord application's client ID.
clientName string Value for the Client-Name header sent to Lavalink nodes. Defaults to "Magmastream". Leave empty for NodeLink.
clusterId number Index of the cluster this manager belongs to. Defaults to 0.
defaultSearchPlatform SearchPlatform Default platform for searches. Defaults to SearchPlatform.YouTube.
enabledPlugins Plugin[] List of plugins to load.
enablePriorityMode boolean Whether to enable priority mode over least player count or load balancing. Defaults to false.
getGuild function Guild cache getter (id: string) => AnyGuild | undefined. Required when using new Manager(...) directly (see StandaloneManagerOptions); optional for built-in wrappers which provide this automatically.
getUser function User cache getter (id: string) => AnyUser | undefined. Required when using new Manager(...) directly (see StandaloneManagerOptions); optional for built-in wrappers which provide this automatically.
lastFmApiKey string API key for Last.fm-based autoplay. Get one here.
listenToSIGEvents boolean Whether to listen to SIGINT and SIGTERM for graceful shutdown. Defaults to true.
maxPreviousTracks number Maximum number of previous tracks to store per player. Defaults to 20.
nodes NodeOptions[] Lavalink nodes to connect to.
normalizeYouTubeTitles boolean Replace YouTube video titles when the author does not exactly match. Defaults to false.
playNextOnEnd boolean Automatically play the next track when the current one ends. Defaults to true.
send function Function used to send packets to Discord's WebSocket gateway. Required when not using a wrapper.
stateStorage StateStorageOptions Where queue and player state is persisted. Defaults to StateStorageType.Memory.
trackPartial TrackPartial[] Track properties to retain when building tracks. track is always included.
useNode UseNodeOptions Node selection strategy. Defaults to UseNodeOptions.LeastPlayers.

Property	Type	Description
`autoPlaySearchPlatforms`	`AutoPlayPlatform[]`	Search platforms to use for autoplay, in priority order. Defaults to `[AutoPlayPlatform.YouTube]`.
`clientId`	string	Discord application's client ID.
`clientName`	string	Value for the `Client-Name` header sent to Lavalink nodes. Defaults to `"Magmastream"`. Leave empty for NodeLink.
`clusterId`	number	Index of the cluster this manager belongs to. Defaults to `0`.
`defaultSearchPlatform`	`SearchPlatform`	Default platform for searches. Defaults to `SearchPlatform.YouTube`.
`enabledPlugins`	`Plugin[]`	List of plugins to load.
`enablePriorityMode`	boolean	Whether to enable priority mode over least player count or load balancing. Defaults to `false`.
`getGuild`	function	Guild cache getter `(id: string) => AnyGuild \| undefined`. Required when using `new Manager(...)` directly (see `StandaloneManagerOptions`); optional for built-in wrappers which provide this automatically.
`getUser`	function	User cache getter `(id: string) => AnyUser \| undefined`. Required when using `new Manager(...)` directly (see `StandaloneManagerOptions`); optional for built-in wrappers which provide this automatically.
`lastFmApiKey`	string	API key for Last.fm-based autoplay. Get one here.
`listenToSIGEvents`	boolean	Whether to listen to `SIGINT` and `SIGTERM` for graceful shutdown. Defaults to `true`.
`maxPreviousTracks`	number	Maximum number of previous tracks to store per player. Defaults to `20`.
`nodes`	`NodeOptions[]`	Lavalink nodes to connect to.
`normalizeYouTubeTitles`	boolean	Replace YouTube video titles when the author does not exactly match. Defaults to `false`.
`playNextOnEnd`	boolean	Automatically play the next track when the current one ends. Defaults to `true`.
`send`	function	Function used to send packets to Discord's WebSocket gateway. Required when not using a wrapper.
`stateStorage`	`StateStorageOptions`	Where queue and player state is persisted. Defaults to `StateStorageType.Memory`.
`trackPartial`	`TrackPartial[]`	Track properties to retain when building tracks. `track` is always included.
`useNode`	`UseNodeOptions`	Node selection strategy. Defaults to `UseNodeOptions.LeastPlayers`.