netender-web-sdk 0.0.1 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -14
- package/dist/index.cjs.js +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.umd.js +1 -1
- package/dist/meeting-kit-lite/src/config.d.ts +29 -0
- package/dist/meeting-kit-lite/src/kit/impl/account_manager.d.ts +45 -0
- package/dist/meeting-kit-lite/src/kit/impl/annotation_manager.d.ts +22 -0
- package/dist/meeting-kit-lite/src/kit/impl/audio_manager.d.ts +44 -0
- package/dist/meeting-kit-lite/src/kit/impl/breakout_manager.d.ts +22 -0
- package/dist/meeting-kit-lite/src/kit/impl/chatroom_manager.d.ts +25 -0
- package/dist/meeting-kit-lite/src/kit/impl/interpretation_manager.d.ts +26 -0
- package/dist/meeting-kit-lite/src/kit/impl/invite_manager.d.ts +28 -0
- package/dist/meeting-kit-lite/src/kit/impl/meeting_kit.d.ts +138 -0
- package/dist/meeting-kit-lite/src/kit/impl/meeting_manager.d.ts +61 -0
- package/dist/meeting-kit-lite/src/kit/impl/member_manager.d.ts +41 -0
- package/dist/meeting-kit-lite/src/kit/impl/notification_manager.d.ts +22 -0
- package/dist/meeting-kit-lite/src/kit/impl/plugin_manager.d.ts +19 -0
- package/dist/meeting-kit-lite/src/kit/impl/pre_meeting_manager.d.ts +35 -0
- package/dist/meeting-kit-lite/src/kit/impl/quality_monitor_manager.d.ts +23 -0
- package/dist/meeting-kit-lite/src/kit/impl/record_manager.d.ts +18 -0
- package/dist/meeting-kit-lite/src/kit/impl/screen_share_manager.d.ts +18 -0
- package/dist/meeting-kit-lite/src/kit/impl/security_manager.d.ts +108 -0
- package/dist/meeting-kit-lite/src/kit/impl/transcription_manager.d.ts +21 -0
- package/dist/meeting-kit-lite/src/kit/impl/video_manager.d.ts +37 -0
- package/dist/meeting-kit-lite/src/kit/impl/waitingRoom_manager.d.ts +29 -0
- package/dist/meeting-kit-lite/src/kit/impl/whiteboard_manager.d.ts +23 -0
- package/dist/meeting-kit-lite/src/kit/index.d.ts +26 -0
- package/dist/meeting-kit-lite/src/kit/interface/account_manager.d.ts +56 -0
- package/dist/meeting-kit-lite/src/kit/interface/annotation_manager.d.ts +57 -0
- package/dist/meeting-kit-lite/src/kit/interface/audio_manager.d.ts +171 -0
- package/dist/meeting-kit-lite/src/kit/interface/breakout_manager.d.ts +64 -0
- package/dist/meeting-kit-lite/src/kit/interface/chatroom_manager.d.ts +190 -0
- package/dist/meeting-kit-lite/src/kit/interface/interpretation_manager.d.ts +61 -0
- package/dist/meeting-kit-lite/src/kit/interface/invite_manager.d.ts +77 -0
- package/dist/meeting-kit-lite/src/kit/interface/meeting_kit.d.ts +143 -0
- package/dist/meeting-kit-lite/src/kit/interface/meeting_manager.d.ts +91 -0
- package/dist/meeting-kit-lite/src/kit/interface/member_manager.d.ts +125 -0
- package/dist/meeting-kit-lite/src/kit/interface/notification_manager.d.ts +60 -0
- package/dist/meeting-kit-lite/src/kit/interface/plugin_manager.d.ts +43 -0
- package/dist/meeting-kit-lite/src/kit/interface/pre_meeting_manager.d.ts +67 -0
- package/dist/meeting-kit-lite/src/kit/interface/quality_monitor_manager.d.ts +70 -0
- package/dist/meeting-kit-lite/src/kit/interface/record_manager.d.ts +41 -0
- package/dist/meeting-kit-lite/src/kit/interface/screen_share_manager.d.ts +35 -0
- package/dist/meeting-kit-lite/src/kit/interface/security_manager.d.ts +84 -0
- package/dist/meeting-kit-lite/src/kit/interface/transcription_manager.d.ts +35 -0
- package/dist/meeting-kit-lite/src/kit/interface/video_manager.d.ts +121 -0
- package/dist/meeting-kit-lite/src/kit/interface/waitingRoom_manager.d.ts +58 -0
- package/dist/meeting-kit-lite/src/kit/interface/whiteboard_manager.d.ts +85 -0
- package/dist/meeting-kit-lite/src/types/index.d.ts +2 -0
- package/dist/meeting-kit-lite/src/types/innerType.d.ts +1919 -0
- package/dist/meeting-kit-lite/src/types/type.d.ts +1201 -0
- package/dist/meeting-kit-lite/src/utils/common.d.ts +11 -0
- package/dist/meeting-kit-lite/src/utils/highAvailableRequest.d.ts +10 -0
- package/dist/meeting-kit-lite/src/utils/index.d.ts +10 -0
- package/dist/meeting-kit-lite/src/utils/logDebug.d.ts +56 -0
- package/dist/meeting-kit-lite/src/utils/report.d.ts +8 -0
- package/dist/meeting-kit-lite/src/utils/throwError.d.ts +6 -0
- package/dist/{index.d.ts → tender-sdk-web/src/index.d.ts} +0 -1
- package/package.json +11 -10
- package/dist/index.d.ts.map +0 -1
|
@@ -0,0 +1,1201 @@
|
|
|
1
|
+
import { NEIMServerConfig, NEResult, NERoomWhiteboardAppConfig, NERtcServerConfig, NEWhiteboardServerConfig } from 'neroom-types';
|
|
2
|
+
import { AspectRatio, AttendeeOffType, GuestMeetingInfo, NEAccountInfo, NEChatroomInfo, NECloudRecordStrategyType, NEEncryptionConfig, NEMeetingAppNoticeTip, NEProps, Role, VideoFrameRate, VideoResolution, WatermarkInfo } from './innerType';
|
|
3
|
+
import { IntervalEvent } from '../utils/report';
|
|
4
|
+
import { AddDocConfig } from '../kit';
|
|
5
|
+
export declare enum MeetingRepeatCustomStepUnit {
|
|
6
|
+
Day = 1,
|
|
7
|
+
Week = 2,
|
|
8
|
+
MonthOfDay = 3,
|
|
9
|
+
MonthOfWeek = 4
|
|
10
|
+
}
|
|
11
|
+
export interface AccountInfo {
|
|
12
|
+
nickname: string;
|
|
13
|
+
shortMeetingNum: string;
|
|
14
|
+
meetingNum: string;
|
|
15
|
+
avatar: string;
|
|
16
|
+
serviceBundle: {
|
|
17
|
+
name: string;
|
|
18
|
+
meetingMaxMinutes: number;
|
|
19
|
+
meetingMaxMembers: number;
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
export interface NEMeetingScheduledMember {
|
|
23
|
+
userUuid: string;
|
|
24
|
+
role: Role;
|
|
25
|
+
name?: string;
|
|
26
|
+
}
|
|
27
|
+
export interface NEMeetingInfo {
|
|
28
|
+
localMember?: {
|
|
29
|
+
userUuid: string;
|
|
30
|
+
name: string;
|
|
31
|
+
role: Role;
|
|
32
|
+
};
|
|
33
|
+
/** 会议id */
|
|
34
|
+
meetingId: number;
|
|
35
|
+
/** 会议号 */
|
|
36
|
+
meetingNum: string;
|
|
37
|
+
/** 房间uuid */
|
|
38
|
+
roomUuid: string;
|
|
39
|
+
/** 会议状态 */
|
|
40
|
+
state: number;
|
|
41
|
+
/** 会议开始时间 */
|
|
42
|
+
startTime: number;
|
|
43
|
+
/** 会议结束时间 */
|
|
44
|
+
endTime: number;
|
|
45
|
+
/** 会议主题 */
|
|
46
|
+
subject: string;
|
|
47
|
+
/** 会议邀请链接 */
|
|
48
|
+
meetingInviteUrl: string;
|
|
49
|
+
/** 会议 code */
|
|
50
|
+
meetingCode: string;
|
|
51
|
+
/** 会议类型 */
|
|
52
|
+
type: number;
|
|
53
|
+
/** 会议短号 */
|
|
54
|
+
shortMeetingNum?: string;
|
|
55
|
+
/** @ignore 跨应用加入房间使用的userUuid */
|
|
56
|
+
meetingUserUuid?: string;
|
|
57
|
+
/** @ignore 跨应用加入房间使用的userToken */
|
|
58
|
+
meetingUserToken?: string;
|
|
59
|
+
/** @ignore 跨应用加入房间使用的appKey */
|
|
60
|
+
meetingAppKey?: string;
|
|
61
|
+
/** @ignore 跨应用加入房间使用的鉴权类型 */
|
|
62
|
+
meetingAuthType?: string;
|
|
63
|
+
/** @ignore 不对外暴露 */
|
|
64
|
+
roomArchiveId: string;
|
|
65
|
+
/** 房间拥有者 uuid */
|
|
66
|
+
ownerUserUuid: string;
|
|
67
|
+
/** 房间拥有者 用户名 */
|
|
68
|
+
ownerNickname: string;
|
|
69
|
+
/** 预约指定角色的成员 */
|
|
70
|
+
scheduledMembers?: NEMeetingScheduledMember[];
|
|
71
|
+
/** 时区 */
|
|
72
|
+
timezoneId?: string;
|
|
73
|
+
/** @ignore 不对外暴露 */
|
|
74
|
+
settings: {
|
|
75
|
+
roomInfo: {
|
|
76
|
+
roomConfigId: number;
|
|
77
|
+
openWaitingRoom: boolean;
|
|
78
|
+
enableJoinBeforeHost: boolean;
|
|
79
|
+
roleBinds: Record<string, Role>;
|
|
80
|
+
roomConfig: {
|
|
81
|
+
resource: {
|
|
82
|
+
chatroom: boolean;
|
|
83
|
+
live: boolean;
|
|
84
|
+
record: boolean;
|
|
85
|
+
rtc: boolean;
|
|
86
|
+
sip: boolean;
|
|
87
|
+
whiteboard: boolean;
|
|
88
|
+
waitingRoom: boolean;
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
password?: string;
|
|
92
|
+
roomProperties?: Record<string, NEProps>;
|
|
93
|
+
viewOrder?: string;
|
|
94
|
+
};
|
|
95
|
+
recordConfig?: {
|
|
96
|
+
recordStrategy: number;
|
|
97
|
+
enableSmartRecording?: boolean;
|
|
98
|
+
enableTranscript?: boolean;
|
|
99
|
+
};
|
|
100
|
+
liveConfig?: {
|
|
101
|
+
liveAddress: string;
|
|
102
|
+
};
|
|
103
|
+
livePrivateConfig?: {
|
|
104
|
+
title: string;
|
|
105
|
+
password?: string;
|
|
106
|
+
pushThirdParties: NEmeetingItemLivePushThirdPart[];
|
|
107
|
+
background?: NEMeetingItemLiveBackground;
|
|
108
|
+
enableThirdParties?: boolean;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
/** 周期性会议 */
|
|
112
|
+
recurringRule?: {
|
|
113
|
+
type: MeetingRepeatType;
|
|
114
|
+
customizedFrequency?: {
|
|
115
|
+
stepSize: number;
|
|
116
|
+
stepUnit: MeetingRepeatCustomStepUnit;
|
|
117
|
+
daysOfWeek: number[];
|
|
118
|
+
daysOfMonth: number[];
|
|
119
|
+
};
|
|
120
|
+
endRule: {
|
|
121
|
+
type: number;
|
|
122
|
+
date?: string;
|
|
123
|
+
times?: number;
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
inviteUrl?: string;
|
|
127
|
+
/** 与会者视频关闭 */
|
|
128
|
+
attendeeVideoOff?: boolean;
|
|
129
|
+
/** 与会者音频关闭 */
|
|
130
|
+
attendeeAudioOff?: boolean;
|
|
131
|
+
/** 与会者音频关闭模式 */
|
|
132
|
+
attendeeAudioOffType?: AttendeeOffType;
|
|
133
|
+
/** 会议密码 */
|
|
134
|
+
password?: string;
|
|
135
|
+
/** 是否开启云录制 */
|
|
136
|
+
noCloudRecord?: boolean;
|
|
137
|
+
/** 是否开启聊天室 */
|
|
138
|
+
noChat?: boolean;
|
|
139
|
+
/** 是否开启直播 */
|
|
140
|
+
openLive?: boolean;
|
|
141
|
+
/** 直播是否本企业可用 */
|
|
142
|
+
liveOnlyEmployees?: boolean;
|
|
143
|
+
/** 是否开启SIP功能 */
|
|
144
|
+
noSip: boolean;
|
|
145
|
+
/** 配置会议是否默认开启等候室 */
|
|
146
|
+
enableWaitingRoom: boolean;
|
|
147
|
+
/** 配置会议是否允许参会者在主持人进入会议前加入会议,默认为允许 */
|
|
148
|
+
enableJoinBeforeHost: boolean;
|
|
149
|
+
/** 是否允许访客入会 */
|
|
150
|
+
enableGuestJoin: boolean;
|
|
151
|
+
/** 会议扩展字段,可空,最大长度为 2K。 */
|
|
152
|
+
extraData?: string;
|
|
153
|
+
/** 会议主持人角色绑定 */
|
|
154
|
+
roleBinds?: Record<string, string>;
|
|
155
|
+
/** 同声传译 */
|
|
156
|
+
interpretation?: {
|
|
157
|
+
interpreters?: {
|
|
158
|
+
[key: string]: string[];
|
|
159
|
+
};
|
|
160
|
+
started: boolean;
|
|
161
|
+
};
|
|
162
|
+
/** 云录制 */
|
|
163
|
+
cloudRecordConfig?: NECloudRecordConfig;
|
|
164
|
+
/** 访客跨应用入会类型 0 不允许访客入会 1 实名访客入会 2 匿名访客入会*/
|
|
165
|
+
guestJoinType?: '0' | '1' | '2';
|
|
166
|
+
/** 是否是分组讨论 */
|
|
167
|
+
isBreakoutRoom?: boolean;
|
|
168
|
+
/** 是否返回主会议 */
|
|
169
|
+
backToMainRoom?: boolean;
|
|
170
|
+
/** 会议类型 0 默认,普通会议;1 个人录音,秒录 */
|
|
171
|
+
subType?: number;
|
|
172
|
+
}
|
|
173
|
+
export type NEMeetingRecurringRule = NEMeetingInfo['recurringRule'];
|
|
174
|
+
/**
|
|
175
|
+
* 云录制配置
|
|
176
|
+
*/
|
|
177
|
+
export type NECloudRecordConfig = {
|
|
178
|
+
/** 是否开启云录制 */
|
|
179
|
+
enable?: boolean;
|
|
180
|
+
/** 云录制策略 */
|
|
181
|
+
recordStrategy?: NECloudRecordStrategyType;
|
|
182
|
+
/** 是否开启本地录制昵称 */
|
|
183
|
+
localRecordNickName?: boolean;
|
|
184
|
+
/** 是否开启本地录制时间戳 */
|
|
185
|
+
localRecordTimestamp?: boolean;
|
|
186
|
+
/** 是否开启本地录制屏幕共享和视频 */
|
|
187
|
+
localRecordScreenShareAndVideo?: boolean;
|
|
188
|
+
/** 是否开启本地录制屏幕共享侧边视频 */
|
|
189
|
+
localRecordScreenShareSideBySideVideo?: boolean;
|
|
190
|
+
/** 本地录制默认路径 */
|
|
191
|
+
localRecordDefaultPath?: string;
|
|
192
|
+
/** 是否开启云录制AI总结 */
|
|
193
|
+
enableAISummary?: boolean;
|
|
194
|
+
/** 是否开启云录制转写 */
|
|
195
|
+
enableTranscript?: boolean;
|
|
196
|
+
/** 录制模式列表 */
|
|
197
|
+
modeList?: {
|
|
198
|
+
mode: number;
|
|
199
|
+
}[];
|
|
200
|
+
/** 是否开启云录制昵称 */
|
|
201
|
+
userNameDisplay?: {
|
|
202
|
+
enable: boolean;
|
|
203
|
+
};
|
|
204
|
+
};
|
|
205
|
+
export interface NEMeetingCreateOptions extends NEMeetingBaseOptions {
|
|
206
|
+
/** 房间配置模板ID */
|
|
207
|
+
roomConfigId?: number;
|
|
208
|
+
/** 视频开启状态,0-关闭,1-开启 */
|
|
209
|
+
video?: number;
|
|
210
|
+
/** 音频开启状态,0-关闭,1-开启 */
|
|
211
|
+
audio?: number;
|
|
212
|
+
/** 会议主题 */
|
|
213
|
+
subject?: string;
|
|
214
|
+
/** 角色绑定配置 */
|
|
215
|
+
roleBinds?: Record<string, string>;
|
|
216
|
+
/** 是否禁用SIP功能 */
|
|
217
|
+
noSip?: boolean;
|
|
218
|
+
/** 是否禁用聊天功能 */
|
|
219
|
+
noChat?: boolean;
|
|
220
|
+
/** 是否禁用白板功能 */
|
|
221
|
+
noWhiteboard?: boolean;
|
|
222
|
+
/** 是否开启直播 */
|
|
223
|
+
openLive?: boolean;
|
|
224
|
+
/** 直播是否仅限企业内部成员观看 */
|
|
225
|
+
liveOnlyEmployees?: boolean;
|
|
226
|
+
/** 是否开启直播聊天室 */
|
|
227
|
+
liveChatRoomEnable?: boolean;
|
|
228
|
+
/** 是否禁用云录制 */
|
|
229
|
+
noCloudRecord?: boolean;
|
|
230
|
+
/** 扩展数据 */
|
|
231
|
+
extraData?: string;
|
|
232
|
+
/** 参会者入会时是否关闭视频 */
|
|
233
|
+
attendeeVideoOff?: boolean;
|
|
234
|
+
/** 参会者入会时是否关闭音频 */
|
|
235
|
+
attendeeAudioOff?: boolean;
|
|
236
|
+
/** 参会者音频关闭类型 */
|
|
237
|
+
attendeeAudioOffType?: AttendeeOffType;
|
|
238
|
+
/** 会议开始时间戳 */
|
|
239
|
+
startTime?: number;
|
|
240
|
+
/** 会议子类型,0 默认普通会议,1 个人录音秒录 */
|
|
241
|
+
subType?: number;
|
|
242
|
+
/** 会议结束时间戳 */
|
|
243
|
+
endTime?: number;
|
|
244
|
+
/** 创建会议事件上报 */
|
|
245
|
+
createMeetingReport?: IntervalEvent;
|
|
246
|
+
/** 是否开启等候室 */
|
|
247
|
+
enableWaitingRoom?: boolean;
|
|
248
|
+
/** 是否允许访客加入会议 */
|
|
249
|
+
enableGuestJoin?: boolean;
|
|
250
|
+
/** 是否允许成员在主持人进入前加入会议 */
|
|
251
|
+
enableJoinBeforeHost?: boolean;
|
|
252
|
+
/** 周期性会议规则配置 */
|
|
253
|
+
recurringRule?: Record<string, NEMeetingRecurringRule>;
|
|
254
|
+
/** 预定会议成员列表 */
|
|
255
|
+
scheduledMembers?: NEScheduledMember[];
|
|
256
|
+
/** 时区ID */
|
|
257
|
+
timezoneId?: string;
|
|
258
|
+
/** 同声传译配置 */
|
|
259
|
+
interpretation?: {
|
|
260
|
+
/** 译员配置,key为语言对,value为译员用户ID数组 */
|
|
261
|
+
interpreters?: {
|
|
262
|
+
[key: string]: string[];
|
|
263
|
+
};
|
|
264
|
+
/** 同传是否已开始 */
|
|
265
|
+
started: boolean;
|
|
266
|
+
};
|
|
267
|
+
/** 云录制配置 */
|
|
268
|
+
cloudRecordConfig?: NECloudRecordConfig;
|
|
269
|
+
/** 直播私有化配置 */
|
|
270
|
+
liveConfig?: NEMeetingLivePrivateConfig;
|
|
271
|
+
/** 白板配置 */
|
|
272
|
+
whiteBoardAddDocConfig?: AddDocConfig[];
|
|
273
|
+
/**
|
|
274
|
+
* 是否开启白板的云录制
|
|
275
|
+
*/
|
|
276
|
+
whiteboardCloudRecord?: boolean;
|
|
277
|
+
/**
|
|
278
|
+
* 是否开启白板容器的宽高比
|
|
279
|
+
*/
|
|
280
|
+
whiteBoardContainerAspectRatio?: AspectRatio;
|
|
281
|
+
/** 是否默认使用电脑音频 */
|
|
282
|
+
usingComputerAudio?: boolean;
|
|
283
|
+
}
|
|
284
|
+
export type NEMeetingItemLiveBackground = {
|
|
285
|
+
backgroundUrl?: string;
|
|
286
|
+
backgroundFile?: Blob | string;
|
|
287
|
+
notStartCoverUrl?: string;
|
|
288
|
+
thumbnailBackUrl?: string;
|
|
289
|
+
thumbnailBackFile?: Blob | string;
|
|
290
|
+
notStartThumbnailUrl?: string;
|
|
291
|
+
};
|
|
292
|
+
interface NEMeetingLivePrivateConfig {
|
|
293
|
+
title: string;
|
|
294
|
+
background?: NEMeetingItemLiveBackground;
|
|
295
|
+
pushThirdParties?: NEmeetingItemLivePushThirdPart[];
|
|
296
|
+
enableThirdParties?: boolean;
|
|
297
|
+
password?: string;
|
|
298
|
+
}
|
|
299
|
+
interface NEMeetingBaseOptions {
|
|
300
|
+
/** 会议ID(数字类型,已废弃,建议使用meetingNum) */
|
|
301
|
+
meetingId?: number;
|
|
302
|
+
/** 会议号(字符串类型),原先使用meetingId后续兼容meetingNum */
|
|
303
|
+
meetingNum: string;
|
|
304
|
+
/** 用户昵称 */
|
|
305
|
+
nickname: string;
|
|
306
|
+
/** 会议密码 */
|
|
307
|
+
password?: string;
|
|
308
|
+
/** 成员标签 */
|
|
309
|
+
memberTag?: string;
|
|
310
|
+
/** 是否禁用聊天功能 */
|
|
311
|
+
noChat?: boolean;
|
|
312
|
+
/** 是否禁用白板功能 */
|
|
313
|
+
noWhiteboard?: boolean;
|
|
314
|
+
/** 是否禁用字幕功能 */
|
|
315
|
+
noCaptions?: boolean;
|
|
316
|
+
/** 组织名称 */
|
|
317
|
+
orgName?: string;
|
|
318
|
+
/** 用户头像URL */
|
|
319
|
+
avatar?: string;
|
|
320
|
+
/**
|
|
321
|
+
* 视频分辨率及帧率设置
|
|
322
|
+
*/
|
|
323
|
+
videoProfile?: {
|
|
324
|
+
resolution: VideoResolution;
|
|
325
|
+
frameRate: VideoFrameRate;
|
|
326
|
+
};
|
|
327
|
+
/** 加密配置 */
|
|
328
|
+
encryptionConfig?: NEEncryptionConfig;
|
|
329
|
+
/** 加入会议超时时间(毫秒) */
|
|
330
|
+
joinTimeout?: number;
|
|
331
|
+
/** 会话标识 */
|
|
332
|
+
session?: string;
|
|
333
|
+
/** 会议子类型,0 默认普通会议,1 个人录音秒录 */
|
|
334
|
+
subType?: number;
|
|
335
|
+
}
|
|
336
|
+
export interface NEMeetingJoinOptions extends NEMeetingBaseOptions {
|
|
337
|
+
role?: Role;
|
|
338
|
+
joinMeetingReport?: IntervalEvent;
|
|
339
|
+
/** 白板配置 */
|
|
340
|
+
whiteBoardAddDocConfig?: AddDocConfig[];
|
|
341
|
+
/** 是否是分会场 */
|
|
342
|
+
breakoutRoom?: boolean;
|
|
343
|
+
/** 是否返回主会议 */
|
|
344
|
+
backToMainRoom?: boolean;
|
|
345
|
+
/**
|
|
346
|
+
* 是否开启白板的云录制
|
|
347
|
+
*/
|
|
348
|
+
whiteboardCloudRecord?: boolean;
|
|
349
|
+
/**
|
|
350
|
+
* 是否开启白板容器的宽高比
|
|
351
|
+
*/
|
|
352
|
+
whiteBoardContainerAspectRatio?: AspectRatio;
|
|
353
|
+
/** 是否默认使用电脑音频 */
|
|
354
|
+
usingComputerAudio?: boolean;
|
|
355
|
+
}
|
|
356
|
+
export interface NEMeetingLoginByPasswordOptions {
|
|
357
|
+
loginType: 0;
|
|
358
|
+
username: string;
|
|
359
|
+
password: string;
|
|
360
|
+
loginReport?: IntervalEvent;
|
|
361
|
+
}
|
|
362
|
+
export interface NEMeetingLoginByTokenOptions {
|
|
363
|
+
loginType: 1;
|
|
364
|
+
accountId: string;
|
|
365
|
+
accountToken: string;
|
|
366
|
+
authType?: string;
|
|
367
|
+
isTemporary?: boolean;
|
|
368
|
+
loginReport?: IntervalEvent;
|
|
369
|
+
}
|
|
370
|
+
export type NEServerConfig = {
|
|
371
|
+
roomKitServerConfig?: {
|
|
372
|
+
roomServer: string;
|
|
373
|
+
lbsServer?: string;
|
|
374
|
+
};
|
|
375
|
+
imServerConfig?: NEIMServerConfig;
|
|
376
|
+
rtcServerConfig?: NERtcServerConfig;
|
|
377
|
+
whiteboardServerConfig?: NEWhiteboardServerConfig;
|
|
378
|
+
};
|
|
379
|
+
/**
|
|
380
|
+
* 初始化相关配置
|
|
381
|
+
*/
|
|
382
|
+
export type NEMeetingInitConfig = {
|
|
383
|
+
/**
|
|
384
|
+
* 是否开启日志打印(默认为true)
|
|
385
|
+
*/
|
|
386
|
+
debug?: boolean;
|
|
387
|
+
/**
|
|
388
|
+
* 国际化语言
|
|
389
|
+
*/
|
|
390
|
+
locale?: string;
|
|
391
|
+
/**
|
|
392
|
+
* 是否开启日志上(报默认为true)
|
|
393
|
+
*/
|
|
394
|
+
eventTracking?: boolean;
|
|
395
|
+
/**
|
|
396
|
+
* 会议appKey
|
|
397
|
+
*/
|
|
398
|
+
appKey: string;
|
|
399
|
+
/**
|
|
400
|
+
* 会议服务器地址,支持私有化配置
|
|
401
|
+
*/
|
|
402
|
+
meetingServerDomain?: string;
|
|
403
|
+
/**
|
|
404
|
+
* IM私有化配置仅限于私有化配置时使用
|
|
405
|
+
*/
|
|
406
|
+
imPrivateConf?: NEIMServerConfig;
|
|
407
|
+
/**
|
|
408
|
+
* G2 私有化配置仅私有化配置使用
|
|
409
|
+
*/
|
|
410
|
+
neRtcServerAddresses?: NERtcServerConfig;
|
|
411
|
+
/**
|
|
412
|
+
* 白板私有化配置使用
|
|
413
|
+
*/
|
|
414
|
+
whiteboardConfig?: NEWhiteboardServerConfig;
|
|
415
|
+
/**
|
|
416
|
+
* @ignore
|
|
417
|
+
*/
|
|
418
|
+
globalEventListener?: Record<string, NEProps>;
|
|
419
|
+
/**
|
|
420
|
+
* @ignore
|
|
421
|
+
*/
|
|
422
|
+
im?: unknown;
|
|
423
|
+
/**
|
|
424
|
+
* 私有化配置使用,如果配置该字段则会从服务端对应接口拉取配置文件。但是优先级低于其他私有化配置字段,如果配置过其他字段则该配置不生效
|
|
425
|
+
*/
|
|
426
|
+
serverUrl?: string;
|
|
427
|
+
/**
|
|
428
|
+
* 扩展字段
|
|
429
|
+
*/
|
|
430
|
+
extras?: Record<string, NEProps>;
|
|
431
|
+
/**
|
|
432
|
+
* 是否读取私有化配置文件
|
|
433
|
+
*/
|
|
434
|
+
useAssetServerConfig?: boolean;
|
|
435
|
+
/**
|
|
436
|
+
* 白板防盗链配置
|
|
437
|
+
*/
|
|
438
|
+
whiteboardAppConfig?: NERoomWhiteboardAppConfig;
|
|
439
|
+
serverConfig?: NEServerConfig;
|
|
440
|
+
logPath?: string;
|
|
441
|
+
};
|
|
442
|
+
export interface NEMeetingGetListOptions {
|
|
443
|
+
startTime?: number;
|
|
444
|
+
endTime?: number;
|
|
445
|
+
states?: number[];
|
|
446
|
+
}
|
|
447
|
+
export interface NEMeetingGetListBySizeParams {
|
|
448
|
+
states?: number[];
|
|
449
|
+
offset?: number;
|
|
450
|
+
size?: number;
|
|
451
|
+
}
|
|
452
|
+
export interface ActiveSpeakerConfig {
|
|
453
|
+
maxActiveSpeakerCount: number;
|
|
454
|
+
validVolumeThreshold: number;
|
|
455
|
+
activeSpeakerVolumeThreshold: number;
|
|
456
|
+
volumeIndicationInterval: number;
|
|
457
|
+
volumeIndicationWindowSize: number;
|
|
458
|
+
enableVideoPreSubscribe: boolean;
|
|
459
|
+
activeSpeakerListReportInterval: number;
|
|
460
|
+
}
|
|
461
|
+
export interface NEMeetingConfig {
|
|
462
|
+
data: NEProps;
|
|
463
|
+
deviceConfig?: NEProps;
|
|
464
|
+
appConfig: {
|
|
465
|
+
APP_LIVE: {
|
|
466
|
+
officialPushEnabled: boolean;
|
|
467
|
+
thirdPartyPushEnabled: boolean;
|
|
468
|
+
};
|
|
469
|
+
APP_ROOM_RESOURCE: {
|
|
470
|
+
annotation: boolean;
|
|
471
|
+
whiteboard: boolean;
|
|
472
|
+
chatroom: boolean;
|
|
473
|
+
breakoutRoom: boolean;
|
|
474
|
+
live: boolean;
|
|
475
|
+
rtc: boolean;
|
|
476
|
+
record: boolean;
|
|
477
|
+
localRecord: boolean;
|
|
478
|
+
sip: boolean;
|
|
479
|
+
waitingRoom: boolean;
|
|
480
|
+
sipInvite: boolean;
|
|
481
|
+
callOutRoomSystemDevice: boolean;
|
|
482
|
+
appInvite: boolean;
|
|
483
|
+
caption: boolean;
|
|
484
|
+
guest: boolean;
|
|
485
|
+
screenShare: {
|
|
486
|
+
enable: boolean;
|
|
487
|
+
message: string;
|
|
488
|
+
} | undefined;
|
|
489
|
+
transcript: boolean;
|
|
490
|
+
interpretation?: {
|
|
491
|
+
enable: boolean;
|
|
492
|
+
maxInterpreters: number;
|
|
493
|
+
enableCustomLang: boolean;
|
|
494
|
+
maxCustomLanguageLength: number;
|
|
495
|
+
maxLanguagesPerInterpreter: number;
|
|
496
|
+
};
|
|
497
|
+
summary: boolean;
|
|
498
|
+
};
|
|
499
|
+
MEETING_BEAUTY?: {
|
|
500
|
+
enable: boolean;
|
|
501
|
+
licenseUrl: string;
|
|
502
|
+
md5: string;
|
|
503
|
+
levels: number[];
|
|
504
|
+
};
|
|
505
|
+
MEETING_CHATROOM?: {
|
|
506
|
+
enableFileMessage: boolean;
|
|
507
|
+
enableImageMessage: boolean;
|
|
508
|
+
};
|
|
509
|
+
MEETING_RECORD?: {
|
|
510
|
+
mode: number;
|
|
511
|
+
videoEnabled: boolean;
|
|
512
|
+
audioEnabled: boolean;
|
|
513
|
+
};
|
|
514
|
+
MEETING_VIRTUAL_BACKGROUND?: {
|
|
515
|
+
enable: boolean;
|
|
516
|
+
};
|
|
517
|
+
MEETING_CLIENT_CONFIG?: {
|
|
518
|
+
activeSpeakerConfig: ActiveSpeakerConfig;
|
|
519
|
+
};
|
|
520
|
+
ROOM_END_TIME_TIP?: {
|
|
521
|
+
enable: boolean;
|
|
522
|
+
};
|
|
523
|
+
ROOM_WATERMARK: WatermarkInfo;
|
|
524
|
+
notifySenderAccid: string;
|
|
525
|
+
MEETING_ACCOUNT_CONFIG: {
|
|
526
|
+
avatarUpdateDisabled: boolean;
|
|
527
|
+
nicknameUpdateDisabled: boolean;
|
|
528
|
+
phoneNumberPattern: string;
|
|
529
|
+
userNameRegisterEnabled: boolean;
|
|
530
|
+
usernameAsPhoneNumber: boolean;
|
|
531
|
+
};
|
|
532
|
+
MEETING_SCHEDULED_MEMBER_CONFIG?: {
|
|
533
|
+
enable: boolean;
|
|
534
|
+
coHostLimit: number;
|
|
535
|
+
max: number;
|
|
536
|
+
};
|
|
537
|
+
MEETING_LIVE?: {
|
|
538
|
+
maxThirdPartyNum: number;
|
|
539
|
+
};
|
|
540
|
+
MEETING_BREAKOUT_CONFIG?: {
|
|
541
|
+
maxRooms: number;
|
|
542
|
+
};
|
|
543
|
+
inboundPhoneNumber?: string;
|
|
544
|
+
outboundPhoneNumber?: string;
|
|
545
|
+
};
|
|
546
|
+
}
|
|
547
|
+
export interface AnonymousLoginResponse {
|
|
548
|
+
userUuid: string;
|
|
549
|
+
userToken: string;
|
|
550
|
+
privateMeetingNum: string;
|
|
551
|
+
}
|
|
552
|
+
export type NEScheduledMember = {
|
|
553
|
+
userUuid: string;
|
|
554
|
+
role: Role;
|
|
555
|
+
};
|
|
556
|
+
export interface NEAccountInfoListResponse {
|
|
557
|
+
accountInfoList: NEAccountInfo[];
|
|
558
|
+
}
|
|
559
|
+
export declare enum NEMenuVisibility {
|
|
560
|
+
/** 对应菜单始终可见 */
|
|
561
|
+
VISIBLE_ALWAYS = 0,
|
|
562
|
+
/** 对应菜单仅主持人可见 */
|
|
563
|
+
VISIBLE_TO_HOST_ONLY = 1,
|
|
564
|
+
/** 对应菜单主持人不可见 */
|
|
565
|
+
VISIBLE_EXCLUDE_HOST = 2,
|
|
566
|
+
/** SIP/H323不可见 */
|
|
567
|
+
VISIBLE_EXCLUDE_ROOM_SYSTEM_DEVICE = 3,
|
|
568
|
+
/** 仅对会议创建者可见 */
|
|
569
|
+
VISIBLE_TO_OWNER_ONLY = 4,
|
|
570
|
+
/** 仅对会议主持人可见,联席主持人不可见 */
|
|
571
|
+
VISIBLE_TO_HOST_EXCLUDE_COHOST = 5
|
|
572
|
+
}
|
|
573
|
+
export type NEMenuItemInfo = {
|
|
574
|
+
icon: string;
|
|
575
|
+
text: string;
|
|
576
|
+
lightIcon: string;
|
|
577
|
+
darkIcon: string;
|
|
578
|
+
};
|
|
579
|
+
export type NEMeetingMenuItem = {
|
|
580
|
+
itemId: number;
|
|
581
|
+
visibility?: NEMenuVisibility;
|
|
582
|
+
};
|
|
583
|
+
export type NESingleStateMenuItem = NEMeetingMenuItem & {
|
|
584
|
+
singleStateItem: NEMenuItemInfo;
|
|
585
|
+
};
|
|
586
|
+
export type NECheckableMenuItem = NEMeetingMenuItem & {
|
|
587
|
+
checkedStateItem: NEMenuItemInfo;
|
|
588
|
+
uncheckStateItem: NEMenuItemInfo;
|
|
589
|
+
checked: boolean;
|
|
590
|
+
};
|
|
591
|
+
export interface PlatformInfo {
|
|
592
|
+
platform: string;
|
|
593
|
+
pushUrl: string;
|
|
594
|
+
pushKey: string;
|
|
595
|
+
pushSecret: string;
|
|
596
|
+
}
|
|
597
|
+
export interface NEMeetingRecordQueryParams {
|
|
598
|
+
roomArchiveId?: string;
|
|
599
|
+
startTime?: number;
|
|
600
|
+
endTime?: number;
|
|
601
|
+
offset?: number;
|
|
602
|
+
size?: number;
|
|
603
|
+
}
|
|
604
|
+
export interface NEMeetingRecordItem {
|
|
605
|
+
roomArchiveId: string;
|
|
606
|
+
subject: string;
|
|
607
|
+
startTime: number;
|
|
608
|
+
endTime: number;
|
|
609
|
+
recordUrl: string;
|
|
610
|
+
recordSize: number;
|
|
611
|
+
recordDuration: number;
|
|
612
|
+
}
|
|
613
|
+
export interface NEMeetingRecordEditData {
|
|
614
|
+
subject: string;
|
|
615
|
+
}
|
|
616
|
+
export type NEMeetingWebAppIconItem = {
|
|
617
|
+
/** 应用图标url */
|
|
618
|
+
defaultIcon: string;
|
|
619
|
+
/** 推送图标url */
|
|
620
|
+
notifyIcon?: string;
|
|
621
|
+
};
|
|
622
|
+
export declare const enum NEMeetingWebAppItemType {
|
|
623
|
+
/** 官方应用 */
|
|
624
|
+
kOfficial = 0,
|
|
625
|
+
/** 企业自建应用 */
|
|
626
|
+
kCorporate = 1
|
|
627
|
+
}
|
|
628
|
+
export type NEMeetingWebAppItem = {
|
|
629
|
+
/** 应用Id */
|
|
630
|
+
pluginId: string;
|
|
631
|
+
/** 应用名称 */
|
|
632
|
+
name: string;
|
|
633
|
+
/** 应用图标 */
|
|
634
|
+
icon: NEMeetingWebAppIconItem;
|
|
635
|
+
/** 应用描述 */
|
|
636
|
+
description?: string;
|
|
637
|
+
/** 应用类型 */
|
|
638
|
+
type: NEMeetingWebAppItemType;
|
|
639
|
+
/** 应用链接 */
|
|
640
|
+
homeUrl: string;
|
|
641
|
+
/** 会话Id */
|
|
642
|
+
notifySenderAccid: string;
|
|
643
|
+
/** 会话ID */
|
|
644
|
+
sessionId?: string;
|
|
645
|
+
};
|
|
646
|
+
export type NEMeetingWebAppOptions = {
|
|
647
|
+
memberHistoryId?: number;
|
|
648
|
+
};
|
|
649
|
+
export interface NEMeetingInterpretationSettings {
|
|
650
|
+
listenLanguage?: string;
|
|
651
|
+
isListenMajor?: boolean;
|
|
652
|
+
majorVolume?: number;
|
|
653
|
+
muted?: boolean;
|
|
654
|
+
speakerLanguage?: string;
|
|
655
|
+
}
|
|
656
|
+
export declare enum NEMeetingInviteStatus {
|
|
657
|
+
/**
|
|
658
|
+
* 未知
|
|
659
|
+
*/
|
|
660
|
+
unknown = 0,
|
|
661
|
+
waitingCall = 1,
|
|
662
|
+
calling = 2,
|
|
663
|
+
rejected = 3,
|
|
664
|
+
noAnswer = 4,
|
|
665
|
+
error = 5,
|
|
666
|
+
removed = 6,
|
|
667
|
+
canceled = 7,
|
|
668
|
+
waitingJoin = 8,
|
|
669
|
+
busy = 9
|
|
670
|
+
}
|
|
671
|
+
export declare enum NEMeetingRole {
|
|
672
|
+
/** 参会者 */
|
|
673
|
+
participant = "member",
|
|
674
|
+
/** 主持人 */
|
|
675
|
+
host = "host",
|
|
676
|
+
/** 联席主持人 */
|
|
677
|
+
coHost = "cohost",
|
|
678
|
+
/** 影子用户 */
|
|
679
|
+
ghost = "ghost"
|
|
680
|
+
}
|
|
681
|
+
export declare enum NEMeetingStatus {
|
|
682
|
+
/** 创建或加入会议失败 */
|
|
683
|
+
MEETING_STATUS_FAILED = -1,
|
|
684
|
+
/** 当前未处于任何会议中 */
|
|
685
|
+
MEETING_STATUS_IDLE = 0,
|
|
686
|
+
/** 当前处于等待状态 */
|
|
687
|
+
MEETING_STATUS_WAITING = 1,
|
|
688
|
+
/** 当前正在创建或加入会议 */
|
|
689
|
+
MEETING_STATUS_CONNECTING = 2,
|
|
690
|
+
/** 当前处于会议中 */
|
|
691
|
+
MEETING_STATUS_INMEETING = 3,
|
|
692
|
+
/** 当前处于等候室 */
|
|
693
|
+
MEETING_STATUS_IN_WAITING_ROOM = 5,
|
|
694
|
+
/** 当前正在从会议中断开,断开原因参见NEMeetingCode */
|
|
695
|
+
MEETING_STATUS_DISCONNECTING = 6,
|
|
696
|
+
/** 当前处于最小化状态 */
|
|
697
|
+
MEETING_STATUS_INMEETING_MINIMIZED = 4,
|
|
698
|
+
/** 当前初始设备检测状态 */
|
|
699
|
+
MEETING_STATUS_DEVICE_TESTING = 7,
|
|
700
|
+
/** 未知状态 */
|
|
701
|
+
MEETING_STATUS_UNKNOWN = 100
|
|
702
|
+
}
|
|
703
|
+
export declare enum NEMeetingCode {
|
|
704
|
+
/** 当前正在从会议中断开,原因为用户主动断开 */
|
|
705
|
+
MEETING_DISCONNECTING_BY_SELF = 0,
|
|
706
|
+
/** 会议断开的类型之一,当前正在从会议中断开,原因为被会议主持人移除 */
|
|
707
|
+
MEETING_DISCONNECTING_REMOVED_BY_HOST = 1,
|
|
708
|
+
/**当前正在从会议中断开,原因为会议被主持人关闭 */
|
|
709
|
+
MEETING_DISCONNECTING_CLOSED_BY_HOST = 2,
|
|
710
|
+
/** 当前正在从会议中断开,原因为账号在其他设备上登录 */
|
|
711
|
+
MEETING_DISCONNECTING_LOGIN_ON_OTHER_DEVICE = 3,
|
|
712
|
+
/**当前正在从会议中断开,原因为自己作为主持人主动结束了会议 */
|
|
713
|
+
MEETING_DISCONNECTING_CLOSED_BY_SELF_AS_HOST = 4,
|
|
714
|
+
/**当前正在从会议中断开,原因为账号信息已过期 */
|
|
715
|
+
MEETING_DISCONNECTING_AUTH_INFO_EXPIRED = 5,
|
|
716
|
+
/** 会议不存在 */
|
|
717
|
+
MEETING_DISCONNECTING_NOT_EXIST = 7,
|
|
718
|
+
/** 同步房间信息失败 */
|
|
719
|
+
MEETING_DISCONNECTING_SYNC_DATA_ERROR = 8,
|
|
720
|
+
/** rtc 模块初始化失败 */
|
|
721
|
+
MEETING_DISCONNECTING_RTC_INIT_ERROR = 9,
|
|
722
|
+
/** 加入频道失败 */
|
|
723
|
+
MEETING_DISCONNECTING_JOIN_CHANNEL_ERROR = 10,
|
|
724
|
+
/** 入会超时 */
|
|
725
|
+
MEETING_DISCONNECTING_JOIN_TIMEOUT = 11,
|
|
726
|
+
/** 会议时长到达上限 */
|
|
727
|
+
MEETING_DISCONNECTING_END_OF_LIFE = 12,
|
|
728
|
+
/** 正在等待验证会议密码 */
|
|
729
|
+
MEETING_WAITING_VERIFY_PASSWORD = 20,
|
|
730
|
+
/** 开始加入RTC */
|
|
731
|
+
MEETING_JOIN_CHANNEL_START = 21,
|
|
732
|
+
/** 加入RTC成功 */
|
|
733
|
+
MEETING_JOIN_CHANNEL_SUCCESS = 22
|
|
734
|
+
}
|
|
735
|
+
/**
|
|
736
|
+
* 房间录制文件信息类型
|
|
737
|
+
* @property type 文件的类型,即文件扩展名。aac:实时音频录制文件、mp4:实时视频录制文件、flv:互动直播视频录制文件
|
|
738
|
+
* @property mix 是否为混合录制文件,true:混合录制文件,false:单人录制文件。
|
|
739
|
+
* @property filename 文件名
|
|
740
|
+
* @property md5 文件md5
|
|
741
|
+
* @property size 文件大小,单位为字节
|
|
742
|
+
* @property url 文件下载地址
|
|
743
|
+
* @property vid 点播文件id
|
|
744
|
+
* @property pieceIndex 录制文件分片索引
|
|
745
|
+
* @property userUuid 用户id // 单录用户的uuid
|
|
746
|
+
* @property nickname 会议昵称 // 单录用户的会议中的昵称
|
|
747
|
+
*/
|
|
748
|
+
export interface NERecordFileInfo {
|
|
749
|
+
type: string;
|
|
750
|
+
mix: boolean;
|
|
751
|
+
filename: string;
|
|
752
|
+
md5: string;
|
|
753
|
+
size: number;
|
|
754
|
+
url: string;
|
|
755
|
+
vid: number;
|
|
756
|
+
pieceIndex: number;
|
|
757
|
+
userUuid?: string;
|
|
758
|
+
nickname?: string;
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* 房间录制信息类型
|
|
762
|
+
* @param recordId 录制id
|
|
763
|
+
* @param recordStartTime 录制开始时间,毫秒时间戳
|
|
764
|
+
* @param recordEndTime 录制结束时间,毫秒时间戳
|
|
765
|
+
* @param infoList 录制信息列表
|
|
766
|
+
*/
|
|
767
|
+
export interface NERoomRecord {
|
|
768
|
+
recordId: string;
|
|
769
|
+
recordStartTime: number;
|
|
770
|
+
recordEndTime: number;
|
|
771
|
+
infoList: NERecordFileInfo[];
|
|
772
|
+
}
|
|
773
|
+
export declare enum NEErrorCode {
|
|
774
|
+
/** 失败 */
|
|
775
|
+
Failure = -1,
|
|
776
|
+
/** 成功 */
|
|
777
|
+
Success = 0,
|
|
778
|
+
/** 网络异常 */
|
|
779
|
+
NetworkUnavailable = 100003,
|
|
780
|
+
/** 开启了IM复用,请先登录IM */
|
|
781
|
+
ReuseIMNotLogin = 100004,
|
|
782
|
+
/** 开启了IM复用,IM账号不匹配 */
|
|
783
|
+
ReuseIMAccountNotMatch = 100005,
|
|
784
|
+
/** 认证过期 */
|
|
785
|
+
AuthExpired = 402,
|
|
786
|
+
/** 会议已锁定 */
|
|
787
|
+
RoomLocked = 1019,
|
|
788
|
+
/** 密码错误 */
|
|
789
|
+
BadPassword = 1020,
|
|
790
|
+
/** 房间不存在 */
|
|
791
|
+
RoomNotExist = 1004,
|
|
792
|
+
/** 同时共享时错误 屏幕共享同时只能一人 */
|
|
793
|
+
ScreenSharingLimitError = 1012,
|
|
794
|
+
/** 无屏幕共享权限 */
|
|
795
|
+
NoScreenSharingPermission = 1024,
|
|
796
|
+
/** 角色上限超出 */
|
|
797
|
+
OverRoleLimitCount = 1002,
|
|
798
|
+
/** 操作过期,请求被忽略 */
|
|
799
|
+
RequestIgnored = 1501,
|
|
800
|
+
/** 无权限操作 */
|
|
801
|
+
RequestNoPermission = 3107,
|
|
802
|
+
/** 等候室成员不存在 */
|
|
803
|
+
WaitingRoomMemberNotExist = 602003
|
|
804
|
+
}
|
|
805
|
+
/** SDK通用错误码 */
|
|
806
|
+
export declare enum NEMeetingErrorCode {
|
|
807
|
+
/** 取消操作 */
|
|
808
|
+
Cancelled = -9,
|
|
809
|
+
/** SDK没有登录 */
|
|
810
|
+
NoAuth = -7,
|
|
811
|
+
/** 创建或加入会议失败,原因为当前已经处于一个会议中 */
|
|
812
|
+
AlreadyInMeeting = -6,
|
|
813
|
+
/** 接口调用失败,原因为参数错误 */
|
|
814
|
+
ParamError = -5,
|
|
815
|
+
/** 创建会议失败,原因为当前已经存在一个使用相同会议ID的会议。调用方此时可以加入该会议或者等待该会议结束后重新创建 */
|
|
816
|
+
MeetingAlreadyExist = -4,
|
|
817
|
+
/** 接口调用失败,原因为无网络连接 */
|
|
818
|
+
NoNetwork = -3,
|
|
819
|
+
/** 对应接口调用失败 */
|
|
820
|
+
Failed = -1,
|
|
821
|
+
/** 对应接口调用成功 */
|
|
822
|
+
Success = 0,
|
|
823
|
+
/** 网络异常 */
|
|
824
|
+
NetworkUnavailable = 100003,
|
|
825
|
+
/** 开启了IM复用,请先登录IM */
|
|
826
|
+
ReuseIMNotLogin = 100004,
|
|
827
|
+
/** 开启了IM复用,IM账号不匹配 */
|
|
828
|
+
ReuseIMAccountNotMatch = 100005,
|
|
829
|
+
/** 企业不存在 */
|
|
830
|
+
CorpNotFound = 1834,
|
|
831
|
+
/** 账号需要重置密码才能允许登录 */
|
|
832
|
+
AccountPasswordNeedReset = 3426,
|
|
833
|
+
/** 当前状态跨应用入会不支持 */
|
|
834
|
+
CrossAppJoinNotSupported = 112003,
|
|
835
|
+
/** 企业不支持 SSO 登录 */
|
|
836
|
+
CorpNotSupportSSO = 112002,
|
|
837
|
+
/** IM复用不支持匿名加入会议 */
|
|
838
|
+
ReuseIMNotSupportAnonymousLogin = 112001,
|
|
839
|
+
/** 会议被锁定 */
|
|
840
|
+
MeetingLocked = 1019,
|
|
841
|
+
/** 会议密码错误 */
|
|
842
|
+
BadPassword = 1020,
|
|
843
|
+
/** 会议已回收 */
|
|
844
|
+
MeetingRecycled = 3102,
|
|
845
|
+
/** 会议不存在 */
|
|
846
|
+
MeetingNotExist = 3104,
|
|
847
|
+
/** room 不存在 */
|
|
848
|
+
MeetingNotInProgress = 1004,
|
|
849
|
+
/** 鉴权过期,如密码重置 */
|
|
850
|
+
AuthExpired = 402,
|
|
851
|
+
/** 不支持访客入会 */
|
|
852
|
+
GuestJoinNotSupported = 3432,
|
|
853
|
+
/** 访客入会需要认证 */
|
|
854
|
+
GuestJoinNeedVerify = 3433,
|
|
855
|
+
/** 聊天室不存在 */
|
|
856
|
+
chatroomNotExists = 110001
|
|
857
|
+
}
|
|
858
|
+
/**
|
|
859
|
+
* 组件当前支持的语言类型。通过{@link NEMeetingKit#switchLanguage(NEMeetingLanguage)} 可切换语言。
|
|
860
|
+
* CHINESE 中文;ENGLISH 英文;JAPANESE 日文;
|
|
861
|
+
*/
|
|
862
|
+
export declare enum NEMeetingLanguage {
|
|
863
|
+
AUTOMATIC = "*",
|
|
864
|
+
CHINESE = "zh",
|
|
865
|
+
ENGLISH = "en",
|
|
866
|
+
JAPANESE = "ja"
|
|
867
|
+
}
|
|
868
|
+
export interface NEMeetingCorpInfo {
|
|
869
|
+
appKey: string;
|
|
870
|
+
appName: string;
|
|
871
|
+
idpList: unknown[];
|
|
872
|
+
ssoLevel: number;
|
|
873
|
+
}
|
|
874
|
+
export interface NEMeetingCorpSSOLevel {
|
|
875
|
+
NONE: number;
|
|
876
|
+
BASIC: number;
|
|
877
|
+
ADVANCED: number;
|
|
878
|
+
}
|
|
879
|
+
export interface NEMeetingMessageChannelService {
|
|
880
|
+
addMessageChannelListener(listener: {
|
|
881
|
+
onCustomMessageReceived: (msg: {
|
|
882
|
+
commandId: number;
|
|
883
|
+
senderUuid: string;
|
|
884
|
+
data: string;
|
|
885
|
+
}) => void;
|
|
886
|
+
onSessionMessageReceived: (data: unknown) => void;
|
|
887
|
+
onSessionMessageRecentChanged: (data: unknown) => void;
|
|
888
|
+
onSessionMessageDeleted: (data: unknown) => void;
|
|
889
|
+
onDeleteAllSessionMessage: (sessionId: string, sessionType: number) => void;
|
|
890
|
+
}): void;
|
|
891
|
+
queryUnreadMessageList(sessionId: string, sessionType: number): Promise<NEResult<unknown[]>>;
|
|
892
|
+
getSessionMessagesHistory(options: {
|
|
893
|
+
sessionId: string;
|
|
894
|
+
fromTime?: number;
|
|
895
|
+
toTime?: number;
|
|
896
|
+
limit?: number;
|
|
897
|
+
order?: unknown;
|
|
898
|
+
}): Promise<NEResult<unknown[]>>;
|
|
899
|
+
clearUnreadCount(sessionId: string, sessionType: number): Promise<NEResult<null>>;
|
|
900
|
+
deleteAllSessionMessage(sessionId: string, sessionType: number): Promise<NEResult<null>>;
|
|
901
|
+
}
|
|
902
|
+
export interface NEMeetingChatMessage {
|
|
903
|
+
messageUuid: string;
|
|
904
|
+
messageType: number;
|
|
905
|
+
fromUserUuid: string;
|
|
906
|
+
toUserUuidList: string[];
|
|
907
|
+
text: string;
|
|
908
|
+
attachStr: string;
|
|
909
|
+
displayName: string;
|
|
910
|
+
extension: string;
|
|
911
|
+
md5: string;
|
|
912
|
+
url: string;
|
|
913
|
+
size: number;
|
|
914
|
+
thumbPath: string;
|
|
915
|
+
path: string;
|
|
916
|
+
width: number;
|
|
917
|
+
height: number;
|
|
918
|
+
}
|
|
919
|
+
export interface NEMeetingChatMessageType {
|
|
920
|
+
NEMeetingChatMessageTypeText: number;
|
|
921
|
+
NEMeetingChatMessageTypeFile: number;
|
|
922
|
+
NEMeetingChatMessageTypeImage: number;
|
|
923
|
+
NEMeetingChatMessageTypeCustom: number;
|
|
924
|
+
}
|
|
925
|
+
export interface NEMeetingTranscriptionInfo {
|
|
926
|
+
startTime: number;
|
|
927
|
+
endTime: number;
|
|
928
|
+
text: string;
|
|
929
|
+
language: string;
|
|
930
|
+
userId: string;
|
|
931
|
+
userName: string;
|
|
932
|
+
}
|
|
933
|
+
export interface NEChatroomHistoryMessageSearchOption {
|
|
934
|
+
fromTime?: number;
|
|
935
|
+
toTime?: number;
|
|
936
|
+
limit?: number;
|
|
937
|
+
order?: unknown;
|
|
938
|
+
}
|
|
939
|
+
export interface IM {
|
|
940
|
+
nim: unknown;
|
|
941
|
+
imAccid: string;
|
|
942
|
+
imAppKey: string;
|
|
943
|
+
imToken: string;
|
|
944
|
+
nickName: string;
|
|
945
|
+
chatRoomId: string;
|
|
946
|
+
}
|
|
947
|
+
export interface IMInfo {
|
|
948
|
+
nim: unknown;
|
|
949
|
+
imAccid: string;
|
|
950
|
+
imAppKey: string;
|
|
951
|
+
imToken: string;
|
|
952
|
+
nickName: string;
|
|
953
|
+
chatRoomId: string;
|
|
954
|
+
}
|
|
955
|
+
export interface NEMeetingRealtimeRecorderService {
|
|
956
|
+
startRecord(): Promise<NEResult<void>>;
|
|
957
|
+
stopRecord(): Promise<NEResult<void>>;
|
|
958
|
+
pauseRecord(): Promise<NEResult<void>>;
|
|
959
|
+
resumeRecord(): Promise<NEResult<void>>;
|
|
960
|
+
getRecordState(): Promise<NEResult<number>>;
|
|
961
|
+
getRecordDuration(): Promise<NEResult<number>>;
|
|
962
|
+
getRecordFileSize(): Promise<NEResult<number>>;
|
|
963
|
+
getRecordFilePath(): Promise<NEResult<string>>;
|
|
964
|
+
}
|
|
965
|
+
export interface NEMeetingWebAppService {
|
|
966
|
+
openWebApp(pluginId: string, options?: NEMeetingWebAppOptions): Promise<NEResult<void>>;
|
|
967
|
+
closeWebApp(pluginId: string): Promise<NEResult<void>>;
|
|
968
|
+
getWebAppList(): Promise<NEResult<NEMeetingWebAppItem[]>>;
|
|
969
|
+
getWebAppAuthCode(pluginId: string): Promise<NEResult<string>>;
|
|
970
|
+
}
|
|
971
|
+
export interface NEFeedbackService {
|
|
972
|
+
submitFeedback(data: {
|
|
973
|
+
category: string;
|
|
974
|
+
description: string;
|
|
975
|
+
contact?: string;
|
|
976
|
+
}): Promise<NEResult<void>>;
|
|
977
|
+
}
|
|
978
|
+
export interface NEGuestService {
|
|
979
|
+
joinAsGuest(options: {
|
|
980
|
+
meetingNum: string;
|
|
981
|
+
nickName: string;
|
|
982
|
+
password?: string;
|
|
983
|
+
phoneNum?: string;
|
|
984
|
+
verifyCode?: string;
|
|
985
|
+
}): Promise<NEResult<void>>;
|
|
986
|
+
sendVerifyCode(meetingNum: string, phoneNum: string): Promise<NEResult<void>>;
|
|
987
|
+
}
|
|
988
|
+
export interface NEMeetingAccountService {
|
|
989
|
+
getAccountInfo(): Promise<NEResult<NEAccountInfo>>;
|
|
990
|
+
updateNickname(nickname: string): Promise<NEResult<void>>;
|
|
991
|
+
resetPassword(params: {
|
|
992
|
+
userUuid: string;
|
|
993
|
+
newPassword: string;
|
|
994
|
+
oldPassword: string;
|
|
995
|
+
}): Promise<NEResult<void>>;
|
|
996
|
+
getAccountInfoList(userUuids: string[]): Promise<NEResult<NEAccountInfoListResponse>>;
|
|
997
|
+
}
|
|
998
|
+
export interface NEMeetingInviteService {
|
|
999
|
+
inviteMember(params: {
|
|
1000
|
+
meetingNum: string;
|
|
1001
|
+
userUuids: string[];
|
|
1002
|
+
message?: string;
|
|
1003
|
+
}): Promise<NEResult<void>>;
|
|
1004
|
+
cancelInvite(params: {
|
|
1005
|
+
meetingNum: string;
|
|
1006
|
+
userUuids: string[];
|
|
1007
|
+
}): Promise<NEResult<void>>;
|
|
1008
|
+
getInviteList(meetingNum: string): Promise<NEResult<unknown[]>>;
|
|
1009
|
+
}
|
|
1010
|
+
export interface NEMeetingContactsService {
|
|
1011
|
+
getContactsList(): Promise<NEResult<unknown[]>>;
|
|
1012
|
+
searchContacts(keyword: string): Promise<NEResult<unknown[]>>;
|
|
1013
|
+
addContact(contact: unknown): Promise<NEResult<void>>;
|
|
1014
|
+
removeContact(userUuid: string): Promise<NEResult<void>>;
|
|
1015
|
+
}
|
|
1016
|
+
export interface NEMeetingSettingsService {
|
|
1017
|
+
getSettings(): Promise<NEResult<Record<string, unknown>>>;
|
|
1018
|
+
updateSettings(settings: Record<string, unknown>): Promise<NEResult<void>>;
|
|
1019
|
+
resetSettings(): Promise<NEResult<void>>;
|
|
1020
|
+
}
|
|
1021
|
+
export interface NEPreMeetingService {
|
|
1022
|
+
createMeeting(options: NEMeetingCreateOptions): Promise<NEResult<NEMeetingInfo>>;
|
|
1023
|
+
scheduleMeeting(options: NEMeetingCreateOptions): Promise<NEResult<NEMeetingInfo>>;
|
|
1024
|
+
cancelMeeting(meetingId: number | string, cancelRecurringMeeting?: boolean): Promise<NEResult<void>>;
|
|
1025
|
+
getMeetingList(options: NEMeetingGetListOptions): Promise<NEResult<NEMeetingInfo[]>>;
|
|
1026
|
+
getMeetingListBySize(params: NEMeetingGetListBySizeParams): Promise<NEResult<NEMeetingInfo[]>>;
|
|
1027
|
+
getMeetingInfoByMeetingId(meetingId: string | number): Promise<NEResult<NEMeetingInfo>>;
|
|
1028
|
+
getMeetingInfoByFetch(meetingId: string): Promise<NEResult<NEMeetingInfo>>;
|
|
1029
|
+
getScheduledMembers(meetingNum: string): Promise<NEResult<NEScheduledMember[]>>;
|
|
1030
|
+
getRecordItemList(params: NEMeetingRecordQueryParams): Promise<NEResult<{
|
|
1031
|
+
total: number;
|
|
1032
|
+
data: NEMeetingRecordItem[];
|
|
1033
|
+
}>>;
|
|
1034
|
+
deleteRecordItem(roomArchiveId: string): Promise<NEResult<void>>;
|
|
1035
|
+
editRecordItem(roomArchiveId: string, data: NEMeetingRecordEditData): Promise<NEResult<void>>;
|
|
1036
|
+
getMeetingPluginList(): Promise<NEResult<{
|
|
1037
|
+
pluginInfos: NEMeetingWebAppItem[];
|
|
1038
|
+
}>>;
|
|
1039
|
+
getMeetingPluginAuthCode(params: {
|
|
1040
|
+
pluginId: string;
|
|
1041
|
+
}): Promise<NEResult<{
|
|
1042
|
+
authCode: string;
|
|
1043
|
+
}>>;
|
|
1044
|
+
getConvoToken(): Promise<NEResult<string>>;
|
|
1045
|
+
getHistoryConvoToken(memberHistoryId: number): Promise<NEResult<{
|
|
1046
|
+
convoId: string;
|
|
1047
|
+
convoToken: string;
|
|
1048
|
+
}>>;
|
|
1049
|
+
activateRooms(code: string): Promise<NEResult<void>>;
|
|
1050
|
+
getLive3PartInfo(): Promise<NEResult<PlatformInfo[]>>;
|
|
1051
|
+
updateLive3PartInfo(data: {
|
|
1052
|
+
thirdParties: PlatformInfo[];
|
|
1053
|
+
}): Promise<NEResult<void>>;
|
|
1054
|
+
getHostAndCohostList(): Promise<NEResult<unknown[]>>;
|
|
1055
|
+
getWaitingRoomConfig(roomUuid: string): Promise<NEResult<{
|
|
1056
|
+
wtPrChat: number;
|
|
1057
|
+
}>>;
|
|
1058
|
+
saveViewOrderInMeeting(data: string): Promise<NEResult<void>>;
|
|
1059
|
+
getMeetingInfoForGuest(meetingNum: string): Promise<NEResult<GuestMeetingInfo>>;
|
|
1060
|
+
sendVerifyCodeApiByGuest(meetingNum: string, phoneNum: string): Promise<NEResult<void>>;
|
|
1061
|
+
getMeetingInfoForGuestByPhoneNum(data: {
|
|
1062
|
+
meetingNum: string;
|
|
1063
|
+
phoneNum: string;
|
|
1064
|
+
verifyCode: string;
|
|
1065
|
+
}): Promise<NEResult<GuestMeetingInfo>>;
|
|
1066
|
+
sendVerifyCodeApi(params: {
|
|
1067
|
+
appKey?: string;
|
|
1068
|
+
mobile?: string;
|
|
1069
|
+
scene?: number;
|
|
1070
|
+
}): Promise<NEResult<void>>;
|
|
1071
|
+
anonymousLogin(): Promise<NEResult<NEAccountInfo>>;
|
|
1072
|
+
loginApi(params: {
|
|
1073
|
+
verifyCode?: string;
|
|
1074
|
+
username?: string;
|
|
1075
|
+
mobile?: string;
|
|
1076
|
+
appKey?: string;
|
|
1077
|
+
}): Promise<NEResult<NEAccountInfo>>;
|
|
1078
|
+
loginApiNew(params: {
|
|
1079
|
+
password: string;
|
|
1080
|
+
username?: string;
|
|
1081
|
+
phone?: string;
|
|
1082
|
+
email?: string;
|
|
1083
|
+
appKey?: string;
|
|
1084
|
+
}): Promise<NEResult<NEAccountInfo>>;
|
|
1085
|
+
getEnterPriseInfoApi(params: {
|
|
1086
|
+
code?: string;
|
|
1087
|
+
email?: string;
|
|
1088
|
+
}): Promise<NEResult<NEMeetingCorpInfo>>;
|
|
1089
|
+
generateSSOLoginWebURL(callback: string, ipdId: number): string;
|
|
1090
|
+
loginBySSOUri(param: string): Promise<NEResult<NEAccountInfo>>;
|
|
1091
|
+
modifyPasswordApi(params: {
|
|
1092
|
+
password: string;
|
|
1093
|
+
newPassword: string;
|
|
1094
|
+
appKey?: string;
|
|
1095
|
+
username: string;
|
|
1096
|
+
}): Promise<NEResult<NEAccountInfo>>;
|
|
1097
|
+
}
|
|
1098
|
+
export interface NEMeetingPrivateConfig {
|
|
1099
|
+
corpCode?: string;
|
|
1100
|
+
module?: {
|
|
1101
|
+
nps: {
|
|
1102
|
+
enabled: boolean;
|
|
1103
|
+
};
|
|
1104
|
+
feedback?: {
|
|
1105
|
+
enable: boolean;
|
|
1106
|
+
};
|
|
1107
|
+
appUpgrade?: {
|
|
1108
|
+
enable: boolean;
|
|
1109
|
+
iosCheckUrl: string;
|
|
1110
|
+
};
|
|
1111
|
+
about?: {
|
|
1112
|
+
privacyUrl: string;
|
|
1113
|
+
userProtocolUrl: string;
|
|
1114
|
+
};
|
|
1115
|
+
account?: {
|
|
1116
|
+
deleteAccountUrl: string;
|
|
1117
|
+
registryUrl: string;
|
|
1118
|
+
};
|
|
1119
|
+
};
|
|
1120
|
+
meeting: {
|
|
1121
|
+
serverUrl: string;
|
|
1122
|
+
};
|
|
1123
|
+
roomkit: {
|
|
1124
|
+
roomServer: string;
|
|
1125
|
+
};
|
|
1126
|
+
im?: NEMeetingAssetIMServerConfig;
|
|
1127
|
+
rtc?: NEMeetingAssetRtcServerConfig;
|
|
1128
|
+
whiteboard?: NEMeetingAssetWhiteboardServerConfig;
|
|
1129
|
+
appKey?: string;
|
|
1130
|
+
meetingServerDomain?: string;
|
|
1131
|
+
}
|
|
1132
|
+
export interface NEMeetingAssetWhiteboardServerConfig extends NEWhiteboardServerConfig {
|
|
1133
|
+
webServer: string;
|
|
1134
|
+
fontDownloadServer: string;
|
|
1135
|
+
}
|
|
1136
|
+
export interface NEMeetingAssetRtcServerConfig extends NERtcServerConfig {
|
|
1137
|
+
compatServer: string;
|
|
1138
|
+
nosLbsServer: string;
|
|
1139
|
+
nosUploadServer: string;
|
|
1140
|
+
nosTokenServer: string;
|
|
1141
|
+
}
|
|
1142
|
+
export interface NEMeetingAssetIMServerConfig {
|
|
1143
|
+
appkey: string;
|
|
1144
|
+
lbsUrl: string;
|
|
1145
|
+
weblbsUrl: string;
|
|
1146
|
+
nosReplacement: string;
|
|
1147
|
+
nosAccess: string;
|
|
1148
|
+
pubkeyVersion: string;
|
|
1149
|
+
chatroomDemoListUrl: string;
|
|
1150
|
+
websdkSsl: boolean;
|
|
1151
|
+
nosSsl: boolean;
|
|
1152
|
+
webchatroomAddr: string[];
|
|
1153
|
+
module: string;
|
|
1154
|
+
version: number;
|
|
1155
|
+
lbs: string;
|
|
1156
|
+
link: string;
|
|
1157
|
+
link_web: string;
|
|
1158
|
+
nos_lbs: string;
|
|
1159
|
+
nos_uploader: string;
|
|
1160
|
+
nos_uploader_host: string;
|
|
1161
|
+
https_enabled: boolean;
|
|
1162
|
+
nos_downloader: string;
|
|
1163
|
+
nos_accelerate: string;
|
|
1164
|
+
nos_accelerate_host: string;
|
|
1165
|
+
nt_server: string;
|
|
1166
|
+
kibana_server: string;
|
|
1167
|
+
statistic_server: string;
|
|
1168
|
+
report_global_server: string;
|
|
1169
|
+
multi_video: number;
|
|
1170
|
+
hand_shake_type: number;
|
|
1171
|
+
nego_key_neca: number;
|
|
1172
|
+
nego_key_enca_key_version: number;
|
|
1173
|
+
nego_key_enca_key_parta: string;
|
|
1174
|
+
nego_key_enca_key_partb: string;
|
|
1175
|
+
comm_enca: number;
|
|
1176
|
+
}
|
|
1177
|
+
export type NEmeetingItemLivePushThirdPart = {
|
|
1178
|
+
platformName: string;
|
|
1179
|
+
pushUrl: string;
|
|
1180
|
+
pushSecretKey?: string;
|
|
1181
|
+
};
|
|
1182
|
+
export declare enum MeetingRepeatType {
|
|
1183
|
+
NoRepeat = 1,
|
|
1184
|
+
Everyday = 2,
|
|
1185
|
+
EveryWeekday = 3,
|
|
1186
|
+
EveryWeek = 4,
|
|
1187
|
+
EveryTwoWeek = 5,
|
|
1188
|
+
EveryMonth = 6,
|
|
1189
|
+
Custom = 7
|
|
1190
|
+
}
|
|
1191
|
+
export interface NEMeetingAppNoticeTips {
|
|
1192
|
+
appKey: string;
|
|
1193
|
+
tips: NEMeetingAppNoticeTip[];
|
|
1194
|
+
curTime: number;
|
|
1195
|
+
}
|
|
1196
|
+
export type NEHistoryMeetingDetail = {
|
|
1197
|
+
/** 聊天室信息 */
|
|
1198
|
+
chatroomInfo?: NEChatroomInfo;
|
|
1199
|
+
pluginInfoList?: NEMeetingWebAppItem[];
|
|
1200
|
+
};
|
|
1201
|
+
export {};
|