GuildVoiceChannel

class GuildVoiceChannel

A guild voice channel.

Extends:

Properties

Property

Type

Description

bitrate

number | undefined

Audio bitrate in bps.

type

2

The type of this channel. Check it to narrow the channel to its subclass.

userLimit

number | undefined

Maximum number of users allowed in the channel (0 = unlimited).

Methods

async GuildVoiceChannel.clearStatus(reason: string) → Promise<void>

Clear the status displayed for this voice channel.

async GuildVoiceChannel.edit(options: GuildVoiceChannelEditOptions) → Promise<GuildVoiceChannel>

Edit voice channel properties.

Parameters:
  • options: The voice channel properties to update.

Returns:

The updated voice channel.

async GuildVoiceChannel.getVoiceStates() → Promise<VoiceState[]>

List the voice states currently cached for this channel.

async GuildVoiceChannel.setStatus(status: string, reason: string) → Promise<void>

Set the status displayed for this voice channel.