IMeetingControlHelper.h

Go to the documentation of this file.

 
#ifndef IMeetingControlHelper_h
#define IMeetingControlHelper_h
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum FocusModeStatus
{
    FocusModeStatusOff = 0, 
    FocusModeStatusEnding = 1, 
    FocusModeStatusOn = 2      
};
 
enum AICompanionOption
{
    AICompanionOptionSmartSummary = 1 << 5,      
    AICompanionOptionSmartQuestion = 1 << 6,     
    AICompanionOptionSmartRecording = 1 << 8,    
};
 
enum AICompanionSwitchAction
{
    AICompanionSwitchActionTurnOff = 1 << 0,    
    AICompanionSwitchActionTurnOn = 1 << 1,     
};
 
enum AICompanionRequestType
{
    AICompanionRequestNone = 0,
    AICompanionRequestSwitch,    //request to switch AIC
    AICompanionRequestEnable,    //request to enable AIC
};
 
struct LiveStreamStatusInfo
{
    bool        isInProgress = false; 
    std::string liveChannelName;    
};
 
struct LiveStreamStatus
{
    bool                 isLiveStreamUnencrypted = false; 
    LiveStreamStatusInfo liveStreamStatusInfo; 
};
 
struct SignalingAppAccessedUser
{
    std::string userName;   
    std::string userGuid;   
    std::string avatarUrl;  
};
 
struct SignalingAppAccessedUserList
{
    std::string                           appID;    
    std::vector<SignalingAppAccessedUser> users;    
};
 
struct SignalingAppPermissionLink
{
    std::string errorMessage;   
    std::string permissionLink; 
    std::string appID;          
};
 
struct SignalingAppInfo
{
    std::string                           appID;                
    std::string                           appName;              
    std::string                           appIconUrl;           
    std::string                           appPermissionLink;    
    std::vector<SignalingAppAccessedUser> accessedUsers;        
    int32_t                               accessedUserCount = 0;
    std::vector<std::string>              accessedScopes;       
};
 
struct SignalingAppList
{
    std::string           errorMessage;         
    std::string           title;                
    std::string           summary;              
    std::vector<SignalingAppInfo> signalingApps;
};
 
struct PrivilegeSettingItem
{
    int32_t      settingID = 0; 
    std::string  description;   
};
 
struct MeetingQueryInfo
{
    bool    isMeetingQueryFeatureOn = false;                
    bool    isMeetingQueryOn = false;                       
    bool    canDisplayPrivilegeSetting = false;             
    bool    canChangePrivilegeSetting = false;              
    int32_t currentPrivilegeSettingID = 0;                  
    std::vector<PrivilegeSettingItem> privilegeSettingItems;
};
 
struct AICompanionRequestInfo
{
    AICompanionRequestType   type = AICompanionRequestNone;
    std::vector<std::string> senderNames;         
    int64_t                  AICFeatures = 0;     
    int32_t                  switchAction = 0;    
};
 
struct AICompanionStatusInfo
{
    int64_t AICFeatures = 0;     
    int64_t assetsOption = 0;    
};
 
class IMeetingControlHelperSink
{
public:
    virtual ~IMeetingControlHelperSink() {}
 
    virtual void OnUpdateIsDisplayTopBannerNotification(bool isDisplayTopBanner) = 0;
 
    virtual void OnUpdateMeetingLockStatus(bool meetingLocked) = 0;
 
    virtual void OnUpdateFocusModeOptionsNotification(bool enable, FocusModeStatus status) = 0;
 
    virtual void OnUpdateLiveStreamStatus(const LiveStreamStatus& status) = 0;
 
    virtual void OnHiFiMusicModeNotification(bool isAllow, bool isEnable) = 0;
 
    virtual void OnHasAppSignalingChanged(bool hasNewAppSignaling) = 0;
 
    virtual void OnUpdateSignalingApps(const SignalingAppList& list) = 0;
 
    virtual void OnUpdateAccessedUsers(const SignalingAppAccessedUserList& list) = 0;
 
    virtual void OnUpdateAppPermissionLink(const SignalingAppPermissionLink& link) = 0;
 
    virtual void OnArchivingStatusNotification(bool isInProgress) = 0;
 
    virtual void OnShowArchivingStatusFailNotification(bool showArchivingFail) = 0;
 
    virtual void OnZoomPhoneACRStatusNotification(bool isInProgress) = 0;
 
    virtual void OnSmartSummaryOn(bool summaryOn, bool hasSetEmail) = 0;
 
    virtual void OnSetMeetingSummaryNotificationEmailNotification(int32_t result) = 0;
 
    virtual void OnUpdateMeetingQueryBaseInfo(const MeetingQueryInfo& info) = 0;
 
    virtual void OnChangeMeetingQueryPrivilegeSettingID(int32_t settingID) = 0;
 
    virtual void OnReceiveAICompanionRequest(const AICompanionRequestInfo& info) = 0;
 
    virtual void OnAICompanionStatusNeedConfirm(const AICompanionStatusInfo& info) = 0;
};
 
class IMeetingControlHelper
{
public:
    virtual ~IMeetingControlHelper() {}
 
    virtual ZRCSDKError RegisterSink(IMeetingControlHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IMeetingControlHelperSink* pSink) = 0;
 
    virtual ZRCSDKError ShowTopBanner(bool show) = 0;
 
    virtual ZRCSDKError LockMeeting(bool lock) = 0;
 
    virtual ZRCSDKError StartFocusMode(bool start) = 0;
 
    virtual ZRCSDKError EnableHiFiMusicMode(bool enable) = 0;
 
    virtual ZRCSDKError HasNewAppSignaling(bool& has) = 0;
 
    virtual ZRCSDKError ListSignalingApps() = 0;
 
    virtual ZRCSDKError ListSignalingAppAccessedUsers(const std::string& appID) = 0;
 
    virtual ZRCSDKError GetSignalingAppPermissionLink(const std::string& appID) = 0;
 
    virtual ZRCSDKError StartMeetingSummary(bool start) = 0;
 
    virtual ZRCSDKError StartMeetingQuery(bool start) = 0;
 
    virtual ZRCSDKError ChangeMeetingQueryPrivilegeSetting(int32_t privilegeSettingID) = 0;
 
    virtual ZRCSDKError SetMeetingSummaryNotificationEmail(const std::string& email) = 0;
 
    virtual ZRCSDKError TurnOnAICompanion(int64_t AICFeatures) = 0;
 
    virtual ZRCSDKError TurnOffAICompanion(int64_t AICFeatures, bool deleteAssets) = 0;
 
    virtual ZRCSDKError RespondToTurnOnAICompanion(bool agree) = 0;
 
    virtual ZRCSDKError RespondToTurnOffAICompanion(bool agree, bool deleteAssets) = 0;
 
    virtual ZRCSDKError AskHostToTurnOnAICompanion(int64_t AICFeatures) = 0;
 
    virtual ZRCSDKError AskHostToTurnOffAllAICompanion() = 0;
 
    virtual ZRCSDKError ConfirmAICompanionStatusWhenJoin(bool agree) = 0;
 
    virtual ZRCSDKError AskToEnableAICompanion(AICompanionOption feature) = 0;
};
 
NS_ZRCSDK_END
 
#endif /* IMeetingControlHelper_h */