CompletePlayerOptions | @discord-rose/lavalink

Hierarchy

CompletePlayerOptions

Index

Properties

becomeSpeaker

becomeSpeaker: boolean

If the bot should request to or become a speaker in stage channels depending on it's permissions.

default: true

connectionTimeout

connectionTimeout: number

The amount of time to allow to connect to a VC before timing out.

default: 15000

guildId

guildId: string

The guild ID to bind the player to.

moveBehavior

moveBehavior: "destroy" | "pause"

Behavior to use when the bot is moved from the VC (This includes the bot being disconnected). 'destroy' will destroy the player. 'pause' will send a pause payload to the lavalink server, and will resume when the bot is reconnected to the VC.

default: 'destroy'

selfDeafen

selfDeafen: boolean

If the bot should self deafen.

default: true

selfMute

selfMute: boolean

If the bot should self mute.

default: false

stageMoveBehavior

stageMoveBehavior: "destroy" | "pause"

Behavior to use when the bot is moved to the audience in a stage channel. This has no effect if becomeSpeaker is false. 'destroy' will destroy the player. 'pause' will send a pause payload to the lavalink server, and will resume when the bot is a speaker again. The bot will also request to speak, or become a speaker if it cannot request.

default: 'pause'

textChannelId

textChannelId: string

The text channel ID to bind the player to.

voiceChannelId

voiceChannelId: string

The voice channel ID to bind the player to.

Generated using TypeDoc