IMeetingWebinarHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IMEETINGWEBINARHELPER_H
#define ZRC_IMEETINGWEBINARHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum WebinarRoleChangedState
{
    WebinarRoleChangedNone = 0,    
    WebinarRoleChangedPromote,     
    WebinarRoleChangedDemote       
};
 
enum DynamicWebinarAttendeeListType
{
    DynamicWebinarAttendeeListType_Unknown = 0,                  
    DynamicWebinarAttendeeListType_ATTENDEE_LIST,                
    DynamicWebinarAttendeeListType_UNENCRYPTED_ATTENDEE_LIST,    
};
 
struct WebinarInfo
{
    bool isViewOnlyCanTalk = false;    
};
 
struct WebinarAttendeeBaseInfo
{
    int32_t attendeeCount = 0;    
    int32_t raisedCount = 0;      
};
 
struct DynamicWebinarAttendeeListRes
{
    DynamicWebinarAttendeeListType attendeeListType = DynamicWebinarAttendeeListType_Unknown;    
 
    int32_t                         result = 0;              
    std::string                     keywords;                
    int32_t                         totalOfAttendees = 0;    
    std::vector<MeetingParticipant> attendees;               
    int32_t                         index = 0;               
};
 
struct WebinarParticipantCountInfo
{
    int32_t panelistCount = 0;    
    int32_t attendeeCount = 0;    
};
 
struct WebinarUnencryptedInfo
{
    int32_t unencryptedAttendeeCount = 0;     
    int32_t unencryptedPhoneUserCount = 0;    
};
 
enum BackstageError
{
    BackstageErrorNone = 0,                     
    BackstageErrorFailToJoinBackstage,          
    BackstageErrorFailToJoinWebinar,            
    BackstageErrorFailToMovePanelistToWebinar,  
    BackstageErrorFailToMovePanelistToBackstage 
};
 
enum BackstageStatus
{
    BackstageStatusUnknown = -1,            
    BackstageStatusInBackstage = 0,         
    BackstageStatusInWebinar,               
    BackstageStatusInDebriefSession,        
    BackstageStatusJoiningBackstage,        
    BackstageStatusJoiningWebinar,          
    BackstageStatusJoiningDebriefSession    
};
 
struct BackstageInfo
{
    BackstageStatus status = BackstageStatusUnknown;                        
    float           webinarVolume = 0;                                      
    bool            isShowingWebinarLiveFeed = false;                       
    bool            canSwitchBetweenBackstageContentAndLiveFeed = false;    
    bool            canPanelistMoveBetweenWebinarAndBackstage = false;      
    bool            showVideoPreview = false;                               
    NewJoinFlowInfo videoPreviewInfo;                                       
};
 
struct BackstageNotification
{
    BackstageInfo      backstageInfo;                   
    BackstageError     errorType = BackstageErrorNone;  
    int32_t            errorCode = 0;                   
};
 
class IMeetingWebinarHelperSink
{
public:
    virtual ~IMeetingWebinarHelperSink() {}
 
    virtual void OnWebinarPracticeSessionNotification(bool inWebinarPracticeSession) = 0;
 
    virtual void OnUpdateWebinarInfo(const WebinarInfo& info) = 0;
 
    virtual void OnWebinarRoleChangedNotification(WebinarRoleChangedState roleChangedState) = 0;
 
    virtual void OnPanelistReachMaximumCapacityNotification(int32_t maximumCapacity) = 0;
 
    virtual void OnWebinarAttendeeBaseInfoNotification(const WebinarAttendeeBaseInfo& baseInfo) = 0;
 
    virtual void OnDynamicWebinarAttendeeListResponse(const DynamicWebinarAttendeeListRes& response) = 0;
 
    virtual void OnNeedPromoteAttendeeToAllowTalkingNotification(int32_t userID, const std::string& userName) = 0;
 
    virtual void OnAllowAttendeeViewParticipantCountNotification(bool allow) = 0;
 
    virtual void OnWebinarParticipantCountNotification(const WebinarParticipantCountInfo& countInfo) = 0;
 
    virtual void OnWebinarUnencryptedInfoNotification(const WebinarUnencryptedInfo& unencryptedInfo) = 0;
 
    virtual void OnBackstageNotification(const BackstageNotification& noti) = 0;
 
    virtual void OnBackstageInfoNotification(const BackstageInfo& info) = 0;
 
    virtual void OnProductionStudioNotification(bool isProducerPublishing) = 0;
};
 
class IMeetingWebinarHelper
{
public:
    virtual ~IMeetingWebinarHelper() {}
 
    virtual ZRCSDKError RegisterSink(IMeetingWebinarHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IMeetingWebinarHelperSink* pSink) = 0;
 
    virtual ZRCSDKError StartWebinarFromPracticeSession() = 0;
 
    virtual ZRCSDKError IsInWebinarPracticeSession(bool& inPracticeSession) = 0;
 
    virtual ZRCSDKError PromoteAttendeeToPanelist(int32_t userID) = 0;
 
    virtual ZRCSDKError DemotePanelistToAttendee(int32_t userID) = 0;
 
    virtual ZRCSDKError AllowWebinarAttendeeTalk(int32_t userID) = 0;
 
    virtual ZRCSDKError DisallowWebinarAttendeeTalk(int32_t userID) = 0;
 
    virtual ZRCSDKError AllowWebinarAttendeeViewParticipantCount() = 0;
 
    virtual ZRCSDKError DisallowWebinarAttendeeViewParticipantCount() = 0;
 
    virtual ZRCSDKError ListUnencryptedWebinarAttendees() = 0;
 
    virtual ZRCSDKError ListWebinarAttendees(const std::string& keywords) = 0;
 
    virtual ZRCSDKError GetCurrentAttendeeList(std::vector<MeetingParticipant>& attendeeList) = 0;
 
    virtual ZRCSDKError MoveAllToBackstage(bool includeSelf) = 0;
 
    virtual ZRCSDKError MoveAllToWebinar(bool includeSelf) = 0;
 
    virtual ZRCSDKError MoveToBackstage(const std::vector<int32_t>& userIDs) = 0;
 
    virtual ZRCSDKError MoveToWebinar(const std::vector<int32_t>& userIDs) = 0;
 
    virtual ZRCSDKError CanGoToWebinar(bool &canGo) = 0;
 
    virtual ZRCSDKError CanGoToBackstage(bool &canGo) = 0;
 
    virtual ZRCSDKError GoToBackstage() = 0;
  
    virtual ZRCSDKError GoToWebinar() = 0;
 
    virtual ZRCSDKError EndWebinarForAttendees() = 0;
 
    virtual ZRCSDKError SetWebinarVolume(float webinarVolume) = 0;
 
    virtual ZRCSDKError AllowPanelistMoveBetweenWebinarAndBackstage(bool allowMove) = 0;
 
    virtual ZRCSDKError NeedShowVideoPreviewBeforeGoToWebinar(bool& needShow) = 0;
 
    virtual ZRCSDKError ShowVideoPreview(bool showVideoPreview) = 0;
 
    virtual ZRCSDKError UpdateMediaStatusInVideoPreview(bool audioOn, bool videoOn) = 0;
 
    virtual ZRCSDKError CanSwitchBetweenBackstageContentAndLiveFeed(bool& canSwitch) = 0;
 
    virtual ZRCSDKError SwitchWebinarLiveFeed(bool showWebinarLiveFeed) = 0;
    
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_IMEETINGWEBINARHELPER_H