GuildStageVoiceChannel

class GuildStageVoiceChannel

A stage channel designed for voice events with speakers and an audience.

Extends:

Properties

Property

Type

Description

bitrate

number | undefined

Audio bitrate in bps.

topic

string | null | undefined

The stage topic, or null if not set.

type

13

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

Methods

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

Clear the status displayed for this stage channel.

async GuildStageVoiceChannel.edit(options: GuildStageVoiceChannelEditOptions) → Promise<GuildStageVoiceChannel>

Edit stage channel properties.

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

Returns:

The updated stage channel.

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

List the voice states currently cached for this channel.

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

Set the status displayed for this stage channel.