dpp::voicestate
dpp::json_interface< voicestate >
voicestate.h
struct friend struct json_interface< voicestate > json_interface< voicestate > dpp::voicestate::json_interface< voicestate > json_interface< voicestate >
snowflake snowflake dpp::voicestate::channel_id channel_id dpp::voicestate::channel_id {0}

The channel id this user is connected to.

This may be empty.

uint8_t uint8_t dpp::voicestate::flags flags dpp::voicestate::flags {0}

Voice state flags from dpp::voicestate_flags.

snowflake snowflake dpp::voicestate::guild_id guild_id dpp::voicestate::guild_id {0}

Optional: The guild id this voice state is for.

time_t time_t dpp::voicestate::request_to_speak request_to_speak dpp::voicestate::request_to_speak {0}

The time at which the user requested to speak.

If the user never requested to speak, this is 0.

std::string std::string dpp::voicestate::session_id session_id dpp::voicestate::session_id

The session id for this voice state.

int32_t int32_t dpp::voicestate::shard_id shard_id dpp::voicestate::shard_id {0}

Owning shard.

snowflake snowflake dpp::voicestate::user_id user_id dpp::voicestate::user_id {0}

The user id this voice state is for.

voicestate & voicestate & dpp::voicestate::fill_from_json_impl (nlohmann::json *j) fill_from_json_impl dpp::voicestate::fill_from_json_impl nlohmann::json * j

Fill voicestate object from json data.

j

JSON data to fill from

voicestate& Reference to self

dpp::voicestate::voicestate
()
voicestate
dpp::voicestate::voicestate

Construct a new voicestate object.

virtual dpp::voicestate::~voicestate
()=default
~voicestate
dpp::voicestate::~voicestate

Destroy the voicestate object.

std::string std::string dpp::json_interface< voicestate >::build_json (bool with_id=false) const build_json dpp::json_interface< voicestate >::build_json bool with_id false

Convert object to json string.

with_id

Whether to include the ID or not

Some fields are conditionally filled, do not rely on all fields being present

std::string Json built from the structure

voicestate & voicestate & dpp::json_interface< voicestate >::fill_from_json (nlohmann::json *j) fill_from_json dpp::json_interface< voicestate >::fill_from_json nlohmann::json * j

Convert object from nlohmann::json.

j

nlohmann::json object

T& Reference to self for fluent calling

bool bool dpp::voicestate::is_deaf () const is_deaf dpp::voicestate::is_deaf

Return true if the user is deafened by the server.

bool bool dpp::voicestate::is_mute () const is_mute dpp::voicestate::is_mute

Return true if the user is muted by the server.

bool bool dpp::voicestate::is_self_deaf () const is_self_deaf dpp::voicestate::is_self_deaf

Return true if user deafened themselves.

bool bool dpp::voicestate::is_self_mute () const is_self_mute dpp::voicestate::is_self_mute

Return true if user muted themselves.

bool bool dpp::voicestate::is_suppressed () const is_suppressed dpp::voicestate::is_suppressed

Return true if user is suppressed.

"HELP HELP I'M BEING SUPPRESSED!"

bool bool dpp::voicestate::self_stream () const self_stream dpp::voicestate::self_stream

Return true if the user is streaming using "Go Live".

bool bool dpp::voicestate::self_video () const self_video dpp::voicestate::self_video

Return true if the user's camera is enabled.

auto auto dpp::json_interface< voicestate >::to_json (bool with_id=false) const to_json dpp::json_interface< voicestate >::to_json bool with_id false

Convert object to nlohmann::json.

with_id

Whether to include the ID or not

Some fields are conditionally filled, do not rely on all fields being present

json Json built from the structure

Represents the voice state of a user on a guild These are stored in the dpp::guild object, and accessible there, or via dpp::channel::get_voice_members.

dpp::json_interface< T >
dpp::json_interface< voicestate >
< voicestate >
dpp::voicestate
dpp::json_interface< T >
dpp::json_interface< voicestate >
< voicestate >
dpp::snowflake
value
dpp::voicestate
shard_id
channel_id
guild_id
user_id
session_id
flags
request_to_speak
int32_t
std::basic_string< Char >
std::string
time_t
uint64_t
uint8_t
- dpp::voicestate
  build_json
- dpp::voicestate
  channel_id
- dpp::voicestate
  fill_from_json
- dpp::voicestate
  fill_from_json_impl
- dpp::voicestate
  flags
- dpp::voicestate
  guild_id
- dpp::voicestate
  is_deaf
- dpp::voicestate
  is_mute
- dpp::voicestate
  is_self_deaf
- dpp::voicestate
  is_self_mute
- dpp::voicestate
  is_suppressed
- dpp::voicestate
  json_interface< voicestate >
- dpp::voicestate
  request_to_speak
- dpp::voicestate
  self_stream
- dpp::voicestate
  self_video
- dpp::voicestate
  session_id
- dpp::voicestate
  shard_id
- dpp::voicestate
  to_json
- dpp::voicestate
  user_id
- dpp::voicestate
  voicestate
- dpp::voicestate
  ~voicestate