Skip to main content
Version: v2.8.5

Typedefs : Manager : managerOptions

managerOptions object

Parameter Type Description Optional
autoPlaybooleanWhether players should automatically play the next song.
autoPlaySearchPlatform SearchPlatformThe search platform autoplay should use. Fallback to YouTube if not found.
clientIdstringThe client ID to use.
clientNamestringValue to use for the Client-Name header.
clusterIdnumberThe array of shard IDs connected to this manager instance.
defaultSearchPlatform SearchPlatformThe default search platform to use.
lastFmApiKeystringThe last.fm API key. Get it from here.
maxPreviousTracksnumberThe maximum number of previous tracks to store.
nodesNodeOptions[]The array of nodes to connect to.
pluginsPlugin[]An array of plugins to use.
replaceYouTubeCredentialsbooleanWhether the YouTube video titles should be replaced if the Author does not exactly match.
trackPartial TrackPartialAn array of track properties to keep. track will always be present.
useNode UseNodeOptionsUse the least amount of players or least load?
usePrioritybooleanUse priority mode over least amount of player or load?
sendfunctionFunction to send data to the websocket.