meeting_participants_ctrl_interface.h

Go to the documentation of this file.

#ifndef _MEETING_ParticipantsCtrl_INTERFACE_H_
#define _MEETING_ParticipantsCtrl_INTERFACE_H_
#include "zoom_sdk_def.h"
#include "meeting_service_components/meeting_recording_interface.h"
#if defined(WIN32)
#include "meeting_service_components/meeting_emoji_reaction_interface.h"
#endif
BEGIN_ZOOM_SDK_NAMESPACE
enum UserRole
{
    USERROLE_NONE,
    USERROLE_HOST,
    USERROLE_COHOST,
    USERROLE_PANELIST,
    USERROLE_BREAKOUTROOM_MODERATOR,
    USERROLE_ATTENDEE,
};

typedef struct tagWebinarAttendeeStatus
{
    bool allow_talk;
    tagWebinarAttendeeStatus()
    {
        allow_talk = false;
    }
}WebinarAttendeeStatus;

enum FocusModeShareType
{
    FocusModeShareType_None,
    FocusModeShareType_HostOnly,
    FocusModeShareType_AllParticipants,
};

typedef struct tagZoomSDKVirtualNameTag
{
    int tagID; 
    const zchar_t* tagName;   
 
    tagZoomSDKVirtualNameTag()
    {
        tagID = 0;
        tagName = nullptr;
    }
}ZoomSDKVirtualNameTag;

class IUserInfo
{
public:
    virtual const zchar_t* GetUserName() = 0;
    
    virtual bool IsHost() = 0;
    
    virtual unsigned int GetUserID() = 0;
    
    virtual const zchar_t* GetAvatarPath() = 0;
    
    virtual const zchar_t* GetPersistentId() = 0;
    
    virtual const zchar_t* GetCustomerKey() = 0;
    
    virtual bool IsVideoOn() = 0;
    
    virtual bool IsAudioMuted() = 0;
    
    virtual AudioType GetAudioJoinType() = 0;
    
    virtual bool IsMySelf() = 0;
    
    virtual bool IsInWaitingRoom() = 0;
    
    virtual bool IsRaiseHand() = 0;
    
    virtual UserRole GetUserRole() = 0;
    
    virtual bool IsPurePhoneUser() = 0;
    
    virtual int GetAudioVoiceLevel() = 0;

    virtual bool IsSupportTalkback() = 0;
    
    virtual bool IsClosedCaptionSender() = 0;
    
    virtual bool IsTalking() = 0;
    
    virtual bool IsH323User() = 0;
    
    virtual WebinarAttendeeStatus* GetWebinarAttendeeStatus() = 0;
    
#if defined(WIN32)
    virtual bool IsInterpreter() = 0;
    
    virtual bool IsSignLanguageInterpreter() = 0;
    
    virtual const zchar_t* GetInterpreterActiveLanguage() = 0;
    
    virtual SDKEmojiFeedbackType GetEmojiFeedbackType() = 0;
    
    virtual bool IsCompanionModeUser() = 0;
#endif

    virtual RecordingStatus GetLocalRecordingStatus() = 0;
    
    virtual bool IsRawLiveStreaming() = 0;
    
    virtual bool HasRawLiveStreamPrivilege() = 0;
    
    virtual bool HasCamera() = 0;
    
    virtual bool IsProductionStudioUser() = 0;
    
    virtual bool IsInWebinarBackstage() = 0;
    
    virtual unsigned int GetProductionStudioParent() = 0;
    
    virtual bool IsBotUser() = 0;
    
    virtual const zchar_t* GetBotAppName() = 0;
    
    virtual bool IsVirtualNameTagEnabled() = 0;
    
    virtual IList<ZoomSDKVirtualNameTag>* GetVirtualNameTagList() = 0;

     virtual IList<GrantCoOwnerAssetsInfo>* GetGrantCoOwnerAssetsInfo() = 0;

    virtual bool IsAudioOnlyUser() = 0;
 
    virtual ~IUserInfo(){};
};

class IMeetingParticipantsCtrlEvent
{
public:
    virtual ~IMeetingParticipantsCtrlEvent() {}
    virtual void onUserJoin(IList<unsigned int >* lstUserID, const zchar_t* strUserList = nullptr) = 0;
    
    virtual void onUserLeft(IList<unsigned int >* lstUserID, const zchar_t* strUserList = nullptr) = 0;
    
    virtual void onHostChangeNotification(unsigned int userId) = 0;
    
    virtual void onLowOrRaiseHandStatusChanged(bool bLow, unsigned int userid) = 0;
    
    virtual void onUserNamesChanged(IList<unsigned int>* lstUserID) = 0;
    
    virtual void onCoHostChangeNotification(unsigned int userId, bool isCoHost) = 0;
    
    virtual void onInvalidReclaimHostkey() = 0;
    
    virtual void onAllHandsLowered() = 0;
    
    virtual void onLocalRecordingStatusChanged(unsigned int user_id, RecordingStatus status) = 0;
    
    virtual void onAllowParticipantsRenameNotification(bool bAllow) = 0;
    
    virtual void onAllowParticipantsUnmuteSelfNotification(bool bAllow) = 0;
    
    virtual void onAllowParticipantsStartVideoNotification(bool bAllow) = 0;
    
    virtual void onAllowParticipantsShareWhiteBoardNotification(bool bAllow) = 0;
    
    virtual void onRequestLocalRecordingPrivilegeChanged(LocalRecordingRequestPrivilegeStatus status) = 0;
    
    virtual void onAllowParticipantsRequestCloudRecording(bool bAllow) = 0;
    
    virtual void onInMeetingUserAvatarPathUpdated(unsigned int userID) = 0;
    
    virtual void onParticipantProfilePictureStatusChange(bool bHidden) = 0;
    
