Skip to main content
Version: v2.10.2 (current)

Interface: PlayerOptions

Represents a configuration object passed to the Player constructor.

Property Type Description Optional
guildIdstringThe guild ID the player belongs to.
textChannelIdstringThe text channel ID the player belongs to.
voiceChannelIdstringThe voice channel ID the player belongs to.
nodeIdentifierstringThe identifier of the node this player should use.
volumenumberThe initial playback volume.
selfMutebooleanWhether the bot should mute itself in the voice channel.
selfDeafenbooleanWhether the bot should deafen itself in the voice channel.
applyVolumeAsFilterbooleanWhether to apply volume via a Lavalink filter instead of the native volume parameter.
pauseOnDisconnectbooleanWhether to pause the player when the bot is disconnected from the voice channel.