@hysc/meeting 10.6.1 → 10.6.3
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/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/umd/index.js +0 -25
- package/umd/src/BMChat/BMChatVM.d.ts +0 -28
- package/umd/src/BMChat/BMMessageInfo.d.ts +0 -32
- package/umd/src/BMRoom/BMLiveVM.d.ts +0 -36
- package/umd/src/BMRoom/BMRoom.d.ts +0 -740
- package/umd/src/BMRoom/BMRoomInfo.d.ts +0 -222
- package/umd/src/BMRoom/BMRoomVM.d.ts +0 -329
- package/umd/src/BMRoom/RoomEvent.d.ts +0 -1
- package/umd/src/BMStream/BMSpeaker.d.ts +0 -26
- package/umd/src/BMStream/BMStreamModel.d.ts +0 -311
- package/umd/src/BMStream/BMStreamModelVM.d.ts +0 -281
- package/umd/src/BMStream/getHTMLMediaStreamOptions.d.ts +0 -35
- package/umd/src/BMStream/sortStream.d.ts +0 -30
- package/umd/src/BMUser/BMUser.d.ts +0 -173
- package/umd/src/BMUser/BMUserVM.d.ts +0 -188
- package/umd/src/SingletonQueue/SingletonQueue.d.ts +0 -16
- package/umd/src/audioPlay/AudioPlay.d.ts +0 -31
- package/umd/src/bjy-common/function/debounce.d.ts +0 -9
- package/umd/src/bjy-common/function/execute.d.ts +0 -9
- package/umd/src/bjy-common/function/getErrorMessage.d.ts +0 -1
- package/umd/src/bjy-common/function/isDef.d.ts +0 -1
- package/umd/src/bjy-common/function/isNative.d.ts +0 -1
- package/umd/src/bjy-common/function/isUndef.d.ts +0 -1
- package/umd/src/bjy-common/function/nextTick.d.ts +0 -2
- package/umd/src/bjy-common/function/throttling.d.ts +0 -9
- package/umd/src/bjy-common/function/toNumber.d.ts +0 -1
- package/umd/src/bjy-common/function/toString.d.ts +0 -1
- package/umd/src/bjy-common/type/api.d.ts +0 -66
- package/umd/src/bjy-common/type/options.d.ts +0 -7
- package/umd/src/bjy-common/type/type.d.ts +0 -90
- package/umd/src/bjy-common/util/CustomEvent.d.ts +0 -30
- package/umd/src/bjy-common/util/Emitter.d.ts +0 -57
- package/umd/src/bjy-common/util/NextTask.d.ts +0 -28
- package/umd/src/bjy-common/util/Sleep.d.ts +0 -14
- package/umd/src/bjy-common/util/Timer.d.ts +0 -13
- package/umd/src/bjy-common/util/array.d.ts +0 -96
- package/umd/src/bjy-common/util/browser.d.ts +0 -6
- package/umd/src/bjy-common/util/constant.d.ts +0 -50
- package/umd/src/bjy-common/util/holder.d.ts +0 -6
- package/umd/src/bjy-common/util/is.d.ts +0 -49
- package/umd/src/bjy-common/util/keypath.d.ts +0 -41
- package/umd/src/bjy-common/util/logger.d.ts +0 -42
- package/umd/src/bjy-common/util/network.d.ts +0 -4
- package/umd/src/bjy-common/util/object.d.ts +0 -83
- package/umd/src/bjy-common/util/os.d.ts +0 -14
- package/umd/src/bjy-common/util/string.d.ts +0 -102
- package/umd/src/constants.d.ts +0 -130
- package/umd/src/error/RTCError.d.ts +0 -20
- package/umd/src/error/errorMap.d.ts +0 -70
- package/umd/src/error/errorType.d.ts +0 -96
- package/umd/src/handleEvent/attachEvents.d.ts +0 -47
- package/umd/src/handleEvent/brtcNetEvent.d.ts +0 -9
- package/umd/src/handleEvent/customMessageEvent.d.ts +0 -2
- package/umd/src/handleEvent/handleParticipantEvent.d.ts +0 -24
- package/umd/src/handleEvent/handleRoomEvent.d.ts +0 -20
- package/umd/src/handleEvent/messageEvent.d.ts +0 -5
- package/umd/src/handleEvent/pullUser.d.ts +0 -7
- package/umd/src/handleEvent/roomErrEvent.d.ts +0 -9
- package/umd/src/handleEvent/streamEvent.d.ts +0 -22
- package/umd/src/index.d.ts +0 -13
- package/umd/src/logger/logger.d.ts +0 -86
- package/umd/src/type/customStats.d.ts +0 -129
- package/umd/src/type/index.d.ts +0 -9
- package/umd/src/type/stream.d.ts +0 -12
- package/umd/src/type/user.d.ts +0 -9
- package/umd/src/util/PackLoss.d.ts +0 -7
- package/umd/src/util/Pqueue.d.ts +0 -62
- package/umd/src/util/Privileges.d.ts +0 -20
- package/umd/src/util/ReportCollector.d.ts +0 -22
- package/umd/src/util/Stutter.d.ts +0 -19
- package/umd/src/util/Thread.d.ts +0 -12
- package/umd/src/util/base64.d.ts +0 -4
- package/umd/src/util/benchmark.d.ts +0 -1
- package/umd/src/util/checkPermissions.d.ts +0 -1
- package/umd/src/util/checkSystemRequirements.d.ts +0 -1
- package/umd/src/util/constant.d.ts +0 -67
- package/umd/src/util/devices.d.ts +0 -2
- package/umd/src/util/emitter.d.ts +0 -45
- package/umd/src/util/formatUserId.d.ts +0 -2
- package/umd/src/util/is.d.ts +0 -70
- package/umd/src/util/peerToPeerProbe.d.ts +0 -9
- package/umd/src/util/request.d.ts +0 -45
- package/umd/src/util/roomUtils.d.ts +0 -9
- package/umd/src/util/sortUtils.d.ts +0 -10
- package/umd/src/util/util.d.ts +0 -81
|
@@ -1,740 +0,0 @@
|
|
|
1
|
-
import BoomCore, { SMConfig } from "@hysc/core";
|
|
2
|
-
import BMRoomVM, { AudioProfileInfo } from "./BMRoomVM";
|
|
3
|
-
import BMUserVM from "../BMUser/BMUserVM";
|
|
4
|
-
import { SingleLocalStream, SingleRemoteStream } from "../type";
|
|
5
|
-
import type { SubscribeOptions } from '@hysc/brtc';
|
|
6
|
-
import BMChatVM from "../BMChat/BMChatVM";
|
|
7
|
-
import BMStreamModelVM from "../BMStream/BMStreamModelVM";
|
|
8
|
-
import type { Device, VideoProfile, AudioHint, StreamCodecOption } from "@hysc/brtc";
|
|
9
|
-
import BMRoomInfo from "./BMRoomInfo";
|
|
10
|
-
import { BehaviorSubject, Subject } from "rxjs";
|
|
11
|
-
import BMStreamModel, { ConnectErrorMessage } from "../BMStream/BMStreamModel";
|
|
12
|
-
import BMUser from "../BMUser/BMUser";
|
|
13
|
-
import SingletonQueue from "../SingletonQueue/SingletonQueue";
|
|
14
|
-
import BMLiveVM from "./BMLiveVM";
|
|
15
|
-
import AudioPlay from "../audioPlay/AudioPlay";
|
|
16
|
-
export declare type PullItem = {
|
|
17
|
-
id: string;
|
|
18
|
-
isScreen: boolean;
|
|
19
|
-
isWeb?: boolean;
|
|
20
|
-
force?: boolean;
|
|
21
|
-
};
|
|
22
|
-
interface BMRoomProps {
|
|
23
|
-
initDevices: boolean;
|
|
24
|
-
}
|
|
25
|
-
interface MediaPermission {
|
|
26
|
-
microphone: boolean;
|
|
27
|
-
camera: boolean;
|
|
28
|
-
screen: boolean;
|
|
29
|
-
}
|
|
30
|
-
export declare let _selfSortType: number;
|
|
31
|
-
export declare let autoPlayAudio: boolean;
|
|
32
|
-
export default class BMRoom {
|
|
33
|
-
roomVM: BMRoomVM | null;
|
|
34
|
-
userVM: BMUserVM;
|
|
35
|
-
chatVM: BMChatVM;
|
|
36
|
-
bmStreamVm: BMStreamModelVM;
|
|
37
|
-
observes: any;
|
|
38
|
-
boomCore: BoomCore;
|
|
39
|
-
videoDevices: Device[];
|
|
40
|
-
audioDevices: Device[];
|
|
41
|
-
audioOutputDevices: Device[];
|
|
42
|
-
selectVideoDevice: Device | null;
|
|
43
|
-
selectAudioDevice: Device | null;
|
|
44
|
-
selectAudioOutputDevice: Device | null;
|
|
45
|
-
streamQueue: SingletonQueue;
|
|
46
|
-
/**
|
|
47
|
-
* 这个参数是和业务相关的功能,业务上的参会者列表是可以配置的,如果设置了只展示一列,那么所有的用户都要存储
|
|
48
|
-
* 在commonUserList中
|
|
49
|
-
*/
|
|
50
|
-
userListColumns: number;
|
|
51
|
-
/**
|
|
52
|
-
* 排序规则 1 是标品排序, 2 是中移排序
|
|
53
|
-
*/
|
|
54
|
-
sortType: number;
|
|
55
|
-
/**
|
|
56
|
-
* brtc断网重连的时候,所有的订阅和播放相关的处理,都不需要
|
|
57
|
-
*/
|
|
58
|
-
BRTCConnectFailed: boolean;
|
|
59
|
-
/**
|
|
60
|
-
* 本端推流失败次数
|
|
61
|
-
*/
|
|
62
|
-
pubFailedNum: number;
|
|
63
|
-
streamConnectedErrorQueue: Array<ConnectErrorMessage>;
|
|
64
|
-
/**
|
|
65
|
-
* 会议模式
|
|
66
|
-
* 1 会议
|
|
67
|
-
* 2 直播
|
|
68
|
-
*/
|
|
69
|
-
conferenceMode: 1 | 2;
|
|
70
|
-
/**
|
|
71
|
-
* 是不是大房间
|
|
72
|
-
*/
|
|
73
|
-
isBig: boolean;
|
|
74
|
-
selectVideoDeviceWatcher: BehaviorSubject<Device | null>;
|
|
75
|
-
selectAudioDeviceWatcher: BehaviorSubject<Device | null>;
|
|
76
|
-
selectAudioOutputDeviceWatcher: BehaviorSubject<Device | null>;
|
|
77
|
-
audioDevicesWatcher: Subject<Device[]>;
|
|
78
|
-
videoDevicesWatcher: Subject<Device[]>;
|
|
79
|
-
audioOutputDevicesWatcher: Subject<Device[]>;
|
|
80
|
-
raiseHandleRespWatcher: Subject<{
|
|
81
|
-
raiseHandsType: 0 | 1 | 2 | 3;
|
|
82
|
-
raiseHands: boolean;
|
|
83
|
-
}>;
|
|
84
|
-
enableAudienceSpeakingWatcher: Subject<boolean>;
|
|
85
|
-
deviceChangeWatcher: Subject<boolean>;
|
|
86
|
-
mediaPermission: MediaPermission;
|
|
87
|
-
videoProfile: VideoProfile;
|
|
88
|
-
audioProfile: AudioProfileInfo | null;
|
|
89
|
-
voiceMode: AudioHint;
|
|
90
|
-
/**
|
|
91
|
-
* 视频自定义编码设置
|
|
92
|
-
*/
|
|
93
|
-
videoEncodeConfig: StreamCodecOption | null;
|
|
94
|
-
setVoiceMode(mode: AudioHint): void;
|
|
95
|
-
/**
|
|
96
|
-
* brtc断网重连要给端上事件响应,所有端上把流单独做处理的,需要在收到这个事件之后,重新处理所有的effect
|
|
97
|
-
*/
|
|
98
|
-
streamWSReconnectWatcher: Subject<boolean>;
|
|
99
|
-
/**
|
|
100
|
-
* bloud断网重连的时候的提示
|
|
101
|
-
*/
|
|
102
|
-
bloudWSReconnectWatcher: Subject<boolean>;
|
|
103
|
-
netConnecting: boolean;
|
|
104
|
-
netConnectingWatcher: Subject<boolean>;
|
|
105
|
-
hasSyncPermission: boolean;
|
|
106
|
-
/**
|
|
107
|
-
* 会控底层相关处理, 比如是否取消自动拉流
|
|
108
|
-
*/
|
|
109
|
-
private meetingControlOptions;
|
|
110
|
-
forceId: string;
|
|
111
|
-
/**
|
|
112
|
-
* bloud brtc 断网重连的处理
|
|
113
|
-
* networkState 记录网络状态
|
|
114
|
-
* handleReconnectedStream 防抖函数,当双方有连接断网重连之后,会执行这个方法
|
|
115
|
-
*
|
|
116
|
-
* brtc 的sync-room 之后,本地会把所有的stream都销毁,清空,然后统一走一遍查询处理
|
|
117
|
-
* 绑定新的stream,这么做简单粗暴处理所有的brtc流,防止流重复问题i
|
|
118
|
-
*/
|
|
119
|
-
networkState: {
|
|
120
|
-
bloud: boolean;
|
|
121
|
-
brtc: boolean;
|
|
122
|
-
};
|
|
123
|
-
brtcNetEnableWatcher: Subject<boolean>;
|
|
124
|
-
autoPlayAudio: boolean;
|
|
125
|
-
audioPlayer: AudioPlay;
|
|
126
|
-
private pubFailedTimer;
|
|
127
|
-
get isSingleColumns(): boolean;
|
|
128
|
-
get localIsAudience(): boolean;
|
|
129
|
-
get shouldIgnoreStream(): boolean;
|
|
130
|
-
/**
|
|
131
|
-
* 研讨会
|
|
132
|
-
*/
|
|
133
|
-
get isWorkShop(): boolean;
|
|
134
|
-
/**
|
|
135
|
-
* 传递信息用的,主要是用于message信令往上层业务发送消息
|
|
136
|
-
*/
|
|
137
|
-
messageWatcher: BehaviorSubject<any>;
|
|
138
|
-
roomInfo: BMRoomInfo;
|
|
139
|
-
localUser: BMUser;
|
|
140
|
-
bmLiveVM: BMLiveVM;
|
|
141
|
-
isInWaitRoom: boolean;
|
|
142
|
-
shouldPlayAudio: boolean;
|
|
143
|
-
/** 设备是否正在变更中 */
|
|
144
|
-
deviceChanging: boolean;
|
|
145
|
-
constructor({ initDevices }?: BMRoomProps);
|
|
146
|
-
/**
|
|
147
|
-
* 是否自动播放声音
|
|
148
|
-
* @param value
|
|
149
|
-
*/
|
|
150
|
-
setAutoPlayAudio(value: boolean): void;
|
|
151
|
-
setMediaPermission(permission: MediaPermission): void;
|
|
152
|
-
/**
|
|
153
|
-
* 是否应该播放声音
|
|
154
|
-
* @param value
|
|
155
|
-
*/
|
|
156
|
-
setShouldPlayAudio(value: boolean): void;
|
|
157
|
-
handleReprocessStreamError: () => void;
|
|
158
|
-
initAudioPlayer(playerContainerId: string): void;
|
|
159
|
-
/**
|
|
160
|
-
* 初始化底层会控相关
|
|
161
|
-
* @param options
|
|
162
|
-
*/
|
|
163
|
-
setupMeetingControlOptions(options: any): void;
|
|
164
|
-
/**
|
|
165
|
-
* 收到对某个流状态的订阅和取消状态
|
|
166
|
-
* @private
|
|
167
|
-
* @param event
|
|
168
|
-
*/
|
|
169
|
-
private handleSubMessage;
|
|
170
|
-
configSM(smConfig: SMConfig): void;
|
|
171
|
-
/**
|
|
172
|
-
* 设置视频分辨率, 需要在入会之前调用
|
|
173
|
-
* @param profile 设置视频分辨率
|
|
174
|
-
*/
|
|
175
|
-
setVideoProfile(profile: VideoProfile): void;
|
|
176
|
-
/**
|
|
177
|
-
* 设置视频分辨率, 需要在入会之前调用
|
|
178
|
-
* @param encodeConfig
|
|
179
|
-
* @param encodeConfig.width 宽
|
|
180
|
-
* @param encodeConfig.height 高
|
|
181
|
-
* @param encodeConfig.biterate 码率
|
|
182
|
-
* @param encodeConfig.frameRate 帧率
|
|
183
|
-
*/
|
|
184
|
-
setCustomVideoEncodeConfig(encodeConfig: StreamCodecOption): void;
|
|
185
|
-
setUserListColumns(column: number): void;
|
|
186
|
-
setSortType(type: number): void;
|
|
187
|
-
/**
|
|
188
|
-
* 设置声音增益的属性,回音消除 音频降噪 声音增益等
|
|
189
|
-
* @param audioProfile
|
|
190
|
-
*/
|
|
191
|
-
setAudioProfile(audioProfile: AudioProfileInfo): void;
|
|
192
|
-
/**
|
|
193
|
-
* 设置共享屏幕用户的brtc Sig
|
|
194
|
-
* @param sig
|
|
195
|
-
*/
|
|
196
|
-
setSig(sig: string): void;
|
|
197
|
-
private benchmark;
|
|
198
|
-
/**
|
|
199
|
-
* 初始化输入设备
|
|
200
|
-
*/
|
|
201
|
-
initDevices(devicechange?: boolean): Promise<any>;
|
|
202
|
-
/**
|
|
203
|
-
* 筛选出默认选中的设备,如果没有,选择第一个
|
|
204
|
-
* @param devices
|
|
205
|
-
*/
|
|
206
|
-
private filterDevice;
|
|
207
|
-
/**
|
|
208
|
-
* 处理用户设备变化之后的逻辑
|
|
209
|
-
*/
|
|
210
|
-
handleMediaDevicesChange: (e: any) => Promise<void>;
|
|
211
|
-
setSelectAudioDevice(device: Device): void;
|
|
212
|
-
setSelectVideoDevice(device: Device): void;
|
|
213
|
-
setSelectSpeakerDevice(device: Device): void;
|
|
214
|
-
/**
|
|
215
|
-
* 事件相关 observes执行subscribe, 即执行observes,并添加回调
|
|
216
|
-
* @param observeName observe名称
|
|
217
|
-
* @param subscribeParam subscribe的参数
|
|
218
|
-
*/
|
|
219
|
-
observe(observeName: string, subscribeParam: any): any;
|
|
220
|
-
/**
|
|
221
|
-
* 加入一个音视频通话房间(初始化房间对象)
|
|
222
|
-
* 进房代表开始一个音视频通话会话,这时候 SDK 会监听远端用户进房退房情况,若有远端用户进房并且发布流,本地会收到 'stream-added' 事件。
|
|
223
|
-
* 进房后用户可以通过 publish() 发布本地流,本地流发布成功后远端用户就会收到相应 'stream-added' 事件通知从而完成一个双向的音视频通话连接。
|
|
224
|
-
*
|
|
225
|
-
* @param {Object} props room创建所需属性
|
|
226
|
-
* @param {String} props.roomId 房间号
|
|
227
|
-
* @param {Number} props.userId 用户id
|
|
228
|
-
* @param {String} props.host 会议内的请求地址
|
|
229
|
-
* @param {String} props.getProxiesUrl 获取ws请求地址的路径
|
|
230
|
-
* @param {String} props.secret 房间密码
|
|
231
|
-
* @param {Boolean} props.create 是否执行房间的创建, 默认为自适应, 有房间则创建, 没房间则不创建
|
|
232
|
-
* @param {String} props.customToken 用户token
|
|
233
|
-
* @param {Number} props.limit 人数最大值
|
|
234
|
-
* @param {Number} props.brtcAppId
|
|
235
|
-
* @param {String} props.collection 数据上报地址
|
|
236
|
-
* @param {Object} props.userinfo 用户信息
|
|
237
|
-
* @param {Number} props.userinfo.cver 客户端版本
|
|
238
|
-
* @param {String} props.userinfo.nickname 用户昵称
|
|
239
|
-
* @param {String} props.userinfo.avatar 用户头像
|
|
240
|
-
* @param {String} props.userinfo.pos 客户端类型
|
|
241
|
-
* @param {Number} props.types //1:单一模式, 2:混合模式
|
|
242
|
-
* @param {String} props.name //房间名
|
|
243
|
-
* @example
|
|
244
|
-
* {
|
|
245
|
-
room: '111111',//房间号
|
|
246
|
-
host: 'https://v3test.boom.cn',//会议内的请求地址
|
|
247
|
-
getProxiesUrl: '/api/conference/v1/auth/token',//获取ws地址的路径
|
|
248
|
-
secret: '',//房间密码
|
|
249
|
-
types: 1,
|
|
250
|
-
nickname: 'zzy',
|
|
251
|
-
collection: '',//数据上报地址
|
|
252
|
-
token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJsb2dpbiIsImlhdCI6MTY1MDA5ODkwMSwibmJmIjoxNjUwMDk4OTAxLCJqdGkiOiIiLCJzdWIiOjk4NSwicHJ2IjoiODdlN2UxYmVlMjcyMmJmMzk4NjQxN2IzMzUxZTVmMjYzODQwY2ExYyIsImF0dHIiOjAsImJkIjowfQ.b-J9TnmjOzaVUJeY83tY_d1rdu_ELAWx8iH3odBN5kE',//用户token
|
|
253
|
-
userinfo: {
|
|
254
|
-
userId: 985,//用户id
|
|
255
|
-
pos: 'web',
|
|
256
|
-
nickname: 'zzy',//用户昵称
|
|
257
|
-
avatar: '',//用户头像
|
|
258
|
-
}
|
|
259
|
-
}
|
|
260
|
-
*/
|
|
261
|
-
join(props: any): Promise<undefined>;
|
|
262
|
-
/**
|
|
263
|
-
* 离开房间
|
|
264
|
-
* @returns
|
|
265
|
-
*/
|
|
266
|
-
leave(): Promise<void>;
|
|
267
|
-
/**
|
|
268
|
-
* 释放房间,会议结束时调用
|
|
269
|
-
*/
|
|
270
|
-
releaseRoom(): Promise<void>;
|
|
271
|
-
/**
|
|
272
|
-
* 启动录制
|
|
273
|
-
* @param {String} opts.filename - 录制文件名
|
|
274
|
-
* @param {Object} opts.capture - 采集属性
|
|
275
|
-
* @param {Number} opts.capture.width - 宽度
|
|
276
|
-
* @param {Number} opts.capture.height - 高度
|
|
277
|
-
* @param {Number} opts.capture.fps - 帧率
|
|
278
|
-
* @param {Number} opts.capture.source_name - 录制源,窗口的名字
|
|
279
|
-
* @param {Number} opts.capture.isRecord -
|
|
280
|
-
* @param {Number} opts.capture.chromeMediaSourceId - 录制哪个窗口的id
|
|
281
|
-
* @param {Number} opts.record - 编码属性
|
|
282
|
-
* @param {Number} opts.record.bitrate - 编码码率
|
|
283
|
-
* @param {String|undefined} opts.record.format - 编码格式
|
|
284
|
-
*
|
|
285
|
-
* @return {boolean}
|
|
286
|
-
*/
|
|
287
|
-
startRecord(opts: any): Promise<boolean | undefined>;
|
|
288
|
-
/**
|
|
289
|
-
* 停止录制
|
|
290
|
-
*/
|
|
291
|
-
stopRecord(): Promise<void>;
|
|
292
|
-
/**
|
|
293
|
-
* 启用下一个录制分片
|
|
294
|
-
* @param filename - 下一分片文件名
|
|
295
|
-
* @param stream - 录制的流对象
|
|
296
|
-
*/
|
|
297
|
-
sliceRecord(filename: string, stream?: MediaStream, capture?: any): Promise<boolean | undefined>;
|
|
298
|
-
close(): void;
|
|
299
|
-
/**
|
|
300
|
-
* 开关对端摄像头
|
|
301
|
-
* @param status true:开,false:关
|
|
302
|
-
* @param uid 用户id
|
|
303
|
-
*/
|
|
304
|
-
setRemoteVideoEnable(status: boolean, uid: string): Promise<void>;
|
|
305
|
-
/**
|
|
306
|
-
* 开关对端麦克风(现在还不知道怎么实现, 未找到实现逻辑)
|
|
307
|
-
* @param status true:开,false:关
|
|
308
|
-
* @param uid 用户id
|
|
309
|
-
* @param isNotCancelRootReport 当打开麦克风时, 是否不取消音频权限申请
|
|
310
|
-
*/
|
|
311
|
-
setRemoteAudioEnable(status: boolean, uid: string, isNotCancelRootReport: boolean | undefined): Promise<void>;
|
|
312
|
-
/**
|
|
313
|
-
* 开关本地摄像头
|
|
314
|
-
* @param status true:开,false:关
|
|
315
|
-
* @param videoTrack
|
|
316
|
-
*/
|
|
317
|
-
setLocalVideoEnable(status: boolean, videoTrack?: MediaStreamTrack): Promise<void>;
|
|
318
|
-
/**
|
|
319
|
-
* 开关本地麦克风
|
|
320
|
-
* @param status true:开,false:关
|
|
321
|
-
*/
|
|
322
|
-
setLocalAudioEnable(status: boolean): Promise<void>;
|
|
323
|
-
/**
|
|
324
|
-
* 开关本地麦克风
|
|
325
|
-
* @param status true:开,false:关
|
|
326
|
-
*/
|
|
327
|
-
setLocalSpeakerEnable(status: boolean): Promise<void>;
|
|
328
|
-
private _attachEvents;
|
|
329
|
-
/**
|
|
330
|
-
* 创建本地流
|
|
331
|
-
* @param options
|
|
332
|
-
* @param sid
|
|
333
|
-
*/
|
|
334
|
-
createSingleLocalStream(options: {
|
|
335
|
-
video: boolean;
|
|
336
|
-
audio: boolean;
|
|
337
|
-
videoSource?: MediaStreamTrack | undefined;
|
|
338
|
-
audioSource?: MediaStreamTrack | undefined;
|
|
339
|
-
} | undefined, sid: string): Promise<SingleLocalStream>;
|
|
340
|
-
/**
|
|
341
|
-
* 这个方法只是为了生成brtc的流,目的是在用户只打开音频的情况下,然后在打开视频的时候,去创建一个只有视频的track的流
|
|
342
|
-
* @param options
|
|
343
|
-
* @param sid
|
|
344
|
-
* @returns
|
|
345
|
-
*/
|
|
346
|
-
createPBSingleLocalStream(options?: {
|
|
347
|
-
video: boolean;
|
|
348
|
-
audio: boolean;
|
|
349
|
-
}, sid?: string): Promise<import("@hysc/brtc").LocalStream>;
|
|
350
|
-
private handleStreamInit;
|
|
351
|
-
/**
|
|
352
|
-
* 枚举视频输入设备
|
|
353
|
-
*
|
|
354
|
-
* @returns 设备列表
|
|
355
|
-
*/
|
|
356
|
-
enumVideoDevices: () => Promise<Device[]>;
|
|
357
|
-
/**
|
|
358
|
-
* 枚举音频输入设备
|
|
359
|
-
*
|
|
360
|
-
* @returns 设备列表
|
|
361
|
-
*/
|
|
362
|
-
enumAudioInputDevices: () => Promise<Device[]>;
|
|
363
|
-
/**
|
|
364
|
-
* 枚举音频输出设备
|
|
365
|
-
*
|
|
366
|
-
* @returns 设备列表
|
|
367
|
-
*/
|
|
368
|
-
enumAudioOutputDevices: () => Promise<Device[]>;
|
|
369
|
-
/**
|
|
370
|
-
* 检查音视频权限
|
|
371
|
-
*/
|
|
372
|
-
getPermissions: typeof BRTC.getPermissions;
|
|
373
|
-
checkSystemSupport: typeof BRTC.checkSystemSupport;
|
|
374
|
-
createStream: typeof BRTC.createStream;
|
|
375
|
-
participantNotice: boolean;
|
|
376
|
-
/**
|
|
377
|
-
* 订阅远端流
|
|
378
|
-
* 可通过该订阅接口指明需要订阅音频、视频或者音视频流。
|
|
379
|
-
*
|
|
380
|
-
* @param remoteStream 需要订阅的远端流对象,由 ‘participant-published’ 事件获得
|
|
381
|
-
* @param options 订阅选项
|
|
382
|
-
* @returns
|
|
383
|
-
*/
|
|
384
|
-
subscribe(remoteStream: SingleRemoteStream, options?: SubscribeOptions): Promise<any>;
|
|
385
|
-
/**
|
|
386
|
-
* 取消订阅远端流
|
|
387
|
-
*
|
|
388
|
-
* @param remoteStream 需要取消订阅的远端流对象
|
|
389
|
-
* @return
|
|
390
|
-
*/
|
|
391
|
-
unsubscribe(remoteStream: SingleRemoteStream): Promise<any>;
|
|
392
|
-
/**
|
|
393
|
-
* 发布本地音视频流。
|
|
394
|
-
* 该方法需要在 join() 进房后调用,一次音视频会话中只能发布一个本地流。若想发布另外一个本地流,可先通过 unpublish() 取消发布当前本地流后再发布新的本地流。
|
|
395
|
-
* 在发布本地流后,可通过 removeTrack()、addTrack()、 replaceTrack() 来更新本地流中的某个音频或视频流。
|
|
396
|
-
* 发布本地流后远端会收到 ‘participant-published’ 事件通知。
|
|
397
|
-
*
|
|
398
|
-
* @param stream 创建的本地流对象
|
|
399
|
-
* @return
|
|
400
|
-
*/
|
|
401
|
-
publish(stream: SingleLocalStream): Promise<unknown>;
|
|
402
|
-
/**
|
|
403
|
-
* 取消发布本地流。
|
|
404
|
-
* 取消发布本地流后远端会收到 'participant-unpublished' 事件通知。
|
|
405
|
-
* 请在 leave() 退房前取消已经发布的本地流。
|
|
406
|
-
*
|
|
407
|
-
* @param stream 取消发布的本地流对象
|
|
408
|
-
* @return
|
|
409
|
-
*/
|
|
410
|
-
unpublish(stream: SingleLocalStream): Promise<any>;
|
|
411
|
-
/**
|
|
412
|
-
* 获取userList的用户对象
|
|
413
|
-
* @param userId
|
|
414
|
-
*/
|
|
415
|
-
getUser(userId: string): BMUser | undefined;
|
|
416
|
-
/**
|
|
417
|
-
* 改变主持人,只有主持人权限和房间创建者可以改变主持人(房间创建者可以收回主持人)
|
|
418
|
-
* @param userId
|
|
419
|
-
* @param isKeep 是否保留转移人的联席主持人身份
|
|
420
|
-
*/
|
|
421
|
-
changeMaster(userId: string, isKeep?: boolean): Promise<any>;
|
|
422
|
-
/**
|
|
423
|
-
* 改变联席主持人,返回设置为联席主持人的bmuser对象
|
|
424
|
-
* @param userId
|
|
425
|
-
* @param status true:设置成联席主持人 false:取消联席主持人身份
|
|
426
|
-
* @param hasS
|
|
427
|
-
*/
|
|
428
|
-
updateManager(userId: string, status: boolean, hasS?: boolean): Promise<any>;
|
|
429
|
-
/**
|
|
430
|
-
* 获取房间主持人id
|
|
431
|
-
*/
|
|
432
|
-
getMaster(): string;
|
|
433
|
-
/**
|
|
434
|
-
* 获取房间创建者
|
|
435
|
-
*/
|
|
436
|
-
getCreator(): string;
|
|
437
|
-
/**
|
|
438
|
-
* 获取房间名称
|
|
439
|
-
*/
|
|
440
|
-
getName(): string;
|
|
441
|
-
/**
|
|
442
|
-
* 踢出用户
|
|
443
|
-
* @param {String} userId 用户ID
|
|
444
|
-
* @param withoutBlack 是否拉进黑名单 true 可以再进来 false 进不来
|
|
445
|
-
*/
|
|
446
|
-
evictUser(userId: string, withoutBlack: boolean): Promise<any>;
|
|
447
|
-
/**
|
|
448
|
-
* 更新用户信息
|
|
449
|
-
* @param {String} target - 目标用户id
|
|
450
|
-
* @param {String} info - 用户信息或者自定义的字段
|
|
451
|
-
*/
|
|
452
|
-
updateUser(target: string, info: any): Promise<undefined>;
|
|
453
|
-
/**
|
|
454
|
-
* 获取最新消息序列号
|
|
455
|
-
*/
|
|
456
|
-
getMsgSeq(): number;
|
|
457
|
-
/**
|
|
458
|
-
* 获取限制人数
|
|
459
|
-
*/
|
|
460
|
-
getLimits(): number;
|
|
461
|
-
/**
|
|
462
|
-
* 是否允许房间加入成员
|
|
463
|
-
* @return {Boolean}
|
|
464
|
-
*/
|
|
465
|
-
getSwitch(): Boolean;
|
|
466
|
-
/**
|
|
467
|
-
* 更新token
|
|
468
|
-
* @param {String} token
|
|
469
|
-
*/
|
|
470
|
-
/**
|
|
471
|
-
* 同步房间信息,在事件 room-reconnected 触发后调用
|
|
472
|
-
* @return {Promise}
|
|
473
|
-
*/
|
|
474
|
-
syncRoom(): Promise<any>;
|
|
475
|
-
/**
|
|
476
|
-
* 更新房间状态
|
|
477
|
-
* @param {Object} options - 更新房间信息参数
|
|
478
|
-
* @param {Boolean} options.audiooff - 房间是否开启全员静音,可选
|
|
479
|
-
* @param {Boolean} options.selfopenaudio - 房间是否允许成员自行开启语音
|
|
480
|
-
* @param {Boolean} options.videooff - 房间是否开启禁用摄像头,可选
|
|
481
|
-
* @param {Boolean} options.msgoff - 房间是否开启全员禁言,可选
|
|
482
|
-
* @param {Boolean} options.switch - 房间是否开启准入开关,可选
|
|
483
|
-
* @param {Boolean} options.lock - 房间是否锁定
|
|
484
|
-
* @param {Boolean} options.secret - 不为空时表示房间密码,为以`md5(${room}.${secret})`计算所得值为参数
|
|
485
|
-
* @param {Boolean} options.waitroom - 开关等候室 false 关闭
|
|
486
|
-
* @returns {Promise}
|
|
487
|
-
*/
|
|
488
|
-
update(options: any): Promise<any>;
|
|
489
|
-
/**
|
|
490
|
-
* 获取用户列表
|
|
491
|
-
*/
|
|
492
|
-
getUsers(): Map<string, BMUser>;
|
|
493
|
-
/**
|
|
494
|
-
* 获取用户总数
|
|
495
|
-
* @deprecated
|
|
496
|
-
* @return {Number}
|
|
497
|
-
*/
|
|
498
|
-
getTotalUsers(): Number;
|
|
499
|
-
/**
|
|
500
|
-
* 发送消息,缓存至服务器,会生成序列号
|
|
501
|
-
* 端上会收到 new-message 信令
|
|
502
|
-
* @param {String} message - 待发送消息, 必须是 JSON 格式的字符串
|
|
503
|
-
* @param {String|undefined} to - 如果为空,则为广播消息,不为空,则为定向到to用户的私聊消息
|
|
504
|
-
*/
|
|
505
|
-
sendMessage(message: string, to: string | undefined): Promise<any>;
|
|
506
|
-
/**
|
|
507
|
-
* 发送自定义消息 可绕过 W 权限
|
|
508
|
-
* @param {String} message - 待发送消息
|
|
509
|
-
* @param {String|undefined} to - 如果为空,则为广播消息,不为空,则定向到to用户的消息
|
|
510
|
-
* @param {Boolean} analysis - 是否需要服务端解析消息
|
|
511
|
-
*/
|
|
512
|
-
customMessage(message: string, to: string | undefined, analysis?: boolean): Promise<any>;
|
|
513
|
-
/**
|
|
514
|
-
* 获取指定消息列表
|
|
515
|
-
* @param {Number} startSeq - 起始序列号
|
|
516
|
-
* @param {Number} endSeq - 终止序列号
|
|
517
|
-
* @return {Promise<>}
|
|
518
|
-
*/
|
|
519
|
-
getMessages(startSeq: number, endSeq: number): Promise<any>;
|
|
520
|
-
/**
|
|
521
|
-
* 获取本地用户对象
|
|
522
|
-
* @return {BMUser}
|
|
523
|
-
*/
|
|
524
|
-
getLocalParticipant(): BMUser;
|
|
525
|
-
/**
|
|
526
|
-
* 是否开启全员静音
|
|
527
|
-
* @return {Boolean}
|
|
528
|
-
*/
|
|
529
|
-
getAudioOff(): boolean;
|
|
530
|
-
/**
|
|
531
|
-
* 是否允许自行开启语音
|
|
532
|
-
*/
|
|
533
|
-
getSelfOpenAudio(): boolean;
|
|
534
|
-
/**
|
|
535
|
-
* 是否开启全员禁用摄像头
|
|
536
|
-
* @return {Boolean}
|
|
537
|
-
*/
|
|
538
|
-
getVideoOff(): boolean;
|
|
539
|
-
/**
|
|
540
|
-
* 是否开启全员禁言[禁止发送消息]
|
|
541
|
-
* @return {Boolean}
|
|
542
|
-
*/
|
|
543
|
-
getMsgOff(): boolean;
|
|
544
|
-
/**
|
|
545
|
-
* 是否锁定房间
|
|
546
|
-
* @return {Boolean}
|
|
547
|
-
*/
|
|
548
|
-
getLock(): boolean;
|
|
549
|
-
/**
|
|
550
|
-
* 获取房间信息
|
|
551
|
-
* @return {Object}
|
|
552
|
-
*/
|
|
553
|
-
getRoomInfo(): BMRoomInfo;
|
|
554
|
-
/**
|
|
555
|
-
* 设置全员静音
|
|
556
|
-
* @param {Boolean} audiooff - 是否静音
|
|
557
|
-
* @param {Boolean} selfopenaudio - 是否允许自行开启
|
|
558
|
-
* @return {Promise}
|
|
559
|
-
*/
|
|
560
|
-
setAudioOff(audiooff: boolean, selfopenaudio: boolean): Promise<any>;
|
|
561
|
-
/**
|
|
562
|
-
* 更新房间状态
|
|
563
|
-
* @param opts
|
|
564
|
-
*/
|
|
565
|
-
updateRoom(opts: any): Promise<void>;
|
|
566
|
-
/**
|
|
567
|
-
* 设置全员禁用摄像头
|
|
568
|
-
* @param {Boolean} videooff - 是否禁用摄像头
|
|
569
|
-
* @return {Promise}
|
|
570
|
-
*/
|
|
571
|
-
setVideoOff(videooff: boolean): Promise<any>;
|
|
572
|
-
/**
|
|
573
|
-
* 设置全员禁言
|
|
574
|
-
* @param {Boolean} msgoff - 是否禁言
|
|
575
|
-
* @return {Promise}
|
|
576
|
-
*/
|
|
577
|
-
setMsgOff(msgoff: boolean): Promise<any>;
|
|
578
|
-
/**
|
|
579
|
-
* 设置是否允许加入成员
|
|
580
|
-
* @param {Boolean} switch_ - 是否开启
|
|
581
|
-
*/
|
|
582
|
-
setSwitch(switch_: boolean): Promise<void>;
|
|
583
|
-
/**
|
|
584
|
-
* 设置是否锁定房间
|
|
585
|
-
* @param {Boolean} lock - 是否锁定
|
|
586
|
-
*/
|
|
587
|
-
setLock(lock: boolean): Promise<boolean>;
|
|
588
|
-
/**
|
|
589
|
-
* 发送聊天室消息
|
|
590
|
-
* @param msg
|
|
591
|
-
* @param userId
|
|
592
|
-
* @param lostNet
|
|
593
|
-
*/
|
|
594
|
-
sendChatMessage(msg: string, userId: string | undefined, lostNet: boolean): Promise<any>;
|
|
595
|
-
/**
|
|
596
|
-
* 获取聊天室消息
|
|
597
|
-
*/
|
|
598
|
-
getChatMessage(): import("..").BMMessageInfo[];
|
|
599
|
-
/**
|
|
600
|
-
* 获取聊天室历史消息
|
|
601
|
-
*/
|
|
602
|
-
getHistoryMessage(): Promise<import("..").BMMessageInfo[]>;
|
|
603
|
-
/**
|
|
604
|
-
* 更新房间自定义属性状态
|
|
605
|
-
* @param {Object} customStats - 更新自定义房间信息参数
|
|
606
|
-
* @param {Boolean} customStats.layoutMode - 0/1/2, // 默认为0,0:自由模式,可随时切换;1:是使用 defaultLayout,布局内可控;2:是使用 mainLayout,主会场同内容
|
|
607
|
-
* @param {Boolean} replace - 是否替换 当前的对象
|
|
608
|
-
* @returns {Promise}
|
|
609
|
-
*/
|
|
610
|
-
updateCustomStats(customStats: any, replace: boolean): Promise<any>;
|
|
611
|
-
/**
|
|
612
|
-
* 获取自定义属性
|
|
613
|
-
*/
|
|
614
|
-
getCustomStats(): any;
|
|
615
|
-
/**
|
|
616
|
-
* 获取会议时间进度,返回秒数
|
|
617
|
-
*/
|
|
618
|
-
getDuration(): number;
|
|
619
|
-
/**
|
|
620
|
-
* 检测目标用户是否有主持人权限
|
|
621
|
-
*/
|
|
622
|
-
checkUserHasMaster(userId: string): boolean;
|
|
623
|
-
changeNickName(userId: string, nickName: string): Promise<any>;
|
|
624
|
-
/**
|
|
625
|
-
* boom-web-sdk中,会存在缓存的情况
|
|
626
|
-
* 所以可能会出现设置已经不存在的窗口的值,去拉不存在的窗口的流
|
|
627
|
-
* 增加一层逻辑判断去处理该情况
|
|
628
|
-
*/
|
|
629
|
-
streamModelExits(streamModel: BMStreamModel): boolean;
|
|
630
|
-
handleQueueTask: (streamModel: BMStreamModel, noPlayChanged?: boolean) => Promise<void>;
|
|
631
|
-
handleStreamTask(streamModel: BMStreamModel, noPlayChanged?: boolean): Promise<void>;
|
|
632
|
-
/**
|
|
633
|
-
* 处理拉流的逻辑
|
|
634
|
-
* @param streamModel
|
|
635
|
-
*/
|
|
636
|
-
handlePull(streamModel: BMStreamModel): Promise<void>;
|
|
637
|
-
/**
|
|
638
|
-
* 手动订阅流的处理
|
|
639
|
-
*/
|
|
640
|
-
manualSubscribeStreamModel(streamModel: BMStreamModel): void;
|
|
641
|
-
/**
|
|
642
|
-
* 取消订阅流的处理
|
|
643
|
-
* @param streamModel
|
|
644
|
-
*/
|
|
645
|
-
handleUnsubscribe(streamModel: BMStreamModel): void;
|
|
646
|
-
/**
|
|
647
|
-
* 处理streamModel绑定 element 只处理播放逻辑
|
|
648
|
-
* @param sm
|
|
649
|
-
*/
|
|
650
|
-
handleStreamBindElement(sm: BMStreamModel): void;
|
|
651
|
-
/**
|
|
652
|
-
* 处理streamModel 绑定另一个播放器(主要是大窗口), 只处理播放逻辑
|
|
653
|
-
* @param sm
|
|
654
|
-
*/
|
|
655
|
-
handleStreamBindBigElement(sm: BMStreamModel): void;
|
|
656
|
-
handleUnsubscribeStream(streamModel: BMStreamModel): Promise<void>;
|
|
657
|
-
handleSubscribeSteam(streamModel: BMStreamModel): Promise<void>;
|
|
658
|
-
/**
|
|
659
|
-
* 处理大小流切换
|
|
660
|
-
* @param streamModel
|
|
661
|
-
*/
|
|
662
|
-
handleChangeStreamType(streamModel: BMStreamModel): Promise<void>;
|
|
663
|
-
/**
|
|
664
|
-
* 处理播放相关的逻辑
|
|
665
|
-
* @param streamModel
|
|
666
|
-
* @param force
|
|
667
|
-
*/
|
|
668
|
-
handlePlay(streamModel: BMStreamModel, force?: boolean): Promise<void>;
|
|
669
|
-
handlePlaySmall(streamModel: BMStreamModel): void;
|
|
670
|
-
handlePlayInBIg(streamModel: BMStreamModel): void;
|
|
671
|
-
/**
|
|
672
|
-
* 处理brtc订阅这股流失败的处理
|
|
673
|
-
* @param streamModel
|
|
674
|
-
*/
|
|
675
|
-
private handlePulledFailed;
|
|
676
|
-
/**
|
|
677
|
-
* 处理流出现connect-error的逻辑,本地流需要重新推流,远端流需要重新拉流
|
|
678
|
-
* @param event
|
|
679
|
-
*/
|
|
680
|
-
private handleStreamConnectError;
|
|
681
|
-
republishLocalStream: any;
|
|
682
|
-
/**
|
|
683
|
-
* 设置用户禁止/允许发言
|
|
684
|
-
* @param bmUser
|
|
685
|
-
* @param status
|
|
686
|
-
*/
|
|
687
|
-
toggleAudienceSpeaking(bmUser: BMUser, status: boolean): Promise<undefined>;
|
|
688
|
-
/**
|
|
689
|
-
* 更新用户的嘉宾身份 true 设置为嘉宾 false 设置为普通参会者
|
|
690
|
-
* S -> permission
|
|
691
|
-
* 普通参会者缺少S权限,嘉宾有S权限
|
|
692
|
-
* @param user
|
|
693
|
-
* @param status
|
|
694
|
-
*/
|
|
695
|
-
updateUserIsGuest(user: BMUser, status: boolean): Promise<undefined>;
|
|
696
|
-
/**
|
|
697
|
-
* 联席主持人设置嘉宾的操作
|
|
698
|
-
* @param userId
|
|
699
|
-
*/
|
|
700
|
-
managerChangeToGuest(userId: string): void;
|
|
701
|
-
/**
|
|
702
|
-
* 将用户移动到等候室
|
|
703
|
-
* @param target 用户id
|
|
704
|
-
* @param toWait 是否移动到等候室
|
|
705
|
-
* @param autoJoin 是否自动准入
|
|
706
|
-
*/
|
|
707
|
-
moveUserRoom(target: string, toWait?: boolean, autoJoin?: boolean): Promise<any>;
|
|
708
|
-
/**
|
|
709
|
-
* 获取业务端是否开启参会者进入/离开直播通知
|
|
710
|
-
* @param status
|
|
711
|
-
*/
|
|
712
|
-
getParticipantNotice(status: boolean): void;
|
|
713
|
-
/**
|
|
714
|
-
*私有化部署url地址
|
|
715
|
-
* @param url
|
|
716
|
-
*/
|
|
717
|
-
setCustomUrl(url: string): void;
|
|
718
|
-
/**
|
|
719
|
-
* 重推本地流,在收到brtc的code 4001 之后,说明本地掉线了
|
|
720
|
-
* 需要重新推本地流
|
|
721
|
-
*/
|
|
722
|
-
handleRePushSelf(): Promise<void>;
|
|
723
|
-
/**
|
|
724
|
-
* 重拉远端流
|
|
725
|
-
*/
|
|
726
|
-
handleResetOtherStreamStatus(): void;
|
|
727
|
-
/**
|
|
728
|
-
* 处理断网重连之后对流的处理
|
|
729
|
-
* @param pullItems
|
|
730
|
-
*/
|
|
731
|
-
restartPullUsers(pullItems: Map<string, PullItem>): void;
|
|
732
|
-
addUser2Queue(pullItem: PullItem): Promise<void>;
|
|
733
|
-
processUser: (uId: PullItem, failed?: number) => Promise<void>;
|
|
734
|
-
queryBrtcStreams(uids: string[]): Promise<import("@hysc/brtc").RemoteStream[]>;
|
|
735
|
-
handleAddStreams(streams: SingleRemoteStream[]): void;
|
|
736
|
-
getForceUser(forceId: string): Promise<void>;
|
|
737
|
-
queryBloudUsers(uids: string[], forceUpdateSort?: boolean): Promise<void>;
|
|
738
|
-
getVersion(): string;
|
|
739
|
-
}
|
|
740
|
-
export {};
|