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"

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;

class IUserInfo
{
public:
    virtual const wchar_t* GetUserName() = 0;

    virtual bool IsHost() = 0;

    virtual unsigned int GetUserID() = 0;

    virtual const wchar_t* GetParticipantID() = 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 IsClosedCaptionSender() = 0;

    virtual bool IsTalking() = 0;
    
    virtual bool IsH323User() = 0;

    virtual WebinarAttendeeStatus* GetWebinarAttendeeStauts() = 0;
    
    virtual bool IsInterpreter() = 0;

    virtual const wchar_t* GetInterpreterActiveLanguage() = 0;

    virtual ~IUserInfo(){};
};

class IMeetingParticipantsCtrlEvent
{
public:
    virtual void onUserJoin(IList<unsigned int >* lstUserID, const wchar_t* strUserList = NULL) = 0;

    virtual void onUserLeft(IList<unsigned int >* lstUserID, const wchar_t* strUserList = NULL) = 0;

    virtual void onHostChangeNotification(unsigned int userId) = 0;

    virtual void onLowOrRaiseHandStatusChanged(bool bLow, unsigned int userid) = 0;

    virtual void onUserNameChanged(unsigned int userId, const wchar_t* userName) = 0;

    virtual void onCoHostChangeNotification(unsigned int userId, bool isCoHost) = 0;
};

class IMeetingParticipantsController
{
public:
    virtual SDKError SetEvent(IMeetingParticipantsCtrlEvent* pEvent) = 0;

    virtual IList<unsigned int >* GetParticipantsList() = 0;

    virtual IUserInfo* GetUserByUserID(unsigned int userid) = 0;

    virtual SDKError LowerAllHands() = 0;

    virtual SDKError ChangeUserName(const unsigned int userid, const wchar_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 SDKError ReclaimHost() = 0;

    virtual SDKError CanReclaimHost(bool& bCanReclaimHost) = 0;

    virtual SDKError ReclaimHostByHostKey(const wchar_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;
};
END_ZOOM_SDK_NAMESPACE
#endif