DiscordVoiceState

data class DiscordVoiceState(val guildId: OptionalSnowflake = OptionalSnowflake.Missing, val channelId: Snowflake?, val userId: Snowflake, val member: Optional<DiscordGuildMember> = Optional.Missing(), val sessionId: String, val deaf: Boolean, val mute: Boolean, val selfDeaf: Boolean, val selfMute: Boolean, val selfVideo: Boolean, val selfStream: OptionalBoolean = OptionalBoolean.Missing, val suppress: Boolean, val requestToSpeakTimestamp: Instant?)(source)

A representation of the Discord Voice State structure. Used to represent a user's voice connection status.

Parameters

guildId

The guild id this voice state is for.

channelId

The channel id this user is connected to.

userId

The user id this voice state is for.

member

The guild member this voice state is for.

sessionId

The session id for this voice state.

deaf

Whether this user is deafened by the server.

mute

Whether this user is muted by the server.

selfDeaf

Whether this user is locally deafened.

selfMute

Whether this user is locally muted.

selfStream

Whether this user is stream using "Go Live".

selfVideo

Whether this user's camera is enabled.

suppress

Whether this user is muted by the current user.

requestToSpeakTimestamp

The time at which the user requested to speak.

Constructors

Link copied to clipboard
constructor(guildId: OptionalSnowflake = OptionalSnowflake.Missing, channelId: Snowflake?, userId: Snowflake, member: Optional<DiscordGuildMember> = Optional.Missing(), sessionId: String, deaf: Boolean, mute: Boolean, selfDeaf: Boolean, selfMute: Boolean, selfVideo: Boolean, selfStream: OptionalBoolean = OptionalBoolean.Missing, suppress: Boolean, requestToSpeakTimestamp: Instant?)

Properties

Link copied to clipboard
@SerialName(value = "channel_id")
val channelId: Snowflake?
Link copied to clipboard
Link copied to clipboard
@SerialName(value = "guild_id")
val guildId: OptionalSnowflake
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@SerialName(value = "request_to_speak_timestamp")
val requestToSpeakTimestamp: Instant?
Link copied to clipboard
@SerialName(value = "self_deaf")
val selfDeaf: Boolean
Link copied to clipboard
@SerialName(value = "self_mute")
val selfMute: Boolean
Link copied to clipboard
@SerialName(value = "self_stream")
val selfStream: OptionalBoolean
Link copied to clipboard
@SerialName(value = "self_video")
val selfVideo: Boolean
Link copied to clipboard
@SerialName(value = "session_id")
val sessionId: String
Link copied to clipboard
Link copied to clipboard
@SerialName(value = "user_id")
val userId: Snowflake