![]() |
D++ (DPP)
C++ Discord API Bot Library
|
Represents a voice channel effect e.g. a soundboard sound or an emoji reaction. More...
#include <voice_channel_effect.h>
Public Member Functions | |
voice_channel_effect () | |
Construct a new voice_channel_effect object. More... | |
virtual | ~voice_channel_effect ()=default |
Destroy the voice_channel_effect object. More... | |
std::string | build_json (bool with_id=false) const |
Convert object to json string. More... | |
voice_channel_effect & | fill_from_json (nlohmann::json *j) |
Convert object from nlohmann::json. More... | |
auto | to_json (bool with_id=false) const |
Convert object to nlohmann::json. More... | |
Public Attributes | |
uint32_t | animation_id {0} |
The ID of the emoji animation, for emoji reaction and soundboard effects. More... | |
uint8_t | animation_type {0} |
The type of emoji animation, for emoji reaction and soundboard effects. More... | |
snowflake | channel_id {0} |
The channel id the user who sent the effect is connected to. More... | |
dpp::emoji | emoji |
The emoji of the voice channel effect. More... | |
snowflake | guild_id {0} |
The guild id with the channel this effect was sent in. More... | |
int32_t | shard_id {0} |
Owning shard. More... | |
snowflake | sound_id {0} |
The ID of the soundboard sound, for soundboard effects. More... | |
double | sound_volume {0} |
The volume of the soundboard sound, from 0 to 1, for soundboard effects. More... | |
snowflake | user_id {0} |
The user id who sent the effect. More... | |
Protected Member Functions | |
voice_channel_effect & | fill_from_json_impl (nlohmann::json *j) |
Fill voice channel effect object from json data. More... | |
Friends | |
struct | json_interface< voice_channel_effect > |
Represents a voice channel effect e.g. a soundboard sound or an emoji reaction.
dpp::voice_channel_effect::voice_channel_effect | ( | ) |
Construct a new voice_channel_effect object.
|
virtualdefault |
Destroy the voice_channel_effect object.
|
inlineinherited |
Convert object to json string.
with_id | Whether to include the ID or not |
|
inlineinherited |
Convert object from nlohmann::json.
j | nlohmann::json object |
|
protected |
Fill voice channel effect object from json data.
j | JSON data to fill from |
|
inlineinherited |
Convert object to nlohmann::json.
with_id | Whether to include the ID or not |
|
friend |
uint32_t dpp::voice_channel_effect::animation_id {0} |
The ID of the emoji animation, for emoji reaction and soundboard effects.
uint8_t dpp::voice_channel_effect::animation_type {0} |
The type of emoji animation, for emoji reaction and soundboard effects.
snowflake dpp::voice_channel_effect::channel_id {0} |
The channel id the user who sent the effect is connected to.
dpp::emoji dpp::voice_channel_effect::emoji |
The emoji of the voice channel effect.
snowflake dpp::voice_channel_effect::guild_id {0} |
The guild id with the channel this effect was sent in.
int32_t dpp::voice_channel_effect::shard_id {0} |
Owning shard.
snowflake dpp::voice_channel_effect::sound_id {0} |
The ID of the soundboard sound, for soundboard effects.
double dpp::voice_channel_effect::sound_volume {0} |
The volume of the soundboard sound, from 0 to 1, for soundboard effects.
snowflake dpp::voice_channel_effect::user_id {0} |
The user id who sent the effect.