participant_info

Module: Conference Service

Contains the current status of a conference participant and information whether the participant's audio is enabled.

#include <conference.h>

Public Classes

Name
structinfo
Information about a conference participant.

Public Types

Name
enumtype { USER, LISTENER}
The type of participant.
enumstatus { WARNING, RESERVED, ON_AIR, LEFT, INACTIVE, ERROR, DECLINE, CONNECTING}
The possible statuses of conference participants.

Public Attributes

struct dolbyio::comms::participant_info;

Public Types Documentation

enum type

EnumeratorDescription
USERA participant who can send and receive an audio and video stream during a conference.
LISTENERA participant who can receive audio and video streams, but cannot send any stream to a conference.

The type of participant.

enum status

EnumeratorDescription
WARNINGA participant experiences a peer connection problem.
RESERVEDA participant is invited to a conference and is waiting for an invitation.
ON_AIRA participant successfully connected to the conference.
LEFTA participant left the conference.
INACTIVEA participant does not send any audio, video, or screen-share stream to the conference.
ERRORA participant cannot connect to the conference due to a peer connection failure.
DECLINEAn invited participant declined the conference invitation.
CONNECTINGA participant received a conference invitation and is connecting to the conference.

The possible statuses of conference participants.

Public Attributes Documentation

variable user_id

std::string user_id {};

The unique identifier of the participant.

variable type

type type {};

The type of the participant.

variable status

status status {};

The current status of the participant.

variable info

info info;

Additional information about the participant.

variable audio

bool audio {};

A boolean that informs whether the participant receives audio.



Did this page help you?