Meeting Participant interfaces. More...

#include "ZRCSDKTypes.h"

Data Structures
class	IParticipantHelperSink
	Meeting Participant helper event callback. More...

class	IParticipantHelper
	Meeting Participant helper interface. More...

Enumerations
enum	ZRWUserChangeType { ZRW_JOIN = 0 , ZRW_LEAVE = 1 }
	Zoom Room Whiteboard as a user in meeting, change type. Here are more detailed structural descriptions. More...

enum	ClaimHostResult { ClaimHostResultSuccess = 0 , ClaimHostResultInvalidHostKey = 1 , ClaimHostResultUnknownError = 2 }
	Claim host result Here are more detailed structural descriptions. More...

enum	ReportIssueType { ISSUE_TYPE_OFFENSIVE_ILLEGAL_ABUSIVE = 0x40 , ISSUE_TYPE_SUICIDE_SELF_HARM = 0x80 , ISSUE_TYPE_PRIVATE_INFORMATION = 0x100 , ISSUE_TYPE_SPAM = 0x200 , ISSUE_TYPE_COPYRIGHT_TRADEMARK_INFRINGEMENT = 0x400 , ISSUE_TYPE_IMPERSONATION = 0x800 , ISSUE_TYPE_ILL_TELL_YOU_LATER = 0x1 }
	Report issue type. Here are more detailed structural descriptions. More...

enum	ConfSessionType { CurrentSession = 1 , MasterSession = 2 }
	Conf session type ZR supports various scenarios, such as breakout rooms in normal meetings and backstage in webinars (all depending on web option). In these cases, ZR can connect to multiple conference instances simultaneously (e.g., session1, session2, etc.).As a result, datas of a participant may appear in more than one session at the same time. More...

Detailed Description

Meeting Participant interfaces.

Since: Added in ZRC SDK 6.0.0

Definition in file IParticipantHelper.h.

Enumeration Type Documentation

◆ ClaimHostResult

enum ClaimHostResult

Claim host result Here are more detailed structural descriptions.

Enumerator
ClaimHostResultSuccess	Success.
ClaimHostResultInvalidHostKey	Fail, invalid host key.
ClaimHostResultUnknownError	Fail, unclassified error.

Definition at line 27 of file IParticipantHelper.h.

{
    ClaimHostResultSuccess = 0,           
    ClaimHostResultInvalidHostKey = 1,    
    ClaimHostResultUnknownError = 2       
};

◆ ConfSessionType

enum ConfSessionType

Conf session type ZR supports various scenarios, such as breakout rooms in normal meetings and backstage in webinars (all depending on web option). In these cases, ZR can connect to multiple conference instances simultaneously (e.g., session1, session2, etc.).As a result, datas of a participant may appear in more than one session at the same time.

To streamline participant management, two logical session types are defined: Master and Current.

Current: The Current session refers to the specific session in which you are actively participating. Master: The Master session represents the overarching meeting that encompasses all sub-sessions.

If you have the appropriate permissions and API support, the SDK can manage the current session and all sessions through the data from 'Current' and 'Master' respectively (note: If there is only one conference instance, the Master is the same as the Current ).

Enumerator
CurrentSession	The specific session in which you are actively participating.
MasterSession	The overarching meeting that encompasses all sub-sessions.

Definition at line 63 of file IParticipantHelper.h.

{
    CurrentSession = 1,    
    MasterSession = 2,     
};

◆ ReportIssueType

enum ReportIssueType

Report issue type. Here are more detailed structural descriptions.

Enumerator
ISSUE_TYPE_OFFENSIVE_ILLEGAL_ABUSIVE
ISSUE_TYPE_SUICIDE_SELF_HARM
ISSUE_TYPE_PRIVATE_INFORMATION
ISSUE_TYPE_SPAM
ISSUE_TYPE_COPYRIGHT_TRADEMARK_INFRINGEMENT
ISSUE_TYPE_IMPERSONATION
ISSUE_TYPE_ILL_TELL_YOU_LATER

Definition at line 38 of file IParticipantHelper.h.

{
    ISSUE_TYPE_OFFENSIVE_ILLEGAL_ABUSIVE = 0x40,
    ISSUE_TYPE_SUICIDE_SELF_HARM = 0x80,
    ISSUE_TYPE_PRIVATE_INFORMATION = 0x100,
    ISSUE_TYPE_SPAM = 0x200,
    ISSUE_TYPE_COPYRIGHT_TRADEMARK_INFRINGEMENT = 0x400,
    ISSUE_TYPE_IMPERSONATION = 0x800,
    ISSUE_TYPE_ILL_TELL_YOU_LATER = 0x1
};

◆ ZRWUserChangeType

enum ZRWUserChangeType

Zoom Room Whiteboard as a user in meeting, change type. Here are more detailed structural descriptions.

Enumerator
ZRW_JOIN	ZRW join meeting.
ZRW_LEAVE	ZRW leave meeting.

Definition at line 17 of file IParticipantHelper.h.

{
    ZRW_JOIN = 0,     
    ZRW_LEAVE = 1,    
};