Skip to main content

Struct SocketVoiceState

Represents a WebSocket user's voice connection status.

Assembly: Discord.Net.WebSocket.dll​
View Source​
Declaration
public struct SocketVoiceState : IVoiceState

Properties​

VoiceChannel​

Gets the voice channel that the user is currently in; or null if none.

View Source​
Declaration
public readonly SocketVoiceChannel VoiceChannel { get; }

VoiceSessionId​

Gets the unique identifier for this user's voice session.

View Source​
Declaration
public readonly string VoiceSessionId { get; }

RequestToSpeakTimestamp​

Gets the time on which the user requested to speak.

View Source​
Declaration
public DateTimeOffset? RequestToSpeakTimestamp { readonly get; }

IsMuted​

Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the guild.

View Source​
Declaration
public readonly bool IsMuted { get; }

IsDeafened​

Gets a value that indicates whether this user is deafened by the guild.

View Source​
Declaration
public readonly bool IsDeafened { get; }

IsSuppressed​

Gets a value that indicates whether the user is muted by the current user.

View Source​
Declaration
public readonly bool IsSuppressed { get; }

IsSelfMuted​

Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to speak via voice).

View Source​
Declaration
public readonly bool IsSelfMuted { get; }

IsSelfDeafened​

Gets a value that indicates whether this user has marked themselves as deafened.

View Source​
Declaration
public readonly bool IsSelfDeafened { get; }

IsStreaming​

Gets a value that indicates if this user is streaming in a voice channel.

View Source​
Declaration
public readonly bool IsStreaming { get; }

IVoiceState.VoiceChannel​

Gets the voice channel this user is currently in.

View Source​
Declaration
readonly IVoiceChannel IVoiceState.VoiceChannel { get; }

Fields​

Default​

Initializes a default Discord.WebSocket.SocketVoiceState with everything set to null or false.

View Source​
Declaration
public static readonly SocketVoiceState Default

Methods​

ToString()​

Gets the name of this voice channel.

View Source​
Declaration
public override string ToString()
Returns​

System.String: A string that resolves to name of this voice channel; otherwise "Unknown".

Implements​