meeting_video_interface.h

Go to the documentation of this file.

 
#ifndef _MEETING_VIDEO_INTERFACE_H_
#define _MEETING_VIDEO_INTERFACE_H_
#include "zoom_sdk_def.h"
#include "zoom_sdk_util_define.h"
BEGIN_ZOOM_SDK_NAMESPACE
 
enum VideoStatus
{
    Video_ON, 
    Video_OFF, 
    Video_Mute_ByHost, 
};
enum VideoConnectionQuality
{
    VideoConnectionQuality_Unknown = 0, //Unknown video quality status.
    VideoConnectionQuality_Bad,  //The video quality is poor.
    VideoConnectionQuality_Normal, //The video quality is normal.
    VideoConnectionQuality_Good, //The video quality is good.
};
 
class ISetVideoOrderHelper
{
public:
    virtual SDKError SetVideoOrderTransactionBegin() = 0;
 
    virtual bool AddVideoToOrder(unsigned int userId, unsigned int position) = 0;
 
    virtual SDKError SetVideoOrderTransactionCommit() = 0;
};
 
class IRequestStartVideoHandler
{
public:
    virtual ~IRequestStartVideoHandler(){};
    virtual unsigned int GetReqFromUserId() = 0;
    virtual SDKError Ignore() = 0;
    virtual SDKError Accept() = 0;
    
    virtual SDKError Cancel() = 0;
};
 
class IMeetingVideoCtrlEvent
{
public:
    virtual ~IMeetingVideoCtrlEvent() {}
 
    virtual void onUserVideoStatusChange(unsigned int userId, VideoStatus status) = 0;
 
    virtual void onSpotlightedUserListChangeNotification(IList<unsigned int >* lstSpotlightedUserID) = 0;
 
    virtual void onHostRequestStartVideo(IRequestStartVideoHandler* handler_) = 0;
 
    virtual void onActiveSpeakerVideoUserChanged(unsigned int userid) = 0;
 
    virtual void onActiveVideoUserChanged(unsigned int userid) = 0;
 
    virtual void onHostVideoOrderUpdated(IList<unsigned int >* orderList) = 0;
 
    virtual void onLocalVideoOrderUpdated(IList<unsigned int >* localOrderList) = 0;
 
    virtual void onFollowHostVideoOrderChanged(bool bFollow) = 0;
 
    virtual void onUserVideoQualityChanged(VideoConnectionQuality quality, unsigned int userid) = 0;
 
};
 
enum PinResult
{
    PinResult_Success = 0,
    PinResult_Fail_NotEnoughUsers,  
    PinResult_Fail_ToMuchPinnedUsers, 
    PinResult_Fail_UserCannotBePinned, 
    PinResult_Fail_VideoModeDoNotSupport, 
    PinResult_Fail_NoPrivilegeToPin,  
    PinResult_Fail_MeetingDoNotSupport, 
    PinResult_Unknown = 100,
};
 
enum SpotlightResult
{
    SpotResult_Success = 0,
    SpotResult_Fail_NotEnoughUsers,  
    SpotResult_Fail_ToMuchSpotlightedUsers, 
    SpotResult_Fail_UserCannotBeSpotlighted, 
    SpotResult_Fail_UserWithoutVideo, 
    SpotResult_Fail_NoPrivilegeToSpotlight,  
    SpotResult_Fail_UserNotSpotlighted, 
    SpotResult_Unknown = 100,
};
class IMeetingVideoController
{
public:
    virtual SDKError SetEvent(IMeetingVideoCtrlEvent* pEvent) = 0;
    
    virtual SDKError MuteVideo() = 0;
 
    virtual SDKError UnmuteVideo() = 0;
 
    virtual SDKError CanPinToFirstView(unsigned int userid, PinResult& result) = 0;
 
    virtual SDKError PinVideoToFirstView(unsigned int userid) = 0;
 
    virtual SDKError UnPinVideoFromFirstView(unsigned int userid) = 0;
 
    virtual SDKError UnPinAllVideosFromFirstView() = 0;
 
    virtual IList<unsigned int >* GetPinnedUserListFromFirstView() = 0;
 
    virtual SDKError CanPinToSecondView(unsigned int userid, PinResult& result) = 0;
 
    virtual SDKError PinVideoToSecondView(unsigned int userid) = 0;
 
    virtual SDKError UnPinVideoFromSecondView(unsigned int userid) = 0;
 
    virtual IList<unsigned int >* GetPinnedUserListFromSecondView() = 0;
 
    virtual SDKError CanSpotlight(unsigned int userid, SpotlightResult& result) = 0;
    
    virtual SDKError CanUnSpotlight(unsigned int userid, SpotlightResult& result) = 0;
 
    virtual SDKError SpotlightVideo(unsigned int userid) = 0;
 
    virtual SDKError UnSpotlightVideo(unsigned int userid) = 0;
 
    virtual SDKError UnSpotlightAllVideos() = 0;
 
    virtual IList<unsigned int >* GetSpotlightedUserList() = 0;
 
    virtual SDKError HideOrShowNoVideoUserOnVideoWall(bool bHide) = 0;
 
    virtual SDKError CanAskAttendeeToStartVideo(unsigned int userid) = 0;
 
    virtual SDKError AskAttendeeToStartVideo(unsigned int userid) = 0;
 
    virtual SDKError CanStopAttendeeVideo(unsigned int userid) = 0;
 
    virtual SDKError StopAttendeeVideo(unsigned int userid) = 0;
 
    virtual bool IsSupportFollowHostVideoOrder() = 0;
 
    virtual SDKError EnableFollowHostVideoOrder(bool bEnable) = 0;
 
    virtual bool IsFollowHostVideoOrderOn() = 0;
 
    virtual IList<unsigned int >* GetVideoOrderList() = 0;
 
    virtual ISetVideoOrderHelper* GetSetVideoOrderHelper() = 0;
 
    virtual ICameraController* GetMyCameraController() = 0;
};
END_ZOOM_SDK_NAMESPACE
#endif