discord.js | BaseGuildVoiceChannel

Search...

BaseGuildVoiceChannel

export class BaseGuildVoiceChannel extends TextBasedChannelMixin(GuildChannel, true, [
  'lastPinTimestamp',
  'lastPinAt',
])

export class BaseGuildVoiceChannel extends TextBasedChannelMixin(GuildChannel, true, [
  'lastPinTimestamp',
  'lastPinAt',
])

Represents a voice-based guild channel on Discord.

TextBasedChannelMixin(GuildChannel, true, [ 'lastPinTimestamp', 'lastPinAt', ])

constructor(guild, data?)

Constructs a new instance of the BaseGuildVoiceChannel class

Name	Type	Optional	Description
guild	Guild	No	None
data	RawGuildChannelData	Yes	None

bitrate:number

The bitrate of this voice-based channel

Readonly

full:boolean

Checks if the voice-based channel is full

Readonly

joinable:boolean

Whether the channel is joinable by the client user

Readonly

The members in this voice-based channel

nsfw:boolean

If the guild considers this channel NSFW

rateLimitPerUser:number | null

The rate limit per user (slowmode) for this channel in seconds

rtcRegion:string | null

The RTC region for this voice-based channel. This region is automatically selected if null.

userLimit:number

The maximum amount of users allowed in this channel.

videoQualityMode:VideoQualityMode | null

The camera video quality mode of the channel.

createInvite(options?):Promise<Invite>

Creates an invite to this guild channel.

Name	Type	Optional	Description
options	InviteCreateOptions	Yes	The options for creating the invite

fetchInvites(cache?):Promise<Collection<string, Invite>>

Fetches a collection of invites to this guild channel.

Name	Type	Optional	Description
cache	boolean	Yes	Whether to cache the fetched invites

setBitrate(bitrate, reason?):Promise<this>

Sets the bitrate of the channel.

Name	Type	Optional	Description
bitrate	number	No	The new bitrate
reason	string	Yes	Reason for changing the channel's bitrate

setRTCRegion(rtcRegion, reason?):Promise<this>

Sets the RTC region of the channel.

Name	Type	Optional	Description
rtcRegion	string \| null	No	The new region of the channel. Set to `null` to remove a specific region for the channel
reason	string	Yes	The reason for modifying this region.

setUserLimit(userLimit, reason?):Promise<this>

Sets the user limit of the channel.

Name	Type	Optional	Description
userLimit	number	No	The new user limit
reason	string	Yes	Reason for changing the user limit

setVideoQualityMode(videoQualityMode, reason?):Promise<this>

Sets the camera video quality mode of the channel.

Name	Type	Optional	Description
videoQualityMode	VideoQualityMode	No	The new camera video quality mode.
reason	string	Yes	Reason for changing the camera video quality mode.