Table of Contents

Struct SocketVoiceState

Namespace
Kook.WebSocket
Assembly
Kook.Net.WebSocket.dll

Represents a WebSocket user's voice connection status.

public struct SocketVoiceState : IVoiceState
Implements
Inherited Members

Constructors

SocketVoiceState()

Initializes a new SocketVoiceState with the specified voice channel.

public SocketVoiceState()

Properties

Default

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

public static SocketVoiceState Default { get; }

Property Value

SocketVoiceState

IsDeafened

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

public readonly 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; null if unknown.

IsMuted

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

public readonly bool? IsMuted { get; }

Property Value

bool?

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

LiveStreamStatus

Gets the live stream status of the user.

public readonly LiveStreamStatus? LiveStreamStatus { get; }

Property Value

LiveStreamStatus?

VoiceChannel

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

public SocketVoiceChannel? VoiceChannel { get; }

Property Value

SocketVoiceChannel

VoiceChannels

Gets a collection of voice channels that the user is connected to.

public IReadOnlyCollection<SocketVoiceChannel> VoiceChannels { get; }

Property Value

IReadOnlyCollection<SocketVoiceChannel>

Remarks

Currently, KOOK only allows a user to be in one voice channel at a time, but allows a Bot user to be in multiple voice channels at a time.

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".

Edit this page