Struct SocketVoiceState

Namespace

Discord.WebSocket

Assembly

Discord.Net.WebSocket.dll

Represents a WebSocket user's voice connection status.

public struct SocketVoiceState : IVoiceState

Implements

IVoiceState

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Fields

Default

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

public static readonly SocketVoiceState Default

Field Value

SocketVoiceState

Properties

IsDeafened

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

public bool IsDeafened { get; }

Property Value

bool

true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild; otherwise false.

IsMuted

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

public bool IsMuted { get; }

Property Value

bool

true if this user is muted by the guild; otherwise false.

IsSelfDeafened

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

public bool IsSelfDeafened { get; }

Property Value

bool

true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.

IsSelfMuted

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

public bool IsSelfMuted { get; }

Property Value

bool

true if this user has muted themselves; otherwise false.

IsStreaming

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

public bool IsStreaming { get; }

Property Value

bool

true if the user is streaming; otherwise false.

IsSuppressed

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

public bool IsSuppressed { get; }

Property Value

bool

true if the guild is temporarily blocking audio to/from this user; otherwise false.

IsVideoing

Gets a value that indicates if the user is videoing in a voice channel.

public bool IsVideoing { get; }

Property Value

bool

true if the user has their camera turned on; otherwise false.

RequestToSpeakTimestamp

Gets the time on which the user requested to speak.

public readonly DateTimeOffset? RequestToSpeakTimestamp { get; }

Property Value

DateTimeOffset?

VoiceChannel

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

public readonly SocketVoiceChannel VoiceChannel { get; }

Property Value

SocketVoiceChannel

VoiceSessionId

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

public readonly string VoiceSessionId { get; }

Property Value

string

Methods

ToString()

Gets the name of this voice channel.

public override string ToString()

Returns

string

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