BaseGuildVoiceChannel
channelOn this page
BaseGuildVoiceChannel is a DiscordLua channel representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.
- BaseGuildVoiceChannel
- GuildChannel
- Channel
Inherited properties (45)
appliedTags · inherited from Channelarchived · inherited from ChannelarchiveTimestamp · inherited from ChannelautoArchiveDuration · inherited from ChannelavailableTags · inherited from Channelbitrate · inherited from Channelchildren · inherited from Channelclient · inherited from ChanneldefaultAutoArchiveDuration · inherited from ChanneldefaultForumLayout · inherited from ChanneldefaultReactionEmoji · inherited from ChanneldefaultSortOrder · inherited from ChanneldefaultThreadRateLimitPerUser · inherited from Channelflags · inherited from ChannelguildId · inherited from Channelicon · inherited from Channelid · inherited from Channelinvitable · inherited from Channelinvites · inherited from ChannellastMessageId · inherited from ChannellastPinTimestamp · inherited from Channellocked · inherited from ChannelmemberCount · inherited from Channelmembers · inherited from ChannelmessageCount · inherited from Channelmessages · inherited from Channelname · inherited from Channelnsfw · inherited from ChannelownerId · inherited from ChannelparentId · inherited from ChannelpermissionOverwrites · inherited from Channelposition · inherited from ChannelrateLimitPerUser · inherited from Channelraw · inherited from Channelrecipient · inherited from ChannelrecipientId · inherited from ChannelrecipientIds · inherited from Channelrecipients · inherited from ChannelrtcRegion · inherited from Channelthreads · inherited from Channeltopic · inherited from ChanneltotalMessageSent · inherited from Channeltype · inherited from ChanneluserLimit · inherited from ChannelvideoQualityMode · inherited from ChannelMethods
BaseGuildVoiceChannel:full()
#Performs full on this BaseGuildVoiceChannel. Call it from bot code when you need that operation on the current object.
Signature
BaseGuildVoiceChannel:full() Parameters
No parameters.
Returns
BaseGuildVoiceChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a BaseGuildVoiceChannel
object:full()BaseGuildVoiceChannel:joinable()
#Performs joinable on this BaseGuildVoiceChannel. Call it from bot code when you need that operation on the current object.
Signature
BaseGuildVoiceChannel:joinable() Parameters
No parameters.
Returns
BaseGuildVoiceChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a BaseGuildVoiceChannel
object:joinable()BaseGuildVoiceChannel:members()
#Performs members on this BaseGuildVoiceChannel. Call it from bot code when you need that operation on the current object.
Signature
BaseGuildVoiceChannel:members() Parameters
No parameters.
Returns
BaseGuildVoiceChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a BaseGuildVoiceChannel
object:members()BaseGuildVoiceChannel:setBitrate()
#Set the Bitrate field. Builders return this BaseGuildVoiceChannel so setters can be chained.
Signature
BaseGuildVoiceChannel:setBitrate(bitrate) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
bitrate |
any |
required | Passed through to the implementation as written. |
Returns
BaseGuildVoiceChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a BaseGuildVoiceChannel
object:setBitrate(bitrate)BaseGuildVoiceChannel:setRTCRegion()
#Set the RTCRegion field. Builders return this BaseGuildVoiceChannel so setters can be chained.
Signature
BaseGuildVoiceChannel:setRTCRegion(region) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
region |
any |
required | Passed through to the implementation as written. |
Returns
BaseGuildVoiceChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a BaseGuildVoiceChannel
object:setRTCRegion(region)BaseGuildVoiceChannel:setUserLimit()
#Set the UserLimit field. Builders return this BaseGuildVoiceChannel so setters can be chained.
Signature
BaseGuildVoiceChannel:setUserLimit(userLimit) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
userLimit |
any |
required | Passed through to the implementation as written. |
Returns
BaseGuildVoiceChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a BaseGuildVoiceChannel
object:setUserLimit(userLimit)BaseGuildVoiceChannel:setVideoQualityMode()
#Set the VideoQualityMode field. Builders return this BaseGuildVoiceChannel so setters can be chained.
Signature
BaseGuildVoiceChannel:setVideoQualityMode(mode) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
mode |
any |
required | Passed through to the implementation as written. |
Returns
BaseGuildVoiceChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a BaseGuildVoiceChannel
object:setVideoQualityMode(mode)Inherited methods (53)
Channel:addFollowerChannel:awaitMessageComponentChannel:awaitMessagesChannel:bulkDeleteChannel:cloneChannel:createdAtChannel:createdTimestampChannel:createInteractionCollectorChannel:createInviteChannel:createMessageCollectorChannel:createMessageComponentCollectorChannel:createWebhookChannel:deletableChannel:deleteChannel:editChannel:equalsChannel:fetchChannel:fetchInvitesChannel:fetchMessagesChannel:fetchWebhooksChannel:guildChannel:iconURLChannel:isDMBasedChannel:isSendableChannel:isTextBasedChannel:isThreadChannel:isThreadOnlyChannel:isVoiceBasedChannel:lastMessageChannel:lastPinAtChannel:lockPermissionsChannel:manageableChannel:parentChannel:partialChannel:permissionsForChannel:permissionsLockedChannel:rawPositionChannel:sendChannel:sendTypingChannel:setDefaultAutoArchiveDurationChannel:setNameChannel:setNSFWChannel:setParentChannel:setPositionChannel:setRateLimitPerUserChannel:setSlowmodeChannel:setTopicChannel:setTypeChannel:startTypingChannel:toJSONChannel:toStringChannel:urlChannel:viewableExamples
Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.
Related APIs
BaseGuildTextChannel · CategoryChannel · Channel · DirectoryChannel · DMChannel · ForumChannel · GuildChannel · MediaChannel
Version: discord 1.2.4 · runtime 1.0.0