dpp::voiceconn Class Reference

Represents a connection to a voice channel. A client can only connect to one voice channel per guild at a time, so these are stored in a map in the dpp::discord_client keyed by guild_id. More...

#include <discordclient.h>

Collaboration diagram for dpp::voiceconn:

Public Member Functions
	voiceconn ()=default
	Construct a new voiceconn object. More...
	voiceconn (class discord_client *o, snowflake _channel_id)
	Construct a new voiceconn object. More...
	~voiceconn ()
	Destroy the voiceconn object. More...
voiceconn &	connect (snowflake guild_id)
	Create websocket object and connect it. Needs hosname, token and session_id to be set or does nothing. More...
voiceconn &	disconnect ()
	Disconnect from the currently connected voice channel. More...
bool	is_active ()
	return true if the connection is active (websocket exists) More...
bool	is_ready ()
	return true if the connection is ready to connect (has hostname, token and session id) More...

Public Attributes
snowflake	channel_id
	Voice Channel ID. More...
std::string	session_id
	Voice Voice session ID. More...
std::string	token
	Voice websocket token. More...
class discord_voice_client *	voiceclient
	voice websocket client More...
std::string	websocket_hostname
	Websocket hostname for status. More...

Detailed Description

Represents a connection to a voice channel. A client can only connect to one voice channel per guild at a time, so these are stored in a map in the dpp::discord_client keyed by guild_id.

Constructor & Destructor Documentation

voiceconn() [1/2]

dpp::voiceconn::voiceconn ( )

default

Construct a new voiceconn object.

voiceconn() [2/2]

dpp::voiceconn::voiceconn	(	class discord_client *	o,
		snowflake	_channel_id
	)

Construct a new voiceconn object.

Parameters

o	owner
_channel_id	voice channel id

~voiceconn()

dpp::voiceconn::~voiceconn

(

)

Destroy the voiceconn object.

Member Function Documentation

connect()

voiceconn & dpp::voiceconn::connect

(

snowflake

guild_id

)

Create websocket object and connect it. Needs hosname, token and session_id to be set or does nothing.

Parameters

guild_id

Guild to connect to the voice channel on

Returns

reference to self

disconnect()

voiceconn & dpp::voiceconn::disconnect

(

)

Disconnect from the currently connected voice channel.

Returns

reference to self

is_active()

bool dpp::voiceconn::is_active

(

)

return true if the connection is active (websocket exists)

Returns

true if has an active websocket

is_ready()

bool dpp::voiceconn::is_ready

(

)

return true if the connection is ready to connect (has hostname, token and session id)

Returns

true if ready to connect

Member Data Documentation

channel_id

snowflake dpp::voiceconn::channel_id

Voice Channel ID.

session_id

std::string dpp::voiceconn::session_id

Voice Voice session ID.

token

std::string dpp::voiceconn::token

Voice websocket token.

voiceclient

class discord_voice_client* dpp::voiceconn::voiceclient

voice websocket client

websocket_hostname

std::string dpp::voiceconn::websocket_hostname

Websocket hostname for status.