conference_info

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
enumstatus { Left, Leaving, Joining, Joined, Error, Destroyed, Creating, Created}
Possible values representing the current status of a conference.
enumpermissions { 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
statusstatus
std::vector< permissions >permissions
boolis_new
std::stringid
std::optional< std::string >alias
struct dolbyio::comms::conference_info;

Public Types Documentation

enum status

EnumeratorDescription
LeftThe local participant left the conference.
LeavingThe local participant is leaving the conference.
JoiningThe local participant is joining a conference.
JoinedThe local participant successfully joined the conference.
ErrorA conference error occurred.
DestroyedThe conference is destroyed on the server.
CreatingThe SDK is creating a new conference.
CreatedThe conference is created.

Possible values representing the current status of a conference.

enum permissions

EnumeratorDescription
updatePermissionsAllows a participant to update other participants' permissions.
streamAllows a participant to stream a conference.
shareVideoAllows a participant to share a video during a conference.
shareScreenAllows a participant to share a screen during a conference.
shareFileAllows a participant to share a file during a conference.
sendVideoAllows a participant to send a video stream during a conference.
sendMessageAllows a participant to send a message to other participants during a conference.
sendAudioAllows a participant to send an audio stream during a conference.
recordAllows a participant to record a conference.
kickAllows a participant to kick other participants from a conference.
joinAllows a participant to join a conference.
inviteAllows 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.



Did this page help you?