Interface IVoiceGuildChannel

Namespace

NetCord

Assembly

NetCord.dll

Represents a generic voice channel within a guild.

public interface IVoiceGuildChannel : IGuildChannel, INamedChannel, IEntity, ISpanFormattable, IFormattable

Inherited Members

IGuildChannel.CreateFromJson(JsonChannel, ulong, RestClient)

IGuildChannel.ModifyPermissionsAsync(PermissionOverwriteProperties, RestRequestProperties, CancellationToken)

IGuildChannel.GetInvitesAsync(RestRequestProperties, CancellationToken)

IGuildChannel.CreateInviteAsync(InviteProperties, RestRequestProperties, CancellationToken)

IGuildChannel.DeletePermissionAsync(ulong, RestRequestProperties, CancellationToken)

IGuildChannel.GuildId

IGuildChannel.Position

IGuildChannel.PermissionOverwrites

INamedChannel.ToString()

INamedChannel.Name

IEntity.Id

IEntity.CreatedAt

ISpanFormattable.TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider)

IFormattable.ToString(string, IFormatProvider)

Properties

Bitrate

The voice channel's bitrate (in bits per second).

int Bitrate { get; }

Property Value

int

Nsfw

Whether the channel is age-restricted.

bool Nsfw { get; }

Property Value

bool

ParentId

The ID of the channel's parent channel.

ulong? ParentId { get; }

Property Value

ulong?

Remarks

If the channel is a thread, the ID corresponds to the thread's parent channel.

RtcRegion

The voice channel's preferred region, if set. When null, Discord automatically determines this.

string? RtcRegion { get; }

Property Value

string

Slowmode

The number of seconds a user has to wait before sending another message, between 0 and 21600 (6 hours).

int Slowmode { get; }

Property Value

int

Remarks

Bots, and users with the BypassSlowmode permission are unaffected.

UserLimit

The voice channel's user limit.

int UserLimit { get; }

Property Value

int

VideoQualityMode

The voice channel's video optimization mode (for cameras).

VideoQualityMode VideoQualityMode { get; }

Property Value

VideoQualityMode

Methods

ModifyAsync(Action<GuildChannelOptions>, RestRequestProperties?, CancellationToken)

Modifies a guild channel's properties.

Task<IVoiceGuildChannel> ModifyAsync(Action<GuildChannelOptions> action, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

action Action<GuildChannelOptions>

An action delegate used to configure the updated channel options.

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task<IVoiceGuildChannel>