GuildVoiceChannel

class GuildVoiceChannel()

A guild voice channel.

exported from lib.weeble.d

Extends:

• GuildChannel

Properties

GuildVoiceChannel.bitrate

type: readonly number | undefined

Audio bitrate in bps.

GuildVoiceChannel.type

type: readonly 2

The type of this channel — use this to narrow to the correct subclass.

GuildVoiceChannel.userLimit

type: readonly 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.fetchVoiceStates() → 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.