dpp::voice_receive_t Struct Reference

voice receive packet More...

#include <dispatcher.h>

Inheritance diagram for dpp::voice_receive_t:

Collaboration diagram for dpp::voice_receive_t:

Public Member Functions
	voice_receive_t (class discord_client *client, const std::string &raw)
	Constructor. More...
const event_dispatch_t &	cancel_event () const
	Cancels the event in progress. Any other attached lambdas for this event after this one are not called. 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). More...
bool	is_cancelled () const
	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). More...

Public Attributes
class discord_voice_client *	voice_client
uint8_t *	audio
	Audio data, encoded as 48kHz stereo PCM or Opus. More...
size_t	audio_size
	Size of audio buffer. More...
snowflake	user_id
	User ID of speaker (zero if unknown) More...
const std::string	raw_event
	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. More...
class discord_client *	from
	Shard the event came from. Note that for some events, notably voice events, this may be nullptr. More...

Detailed Description

voice receive packet

Constructor & Destructor Documentation

voice_receive_t()

dpp::voice_receive_t::voice_receive_t	(	class discord_client *	client,
		const std::string &	raw
	)

Constructor.

Parameters

client	The shard the event originated on. WILL ALWAYS be NULL.
raw	Raw event text as JSON

Member Function Documentation

cancel_event()

const 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. 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

const event_dispatch_t& reference to self for chaining

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

Member Data Documentation

audio

uint8_t* dpp::voice_receive_t::audio

Audio data, encoded as 48kHz stereo PCM or Opus.

audio_size

size_t dpp::voice_receive_t::audio_size

Size of audio buffer.

from

class discord_client* dpp::event_dispatch_t::from

inherited

Shard the event came from. Note that for some events, notably voice events, this may be nullptr.

raw_event

const 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.

user_id

snowflake dpp::voice_receive_t::user_id

User ID of speaker (zero if unknown)

voice_client

class discord_voice_client* dpp::voice_receive_t::voice_client