conference

Module: Conference Service

Contains the conference information. This structure provides conference details that are required to join a specific conference. The SDK returns conference_info to describe the created or joined conference.

#include <conference.h>

Public Types

	Name
enum	status { Left, Leaving, Joining, Joined, Error, Destroyed, Creating, Created} Possible values representing the current status of a conference.
enum	permissions { updatePermissions, stream, shareVideo, shareScreen, shareFile, sendVideo, sendMessage, sendAudio, record, kick, join, invite} Possible values indicating permissions an SDK user may have in a conference.

Public Attributes

	Name
status	status
std::vector< permissions >	permissions
bool	is_new
std::string	id
std::optional< std::string >	alias

struct dolbyio::comms::conference_info;

Public Types Documentation

enum status

Enumerator	Description
Left	The local participant left the conference.
Leaving	The local participant is leaving the conference.
Joining	The local participant is joining a conference.
Joined	The local participant successfully joined the conference.
Error	A conference error occurred.
Destroyed	The conference is destroyed on the server.
Creating	The SDK is creating a new conference.
Created	The conference is created.

Possible values representing the current status of a conference.

enum permissions

Enumerator	Description
updatePermissions	Allows a participant to update other participants' permissions.
stream	Allows a participant to stream a conference.
shareVideo	Allows a participant to share a video during a conference.
shareScreen	Allows a participant to share a screen during a conference.
shareFile	Allows a participant to share a file during a conference.
sendVideo	Allows a participant to send a video stream during a conference.
sendMessage	Allows a participant to send a message to other participants during a conference.
sendAudio	Allows a participant to send an audio stream during a conference.
record	Allows a participant to record a conference.
kick	Allows a participant to kick other participants from a conference.
join	Allows a participant to join a conference.
invite	Allows a participant to invite other participants to a conference.

Possible values indicating permissions an SDK user may have in a conference.

Public Attributes Documentation

variable status

status status;

The current status of the conference.

variable permissions

std::vector< permissions > permissions;

Permissions that allow a conference participant to perform limited actions during a protected conference.

variable is_new

bool is_new;

Indicates whether the conference represented by the object has been just created.

variable id

std::string id;

The unique conference identifier.

variable alias

std::optional< std::string > alias;

The conference alias. The alias is optional in the case of using the conference ID.