    virtual void onFocusModeStateChanged(bool bEnabled) = 0;
    
    virtual void onFocusModeShareTypeChanged(FocusModeShareType type) = 0;
    
    virtual void onBotAuthorizerRelationChanged(unsigned int authorizeUserID) = 0;
    
    virtual void onVirtualNameTagStatusChanged(bool bOn, unsigned int userID) = 0;
    
    virtual void onVirtualNameTagRosterInfoUpdated(unsigned int userID) = 0;
 
#if defined(WIN32)
    virtual void onCreateCompanionRelation(unsigned int parentUserID, unsigned int childUserID) = 0;
    
    virtual void onRemoveCompanionRelation(unsigned int childUserID) = 0;
#endif

     virtual void onGrantCoOwnerPrivilegeChanged(bool canGrantOther) = 0;
};

class IMeetingParticipantsController
{
public:
    virtual SDKError SetEvent(IMeetingParticipantsCtrlEvent* pEvent) = 0;
    
    virtual IList<unsigned int >* GetParticipantsList() = 0;
    
    virtual IUserInfo* GetUserByUserID(unsigned int userid) = 0;
    
    virtual IUserInfo* GetMySelfUser() = 0;
    
    virtual IUserInfo* GetBotAuthorizedUserInfoByUserID(unsigned int userid) = 0;
    
    virtual IList<unsigned int >* GetAuthorizedBotListByUserID(unsigned int userid) = 0;
    
 
#if defined(WIN32)
    virtual IUserInfo* GetCompanionParentUser(unsigned int userid) = 0;
    
    virtual IList<unsigned int >* GetCompanionChildList(unsigned int userid) = 0;
#endif

    virtual SDKError LowerAllHands(bool forWebinarAttendees) = 0;
    
    virtual SDKError ChangeUserName(const unsigned int userid, const zchar_t* userName, bool bSaveUserName) = 0;
    
    virtual SDKError LowerHand(unsigned int userid) = 0;
    
    virtual SDKError RaiseHand() = 0;
    
    virtual SDKError MakeHost(unsigned int userid) = 0;
    
    virtual SDKError CanbeCohost(unsigned int userid) = 0;
    
    virtual SDKError AssignCoHost(unsigned int userid) = 0;
    
    virtual SDKError RevokeCoHost(unsigned int userid) = 0;
    
    virtual SDKError ExpelUser(unsigned int userid) = 0;
    
    virtual bool IsSelfOriginalHost() = 0;
    
    virtual SDKError ReclaimHost() = 0;
    
    virtual SDKError CanReclaimHost(bool& bCanReclaimHost) = 0;
    
    virtual SDKError ReclaimHostByHostKey(const zchar_t* host_key) = 0;
 
    virtual SDKError AllowParticipantsToRename(bool bAllow) = 0;
 
    virtual bool IsParticipantsRenameAllowed() = 0;
 
    virtual SDKError AllowParticipantsToUnmuteSelf(bool bAllow) = 0;
 
    virtual bool IsParticipantsUnmuteSelfAllowed() = 0;
 
    virtual SDKError AskAllToUnmute() = 0;
    
    virtual SDKError AllowParticipantsToStartVideo(bool bAllow) = 0;
    
    virtual bool IsParticipantsStartVideoAllowed() = 0;
    
    virtual SDKError AllowParticipantsToShareWhiteBoard(bool bAllow) = 0;
    
    virtual bool IsParticipantsShareWhiteBoardAllowed() = 0;
    
    virtual SDKError AllowParticipantsToChat(bool bAllow) = 0;
    
    virtual bool IsParticipantAllowedToChat() = 0;
    
    virtual bool IsParticipantRequestLocalRecordingAllowed() = 0;
    
    virtual SDKError AllowParticipantsToRequestLocalRecording(bool bAllow) = 0;
    
    virtual bool IsAutoAllowLocalRecordingRequest() = 0;
    
    virtual SDKError AutoAllowLocalRecordingRequest(bool bAllow) = 0;
    
    virtual SDKError CanHideParticipantProfilePictures() = 0;
    
    virtual bool IsParticipantProfilePicturesHidden() = 0;
    
    virtual SDKError HideParticipantProfilePictures(bool bHide) = 0;
    
    virtual bool IsFocusModeEnabled() = 0;
    
    virtual bool IsFocusModeOn() = 0;
    
    virtual SDKError TurnFocusModeOn(bool turnOn) = 0;
    
    virtual FocusModeShareType GetFocusModeShareType() = 0;
    
    virtual SDKError SetFocusModeShareType(FocusModeShareType shareType) = 0;
    
    virtual bool CanEnableParticipantRequestCloudRecording() = 0;
    
    virtual bool IsParticipantRequestCloudRecordingAllowed() = 0;
    
    virtual SDKError AllowParticipantsToRequestCloudRecording(bool bAllow) = 0;
    
    virtual bool IsSupportVirtualNameTag() = 0;
    
    virtual SDKError EnableVirtualNameTag(bool bEnabled) = 0;
    
    virtual SDKError CreateVirtualNameTagRosterInfoBegin() = 0;
    
    virtual bool AddVirtualNameTagRosterInfoToList(ZoomSDKVirtualNameTag userRoster) = 0;
    
    virtual SDKError CreateVirtualNameTagRosterInfoCommit() = 0;

     virtual bool CanBeCoOwner(unsigned int userid) = 0;

     virtual SDKError AssignCoHostWithAssetsPrivilege(unsigned int userid, IList<GrantCoOwnerAssetsInfo>* list) = 0;
 
     virtual SDKError MakeHostWithAssetsPrivilege(unsigned int userid, IList<GrantCoOwnerAssetsInfo>* list) = 0; 
 
};
END_ZOOM_SDK_NAMESPACE
#endif