NERoom SDK V1.43.0
载入中...
搜索中...
未找到
room_service_interface.h
浏览该文件的文档.
1// Copyright (c) 2022 NetEase, Inc. All rights reserved.
2// Use of this source code is governed by a MIT license that can be
3// found in the LICENSE file.
4
11#ifndef ROOM_SERVICE_INTERFACE_H
12#define ROOM_SERVICE_INTERFACE_H
13
15#include "base_type_defines.h"
16#include "error_code_defines.h"
19
20namespace neroom {
21
26public:
51
56
57public:
61 INERoomService() = default;
62
66 virtual ~INERoomService() = default;
67
75 virtual void createRoom(const NECreateRoomParams& params, const NECreateRoomOptions& options, const NERoomCallback& callback) = 0;
76
83 virtual void fetchRoomTemplate(const std::string& roomUuid, const NERoomTemplateCallback& callback) = 0;
84
92 virtual void joinRoom(const NEJoinRoomParams& params, const NEJoinRoomOptions& options, const NEJoinRoomCallback& callback) = 0;
93
101 virtual void joinRoomByInvite(const NEJoinRoomParams& params, const NEJoinRoomOptions& options, const NEJoinRoomCallback& callback) = 0;
102
110 virtual void previewRoom(const NEPreviewRoomParams& params, const NEPreviewRoomOptions& options, const NEPreviewRoomCallback& callback) = 0;
111
117 virtual INERoomContext* getRoomContext(const std::string& roomUuid) = 0;
118
124
131 virtual void getRoomCloudRecordList(const std::string& roomArchiveId, const NEGetRecordsCallback& callback) = 0;
132
139 virtual void fetchChatroomHistoryMessages(const std::string& roomArchiveId,
141 const NERoomFetchChatRoomMessageCallback& callback) = 0;
142
148 virtual void exportChatroomHistoryMessages(const std::string& roomArchiveId, const NECallback<std::string>& callback) = 0;
149
156 virtual void rejectInvite(const std::string& roomUuid, const NECallback<std::string>& callback) = 0;
157
164 virtual void getMyInRoomDeviceList(const std::string& roomUuid, const NEInRoomDeviceListItemCallback& callback) = 0;
165
166};
167
168} // namespace neroom
169
170#endif // ROOM_SERVICE_INTERFACE_H
基础服务接口头文件
基本类型定义头文件
NECallback< std::list< NEInRoomDeviceListItem > > NEInRoomDeviceListItemCallback
获取本端所有在房的已连接设备列表回调
virtual void exportChatroomHistoryMessages(const std::string &roomArchiveId, const NECallback< std::string > &callback)=0
导出指定会议聊天室内的消息
virtual ~INERoomService()=default
析构函数
NECallback< INERoomContext * > NEJoinRoomCallback
加入房间回调
virtual void rejectInvite(const std::string &roomUuid, const NECallback< std::string > &callback)=0
挂断正在进行的呼叫,无论是正在响铃还是等待响铃都可以使用
virtual void createRoom(const NECreateRoomParams &params, const NECreateRoomOptions &options, const NERoomCallback &callback)=0
创建一个房间,不会加入房间
NECallback< INEPreviewRoomContext > NEPreviewRoomCallback
房间预览回调
virtual INERoomContext * getRoomContext(const std::string &roomUuid)=0
获取房间上下文
NECallback< std::list< SharedChatMessagePtr > > NERoomFetchChatRoomMessageCallback
检索聊天室消息回调
NECallback< std::list< NERoomRecord > > NEGetRecordsCallback
获取房间录制信息回调
virtual void getRoomCloudRecordList(const std::string &roomArchiveId, const NEGetRecordsCallback &callback)=0
获取房间录制信息
virtual void getMyInRoomDeviceList(const std::string &roomUuid, const NEInRoomDeviceListItemCallback &callback)=0
获取本端所有在房的已连接设备列表
NECallback< NERoomTemplate > NERoomTemplateCallback
房间服务获取模板回调
virtual void fetchRoomTemplate(const std::string &roomUuid, const NERoomTemplateCallback &callback)=0
获取房间模板
virtual void joinRoom(const NEJoinRoomParams &params, const NEJoinRoomOptions &options, const NEJoinRoomCallback &callback)=0
加入房间
INERoomService()=default
构造函数
virtual void previewRoom(const NEPreviewRoomParams &params, const NEPreviewRoomOptions &options, const NEPreviewRoomCallback &callback)=0
房间预览
virtual void fetchChatroomHistoryMessages(const std::string &roomArchiveId, NEHistoryMessageSearchOption option, const NERoomFetchChatRoomMessageCallback &callback)=0
会议外获取指定会议聊天室内的消息
NECallback<> NERoomCallback
房间服务回调
virtual INEPreviewRoomContext * getPreviewRoomContext()=0
获取房间预览上下文
virtual void joinRoomByInvite(const NEJoinRoomParams &params, const NEJoinRoomOptions &options, const NEJoinRoomCallback &callback)=0
加入房间通过邀请
错误码定义头文件
struct tagNECreateRoomParams { std::string roomUuid; std::string roomName; std::string password; int maxMembers{-1}; int templateId; std::map< std::string, std::string > initialProperties; } NECreateRoomParams
创建房间参数
struct tagNEJoinRoomOptions { bool enableMyAudioDeviceOnJoinRtc=false;} NEJoinRoomOptions
加入房间选项
struct tagNECreateRoomOptions { bool enableRecord=false; bool enableLive=false; bool enableRtc=true; bool enableChatroom=false; bool enableWhiteboard=false; std::map< std::string, std::string > roleBind; bool enableWaitingRoom=false; bool enableSIPInvite=false; bool enableAPPInvite=false;} NECreateRoomOptions
创建房间属性
std::function< void(int, const std::string &, const TResultParam &...)> NECallback
通用回调
struct tagNEPreviewRoomParams {} NEPreviewRoomParams
房间预览参数
struct tagNEPreviewRoomOptions {} NEPreviewRoomOptions
房间预览选项
struct tagNEJoinRoomParams { std::string roomUuid; std::string userName; std::string avatar; std::string role; std::string password; std::string session; bool kickOtherDevice; std::map< std::string, std::string > initialProperties; } NEJoinRoomParams
加入房间时参数
房间外上下文定义头文件
房间上下文定义头文件