Skip to main content
Version: 0.37.18

APIVoiceChannel

@deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

Hierarchy

  • APIGuildChannel<ChannelType.GuildStageVoice | ChannelType.GuildVoice>
    • APIVoiceChannel

Index

Properties

Properties

optionalbitrate

bitrate?: number

The bitrate (in bits) of the voice channel

optionalguild_id

guild_id?: string

The id of the guild (may be missing for some channel objects received over gateway guild dispatches)

id

id: string

The id of the channel

optionalname

name?: string

The name of the channel (2-100 characters)

optionalnsfw

nsfw?: boolean

Whether the channel is nsfw

optionalparent_id

parent_id?: null | string

ID of the parent category for a channel (each parent category can contain up to 50 channels)

optionalpermission_overwrites

permission_overwrites?: APIOverwrite[]

Explicit permission overwrites for members and roles

See https://discord.com/developers/docs/resources/channel#overwrite-object

optionalposition

position?: number

Sorting position of the channel

optionalrtc_region

rtc_region?: null | string

Voice region id for the voice or stage channel, automatic when set to null

See https://discord.com/developers/docs/resources/voice#voice-region-object

type

type: GuildVoice | GuildStageVoice

The type of the channel

See https://discord.com/developers/docs/resources/channel#channel-object-channel-types

optionaluser_limit

user_limit?: number

The user limit of the voice channel

optionalvideo_quality_mode

video_quality_mode?: VideoQualityMode

The camera video quality mode of the voice channel, 1 when not present

See https://discord.com/developers/docs/resources/channel#channel-object-video-quality-modes