room_context_interface.h

浏览该文件的文档.

// Copyright (c) 2022 NetEase, Inc. All rights reserved.
// Use of this source code is governed by a MIT license that can be
// found in the LICENSE file.
 
#ifndef ROOM_CONTEXT_INTERFACE_H
#define ROOM_CONTEXT_INTERFACE_H
 
#include "base_type_defines.h"
#include "room_listener.h"
#include "waiting_room_listener.h"
 
namespace neroom {
 
class INERoomChatController;
class INERoomWhiteboardController;
class INERoomRtcController;
class INERoomLiveController;
class INEWaitingRoomController;
class INERoomSIPController;
class INERoomAppInviteController;
class INERoomAnnotationController;
 
class INERoomContext {
public:
    using NERoomContextCallback = NECallback<>;
 
public:
    INERoomContext() = default;
 
    virtual ~INERoomContext() = default;
 
    virtual std::string getRoomUuid() = 0;
 
    virtual std::string getRoomName() = 0;
 
    virtual std::string getRoomArchiveID() const = 0;
 
    virtual std::string getPassword() = 0;
 
    virtual std::string getSession() = 0;
 
    virtual std::string getSipCid() = 0;
 
    virtual std::uint64_t getRtcStartTime() = 0;
 
    virtual std::uint64_t getRemainingSeconds() = 0;
 
 
    virtual std::int64_t getMaxMembers() = 0;
 
    virtual NERoomTemplate getRoomTemplate() = 0;
 
    virtual std::map<std::string, std::string> getRoomProperties() const = 0;
 
    virtual SharedMemberPtr getLocalMember() = 0;
 
    virtual std::list<SharedMemberPtr> getRemoteMembers() = 0;
 
    virtual std::list<SharedMemberPtr> getInSIPInvitingMembers() = 0;
 
    virtual std::list<SharedMemberPtr> getInAppInvitingMembers() = 0;
 
    virtual INERoomChatController* getChatController() = 0;
 
    virtual INEWaitingRoomController* getWaitingRoomController() = 0;
 
    virtual INERoomSIPController* getSIPController() = 0;
 
    virtual INERoomAppInviteController* getAppInviteController() = 0;
 
    virtual INERoomChatController* getWaitingRoomChatController() = 0;
 
    virtual INERoomRtcController* getRtcController() = 0;
 
    virtual INERoomWhiteboardController* getWhiteboardController() = 0;
 
    virtual INERoomAnnotationController* getAnnotationController() = 0;
 
    virtual INERoomLiveController* getLiveController() = 0;
 
    virtual void changeMyName(const std::string& name, const NERoomContextCallback& callback) = 0;
 
    virtual void changeMemberName(const std::string& userUuid, const std::string& name, const NERoomContextCallback& callback) = 0;
 
    virtual void changeMemberRole(const std::string& userUuid, const std::string& role, const NERoomContextCallback& callback) = 0;
 
    virtual void changeMembersRole(const std::map<std::string, std::string>& userRoleMap, const NERoomContextCallback& callback) = 0;
 
    virtual void handOverMyRole(const std::string& userUuid, const NERoomContextCallback& callback) = 0;
 
    virtual void handOverMyRole(const std::string& userUuid, bool resign, const NERoomContextCallback& callback) = 0;
 
    virtual void kickMemberOut(const std::string& userUuid, const NERoomContextCallback& callback) = 0;
 
    virtual void kickMemberOut(const std::string& userUuid, bool toBlacklist, const NERoomContextCallback& callback) = 0;
 
    virtual void addRoomListener(INERoomListener* listener) = 0;
 
    virtual void removeRoomListener(INERoomListener* listener) = 0;
 
    virtual void addRtcStatsListener(INERoomRtcStatsListener* listener) = 0;
 
    virtual void removeRtcStatsListener(INERoomRtcStatsListener* listener) = 0;
 
    virtual void rejoinAfterAdmittedToRoom(const NECallback<>& callback) = 0;
 
    virtual void leaveRoom(const NERoomContextCallback& callback) = 0;
 
    ROOMKIT_DEPRECATED("Use endRoom with force parameter instead")
    virtual void endRoom(const NERoomContextCallback& callback) = 0;
 
    virtual void endRoom(bool force, const NERoomContextCallback& callback) = 0;
 
    virtual void lockRoom(const NERoomContextCallback& callback) = 0;
 
    virtual void unlockRoom(const NERoomContextCallback& callback) = 0;
 
    virtual bool isRoomLocked() = 0;
 
    virtual void updateRoomProperty(const std::string& key,
        const std::string& value,
        const std::string& associatedUserUuid = "",
        const NERoomContextCallback& callback = NERoomContextCallback()) = 0;
 
    virtual void deleteRoomProperty(const std::string& key, const NERoomContextCallback& callback) = 0;
 
    virtual void updateMemberProperty(const std::string& userUuid,
        const std::string& key,
        const std::string& value,
        const NERoomContextCallback& callback) = 0;
 
    virtual void deleteMemberProperty(const std::string& userUuid, const std::string& key, const NERoomContextCallback& callback) = 0;
 
    virtual void startCloudRecord(const NEEmptyCallback& callback) const = 0;
    
    virtual void startCloudRecord(const NERoomRecordConfig& recordConfig, const NEEmptyCallback& callback) const = 0;
 
    virtual void stopCloudRecord(const NEEmptyCallback& callback) const = 0;
 
    virtual bool isCloudRecording() const = 0;
 
    virtual bool isInWaitingRoom() const = 0;
 
    virtual bool isRoomBlacklistEnabled() const = 0;
 
    virtual void enableRoomBlacklist(bool enable, const NEEmptyCallback& callback) = 0;
};
 
}  // namespace neroom
 
#endif  // ROOM_CONTEXT_INTERFACE_H