harmonylink • Docs

---

harmonylink / SetStateUpdate

Interface: SetStateUpdate

From the discord docs

SetStateUpdate

Description

This interface is used to update the voice state of a user.

Properties

channel_id

channel_id: string

the channel id this user is connected to

Defined in

src/typings/player/connection.ts:36

---

deaf

deaf: boolean

whether this user is deafened by the server

Defined in

src/typings/player/connection.ts:56

---

guild_id?

optional guild_id: string

the guild id this voice state is for

Defined in

src/typings/player/connection.ts:31

---

member?

optional member: Record<string, unknown>

the guild member this voice state is for

Defined in

src/typings/player/connection.ts:46

---

mute

mute: boolean

whether this user is muted by the server

Defined in

src/typings/player/connection.ts:61

---

request_to_speak_timestamp?

optional request_to_speak_timestamp: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}.${number}${number}${number}Z`

the time at which the user requested to speak

Defined in

src/typings/player/connection.ts:91

---

self_deaf

self_deaf: boolean

whether this user is locally deafened

Defined in

src/typings/player/connection.ts:66

---

self_mute

self_mute: boolean

whether this user is locally muted

Defined in

src/typings/player/connection.ts:71

---

self_stream?

optional self_stream: boolean

whether this user is streaming using "Go Live"

Defined in

src/typings/player/connection.ts:76

---

self_video

self_video: boolean

whether this user's camera is enabled

Defined in

src/typings/player/connection.ts:81

---

session_id

session_id: string

the session id for this voice state

Defined in

src/typings/player/connection.ts:51

---

suppress

suppress: boolean

whether this user is muted by the current user

Defined in

src/typings/player/connection.ts:86

---

user_id

user_id: string

the user id this voice state is for

Defined in

src/typings/player/connection.ts:41