dpp::voice_client_speaking_t Struct Reference

voice client speaking event More...

#include "dispatcher.h"

Inheritance diagram for dpp::voice_client_speaking_t:

Collaboration diagram for dpp::voice_client_speaking_t:

Public Member Functions
event_dispatch_t &	cancel_event ()
	Cancels the event in progress. More...
const event_dispatch_t &	cancel_event () const
	Cancels the event in progress. More...
	event_dispatch_t ()=default
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (const event_dispatch_t &rhs)=default
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (discord_client *client, const std::string &raw)
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (discord_client *client, std::string &&raw)
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (event_dispatch_t &&rhs)=default
	Construct a new event_dispatch_t object. More...
bool	is_cancelled () const
	Returns true if the event is cancelled. More...
event_dispatch_t &	operator= (const event_dispatch_t &rhs)=default
	Copy another event_dispatch_t object. More...
event_dispatch_t &	operator= (event_dispatch_t &&rhs)=default
	Move from another event_dispatch_t object. More...

Public Attributes
bool	cancelled = false
	Whether the event was cancelled using cancel_event(). More...
discord_client *	from = nullptr
	Shard the event came from. More...
std::string	raw_event = {}
	Raw event data. More...
uint32_t	ssrc = 0
	ssrc value of speaking user More...
snowflake	user_id = {}
	speaking user id More...
discord_voice_client *	voice_client = nullptr
	voice client where user is speaking More...

Detailed Description

voice client speaking event

Member Function Documentation

cancel_event() [1/2]

event_dispatch_t& dpp::event_dispatch_t::cancel_event ( )

inherited

Cancels the event in progress.

Any other attached lambdas for this event after this one are not called.

Warning

This will modify the event object in a non-thread-safe manner.

Returns

const event_dispatch_t& reference to self for chaining

cancel_event() [2/2]

event_dispatch_t & dpp::event_dispatch_t::cancel_event ( ) const

inherited

Cancels the event in progress.

Any other attached lambdas for this event after this one are not called.

Warning

This will modify the event object in a non-thread-safe manner.

Returns

const event_dispatch_t& reference to self for chaining

event_dispatch_t() [1/5]

dpp::event_dispatch_t::event_dispatch_t

default

Construct a new event_dispatch_t object.

event_dispatch_t() [2/5]

dpp::event_dispatch_t::event_dispatch_t

default

Construct a new event_dispatch_t object.

Parameters

rhs	event_dispatch_t object to copy from

event_dispatch_t() [3/5]

dpp::event_dispatch_t::event_dispatch_t

Construct a new event_dispatch_t object.

Parameters

client	The shard the event originated on. May be a nullptr, e.g. for voice events
raw	Raw event data as JSON or ETF

event_dispatch_t() [4/5]

dpp::event_dispatch_t::event_dispatch_t

Construct a new event_dispatch_t object.

Parameters

client	The shard the event originated on. May be a nullptr, e.g. for voice events
raw	Raw event data as JSON or ETF

event_dispatch_t() [5/5]

dpp::event_dispatch_t::event_dispatch_t

default

Construct a new event_dispatch_t object.

Parameters

rhs	event_dispatch_t object to move from

is_cancelled()

bool dpp::event_dispatch_t::is_cancelled ( ) const

inherited

Returns true if the event is cancelled.

Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state).

Returns

true if the event is cancelled

operator=() [1/2]

event_dispatch_t& dpp::event_dispatch_t::operator=

default

Copy another event_dispatch_t object.

Parameters

rhs	The event to copy from

operator=() [2/2]

event_dispatch_t& dpp::event_dispatch_t::operator=

default

Move from another event_dispatch_t object.

Parameters

rhs	The event to move from

Member Data Documentation

cancelled

bool dpp::event_dispatch_t::cancelled = false

mutableinherited

Whether the event was cancelled using cancel_event().

from

discord_client* dpp::event_dispatch_t::from = nullptr

inherited

Shard the event came from.

Note that for some events, notably voice events, this may be nullptr.

Referenced by dpp::interaction_create_t::dialog().

raw_event

std::string dpp::event_dispatch_t::raw_event = {}

inherited

Raw event data.

If you are using json on your websocket, this will contain json, and if you are using ETF as your websocket protocol, it will contain raw ETF data.

ssrc

uint32_t dpp::voice_client_speaking_t::ssrc = 0

ssrc value of speaking user

Referenced by dpp::discord_voice_client::handle_frame().

user_id

snowflake dpp::voice_client_speaking_t::user_id = {}

speaking user id

Referenced by dpp::discord_voice_client::handle_frame().

voice_client

discord_voice_client* dpp::voice_client_speaking_t::voice_client = nullptr

voice client where user is speaking

Referenced by dpp::discord_voice_client::handle_frame().

---

The documentation for this struct was generated from the following file:

• dispatcher.h