ManagerPlayerOptions
Defined in: src/structures/Types/Manager.ts:209
Sub Manager Options, for player specific things
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
CustomPlayerT extends Player | Player |
Properties
Section titled “Properties”| Property (defined in) | Type | Description |
|---|---|---|
applyVolumeAsFilter? (src/structures/Types/Manager.ts:217) | boolean | Applies the volume via a filter, not via the lavalink volume transformer |
clientBasedPositionUpdateInterval? (src/structures/Types/Manager.ts:213) | number | How often it should update the the player Position |
defaultSearchPlatform? (src/structures/Types/Manager.ts:215) | SearchPlatform | What should be used as a searchPlatform, if no source was provided during the query |
maxErrorsPerTime? (src/structures/Types/Manager.ts:232) | object | Allows you to declare how many tracks are allowed to error/stuck within a time-frame before player is destroyed Default "{threshold: 35000, maxAmount: 3 }" |
maxErrorsPerTime.maxAmount (src/structures/Types/Manager.ts:236) | number | The max amount of errors within the threshold time which are allowed before destroying the player (when errors > maxAmount -> player.destroy()) |
maxErrorsPerTime.threshold (src/structures/Types/Manager.ts:234) | number | The threshold time to count errors (recommended is 35s) |
minAutoPlayMs? (src/structures/Types/Manager.ts:230) | number | Minimum time to play the song before autoPlayFunction is executed (prevents error spamming) Set to 0 to disable it Default 10000 |
onDisconnect? (src/structures/Types/Manager.ts:221) | object | What lavalink-client should do when the player reconnects |
onDisconnect.autoReconnect? (src/structures/Types/Manager.ts:223) | boolean | Try to reconnect? -> If fails -> Destroy |
onDisconnect.autoReconnectOnlyWithTracks? (src/structures/Types/Manager.ts:225) | boolean | Only try to reconnect if there are tracks in the queue |
onDisconnect.destroyPlayer? (Don’t provide == disable feature) | boolean | Instantly destroy player (overrides autoReconnect) |
onEmptyQueue? (src/structures/Types/Manager.ts:239) | object | |
onEmptyQueue.autoPlayFunction? (src/structures/Types/Manager.ts:241) | (player: CustomPlayerT, lastPlayedTrack: Track) => Promise<void> | Get’s executed onEmptyQueue -> You can do any track queue previous transformations, if you add a track to the queue -> it will play it, if not queueEnd will execute! |
onEmptyQueue.destroyAfterMs? (src/structures/Types/Manager.ts:243) | number | |
requesterTransformer? (src/structures/Types/Manager.ts:219) | (requester: unknown) => unknown | Transforms the saved data of a requested user |
useUnresolvedData? (src/structures/Types/Manager.ts:246) | boolean | |
volumeDecrementer? (src/structures/Types/Manager.ts:211) | number | If the Lavalink Volume should be decremented by x number |