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.
More...
|
| voicestate () |
| Construct a new voicestate object. More...
|
|
virtual | ~voicestate ()=default |
| Destroy the voicestate object. More...
|
|
bool | is_deaf () const |
| Return true if the user is deafened by the server. More...
|
|
bool | is_mute () const |
| Return true if the user is muted by the server. More...
|
|
bool | is_self_mute () const |
| Return true if user muted themselves. More...
|
|
bool | is_self_deaf () const |
| Return true if user deafened themselves. More...
|
|
bool | self_stream () const |
| Return true if the user is streaming using "Go Live". More...
|
|
bool | self_video () const |
| Return true if the user's camera is enabled. More...
|
|
bool | is_suppressed () const |
| Return true if user is suppressed. More...
|
|
template<typename U = T, typename = decltype(std::declval<U&>().fill_from_json_impl(std::declval<nlohmann::json*>()))> |
T & | fill_from_json (nlohmann::json *j) |
| Convert object from nlohmann::json. More...
|
|
template<typename U = T, typename = decltype(std::declval<U&>().to_json_impl(bool{}))> |
auto | to_json (bool with_id=false) const |
| Convert object to nlohmann::json. More...
|
|
template<typename U = T, typename = decltype(std::declval<U&>().to_json_impl(bool{}))> |
std::string | build_json (bool with_id=false) const |
| Convert object to json string. More...
|
|
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.
◆ voicestate()
dpp::voicestate::voicestate |
( |
| ) |
|
Construct a new voicestate object.
◆ ~voicestate()
virtual dpp::voicestate::~voicestate |
( |
| ) |
|
|
virtualdefault |
Destroy the voicestate object.
◆ build_json()
template<typename T >
template<typename U = T, typename = decltype(std::declval<U&>().to_json_impl(bool{}))>
Convert object to json string.
- Parameters
-
with_id | Whether to include the ID or not |
- Note
- Some fields are conditionally filled, do not rely on all fields being present
- Returns
- std::string Json built from the structure
◆ fill_from_json()
template<typename T >
template<typename U = T, typename = decltype(std::declval<U&>().fill_from_json_impl(std::declval<nlohmann::json*>()))>
Convert object from nlohmann::json.
- Parameters
-
- Returns
- T& Reference to self for fluent calling
◆ fill_from_json_impl()
voicestate& dpp::voicestate::fill_from_json_impl |
( |
nlohmann::json * |
j | ) |
|
|
protected |
Fill voicestate object from json data.
- Parameters
-
- Returns
- voicestate& Reference to self
◆ is_deaf()
bool dpp::voicestate::is_deaf |
( |
| ) |
const |
Return true if the user is deafened by the server.
◆ is_mute()
bool dpp::voicestate::is_mute |
( |
| ) |
const |
Return true if the user is muted by the server.
◆ is_self_deaf()
bool dpp::voicestate::is_self_deaf |
( |
| ) |
const |
Return true if user deafened themselves.
◆ is_self_mute()
bool dpp::voicestate::is_self_mute |
( |
| ) |
const |
Return true if user muted themselves.
◆ is_suppressed()
bool dpp::voicestate::is_suppressed |
( |
| ) |
const |
Return true if user is suppressed.
"HELP HELP I'M BEING SUPPRESSED!"
◆ self_stream()
bool dpp::voicestate::self_stream |
( |
| ) |
const |
Return true if the user is streaming using "Go Live".
◆ self_video()
bool dpp::voicestate::self_video |
( |
| ) |
const |
Return true if the user's camera is enabled.
◆ to_json()
template<typename T >
template<typename U = T, typename = decltype(std::declval<U&>().to_json_impl(bool{}))>
Convert object to nlohmann::json.
- Parameters
-
with_id | Whether to include the ID or not |
- Note
- Some fields are conditionally filled, do not rely on all fields being present
- Returns
- json Json built from the structure
◆ json_interface< voicestate >
◆ channel_id
The channel id this user is connected to.
- Note
- This may be empty.
◆ flags
uint8_t dpp::voicestate::flags {0} |
◆ guild_id
Optional: The guild id this voice state is for.
◆ request_to_speak
time_t dpp::voicestate::request_to_speak {0} |
The time at which the user requested to speak.
- Note
- If the user never requested to speak, this is 0.
◆ session_id
std::string dpp::voicestate::session_id |
The session id for this voice state.
◆ shard
◆ user_id
The user id this voice state is for.