Discord Player

VoiceUtils

No description provided

VoiceUtils

new VoiceUtils(player);
ParameterTypeOptional
playerPlayer❌

Properties

public cache: any

Voice connection cache to store voice connections of the Player components. This property is deprecated and will be removed in the future. It only exists for compatibility reasons.

public player: any

Methods

public connect(channel, options?): Promise<StreamDispatcher>

Joins a voice channel, creating basic stream dispatch manager

ParameterTypeOptionalDescription
channelVoiceChannel | StageChannel❌The voice channel
optionsJoinOptions✅Join options

public disconnect(connection): void

Disconnects voice connection

ParameterTypeOptionalDescription
connectionStreamDispatcher | VoiceConnection❌The voice connection

public getConnection(guild, group?): undefined | VoiceConnection

Returns Discord Player voice connection

ParameterTypeOptionalDescription
guildstring❌The guild id
groupstring✅N/A

public join(channel?, options?): Promise<VoiceConnection>

Joins a voice channel

ParameterTypeOptionalDescription
channelVoiceChannel | StageChannel✅The voice/stage channel to join
optionsJoinOptions✅Join options

On this page