Class SocketVoiceChannel
Represents a WebSocket-based voice channel in a guild.
Inheritance
SocketVoiceChannel
Inherited Members
SocketTextChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)
SocketTextChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)
SocketTextChannel.SendFileAsync(FileAttachment, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)
SocketTextChannel.SendFilesAsync(IEnumerable<FileAttachment>, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)
Assembly: Discord.Net.WebSocket.dll
Syntax
public class SocketVoiceChannel : SocketTextChannel, IEntity<ulong>, ISocketMessageChannel, IVoiceChannel, ITextChannel, IMessageChannel, IMentionable, INestedChannel, IIntegrationChannel, IGuildChannel, IDeletable, ISocketAudioChannel, IAudioChannel, IChannel, ISnowflakeEntity, IEntity<ulong>
Properties
|
Improve this Doc
View Source
Bitrate
Declaration
public int Bitrate { get; }
Property Value
|
Improve this Doc
View Source
ConnectedUsers
Gets a collection of users that are currently connected to this voice channel.
Declaration
public IReadOnlyCollection<SocketGuildUser> ConnectedUsers { get; }
Property Value
Type |
Description |
IReadOnlyCollection<SocketGuildUser> |
A read-only collection of users that are currently connected to this voice channel.
|
|
Improve this Doc
View Source
IsTextInVoice
Gets whether or not the guild has Text-In-Voice enabled and the voice channel is a TiV channel.
Declaration
public virtual bool IsTextInVoice { get; }
Property Value
|
Improve this Doc
View Source
RTCRegion
Declaration
public string RTCRegion { get; }
Property Value
|
Improve this Doc
View Source
UserLimit
Declaration
public int? UserLimit { get; }
Property Value
|
Improve this Doc
View Source
VideoQualityMode
Gets the video quality mode for this channel.
Declaration
public VideoQualityMode VideoQualityMode { get; }
Property Value
Methods
|
Improve this Doc
View Source
ConnectAsync(Boolean, Boolean, Boolean)
Declaration
public async Task<IAudioClient> ConnectAsync(bool selfDeaf = false, bool selfMute = false, bool external = false)
Parameters
Returns
|
Improve this Doc
View Source
CreateThreadAsync(String, ThreadType, ThreadArchiveDuration, IMessage, Nullable<Boolean>, Nullable<Int32>, RequestOptions)
Declaration
public override Task<SocketThreadChannel> CreateThreadAsync(string name, ThreadType type = default(ThreadType), ThreadArchiveDuration autoArchiveDuration = default(ThreadArchiveDuration), IMessage message = null, bool? invitable = null, int? slowmode = null, RequestOptions options = null)
Parameters
Type |
Name |
Description |
String |
name |
The name of the thread.
|
ThreadType |
type |
The type of the thread.
Note: This parameter is not used if the message parameter is not specified.
|
ThreadArchiveDuration |
autoArchiveDuration |
The duration on which this thread archives after.
|
IMessage |
message |
The message which to start the thread from.
|
Nullable<Boolean> |
invitable |
|
Nullable<Int32> |
slowmode |
|
RequestOptions |
options |
The options to be used when sending the request.
|
Returns
Overrides
|
Improve this Doc
View Source
DisconnectAsync()
Declaration
public async Task DisconnectAsync()
Returns
|
Improve this Doc
View Source
GetActiveThreadsAsync(RequestOptions)
Gets a collection of active threads within this channel.
Declaration
public override Task<IReadOnlyCollection<RestThreadChannel>> GetActiveThreadsAsync(RequestOptions options = null)
Parameters
Type |
Name |
Description |
RequestOptions |
options |
The options to be used when sending the request.
|
Returns
Type |
Description |
Task<IReadOnlyCollection<RestThreadChannel>> |
A task that represents an asynchronous get operation for retrieving the threads. The task result contains
a collection of active threads.
|
Overrides
|
Improve this Doc
View Source
GetUser(UInt64)
Declaration
public override SocketGuildUser GetUser(ulong id)
Parameters
Type |
Name |
Description |
UInt64 |
id |
|
Returns
Overrides
|
Improve this Doc
View Source
ModifyAsync(Action<AudioChannelProperties>, RequestOptions)
Declaration
public async Task ModifyAsync(Action<AudioChannelProperties> func, RequestOptions options = null)
Parameters
Returns
|
Improve this Doc
View Source
ModifyAsync(Action<VoiceChannelProperties>, RequestOptions)
Declaration
public Task ModifyAsync(Action<VoiceChannelProperties> func, RequestOptions options = null)
Parameters
Returns
Implements