@hysc/meeting 4.0.2 → 4.0.3

package/esm/src/BMStream/BMStreamModelVM.d.ts

@@ -1,254 +1,254 @@
-/**
- * @name: BMStreamModelVM
- * @author: yangliye
- * @date: 2022-04-27 15:25
- * @description：BMStreamModelVM
- * @update: 2022-04-27 15:25
- * @description
- * 这个模块的功能是去管理展示窗口的处理逻辑，主要包括创建streamModel，更新streamModel(主要是流相关信息的更新，和用户更新)
- * 创建streamModel的操作：
- *  初始化整个流程是根据bloud的用户来创建的
- *  然后在根据brtc里面流的信息来更新对应的streamModel
- *  bloud的用户和brtc的流信息是根据uid来进行关联。
- *
- * 共享屏幕用户做了特殊处理，因为web端共享屏幕和移动端共享屏幕处理逻辑不一样
- */
-/// <reference types="node" />
-import BMStreamModel, { NoPlayerContainer } from "./BMStreamModel";
-import BMUser from '../BMUser/BMUser';
-import { SingleLocalStream, SingleRemoteStream, SingleStream } from '../type';
-import BMRoom from '../BMRoom/BMRoom';
-import { BehaviorSubject, Subject } from 'rxjs';
-import { Device } from '@hysc/core/esm/BoomAdapter/type/value';
-import BMSpeaker from './BMSpeaker';
-import { ShareMediaOptions } from "@hysc/core/esm/BoomCore/BCClient/BCClient";
-import { getHTMLMediaStreamOptions, Result, getMediaStreamInfo } from "./getHTMLMediaStreamOptions";
-export declare function transShareScreen2User(userId: string): string;
-export declare const pubFailedStreamMap: Map<string, import("@hysc/core/esm/BoomAdapter/singleMode/stream/RemoteStream").default>;
-/**
- * 全量的brtc流记录，把所有brtc用户推的流都做记录
- * stream-added 的时候添加
- * stream-removed 的时候删除
- * mute/unmute-video/audio 的时候更新流
- * 当用户进来的时候，去查看这个流对象，如果流存在，就给这个人添加流
- *
- */
-export declare const BRTCStreamMap: Map<string, import("@hysc/core/esm/BoomAdapter/singleMode/stream/RemoteStream").default>;
-export declare const BRTCShareStreamMap: Map<string, import("@hysc/core/esm/BoomAdapter/singleMode/stream/RemoteStream").default>;
-export default class BMStreamModelVM {
-    streamModels: Map<string, BMStreamModel>;
-    /**
-     * 因为投屏码用户进来以后，他是不在小窗口展示的，所以要把投屏的用户过滤掉给业务的展示
-     */
-    streamModelsWatcher: BehaviorSubject<BMStreamModel[]>;
-    shareStreamModels: Map<string, BMStreamModel>;
-    shareStreamModelsWatcher: BehaviorSubject<BMStreamModel[]>;
-    localStreamErrorWatcher: Subject<string>;
-    localModel: BMStreamModel | null;
-    private room;
-    bloudStream: any;
-    audioStream: SingleLocalStream | undefined;
-    brtcStream: SingleLocalStream | undefined;
-    /**
-     * 本地是否在屏幕共享
-     */
-    localIsShare: boolean;
-    _speaker_enable: boolean;
-    speakerEnableWatcher: BehaviorSubject<boolean>;
-    /**
-     * 混流
-     */
-    mixStreamModelWatcher: BehaviorSubject<BMStreamModel | null>;
-    isShareWatcher: Subject<boolean>;
-    canvasTimer: NodeJS.Timeout | null;
-    /**
-     * 后面打开摄像头存储的流，主要是关闭摄像头的时候得把它清除掉
-     */
-    videoStream: SingleLocalStream | null;
-    private _recorder;
-    private _isRecording;
-    private _slicingRecord;
-    isRecordingWatcher: BehaviorSubject<boolean>;
-    private _speaker;
-    private _speakerDetector;
-    private _speakers;
-    speakerWatcher: BehaviorSubject<BMUser | null>;
-    /**
-     * 窗口没有播放容器的错误处理
-     */
-    noContainerWatcher: Subject<BMStreamModel>;
-    /**
-     * 窗口没有大窗口播放容器的错误处理
-     */
-    noBigContainerWatcher: Subject<BMStreamModel>;
-    constructor();
-    private static filterStreamModels;
-    initWithRoom(room: BMRoom): this;
-    /**
-     * 设置扬声器是否打开
-     * @param enable
-     * @private
-     */
-    private setSpeakerEnable;
-    getStreamModels(): Array<BMStreamModel>;
-    /**
-     * 获取streamModel
-     * @param userId 用户Id
-     * @returns
-     */
-    getStreamModelByUId(userId: string): BMStreamModel | undefined;
-    getShareStreamModelByUId(userId: string): BMStreamModel | undefined;
-    getLocalStreamModel(): BMStreamModel | null;
-    createStreamModel(user: BMUser, stream?: SingleStream): BMStreamModel;
-    addStreamModel(streamModel: BMStreamModel): void;
-    addShareStreamModel(streamModel: BMStreamModel): void;
-    removeStreamModel(streamModel: BMStreamModel): void;
-    removeShareStreamModel(streamModel: BMStreamModel): void;
-    /**`
-     * 通过用户id删除streamModel
-     * @param userId
-     * @returns
-     */
-    removeStreamModelByUId(userId: string): BMStreamModel | undefined;
-    remoteStreamPublished(stream: SingleRemoteStream): void;
-    /**
-     * 有人取消流触发，有人取消流之后brtc底层会把流销毁掉，除了流Id和userId，其他的信息都不稳定能取到
-     * @param stream
-     * @returns
-     */
-    remoteStreamUnpublished(stream: SingleRemoteStream): BMStreamModel | undefined;
-    sortStreamModels(): BMStreamModel[];
-    updateStreamModel(streamModel: BMStreamModel, stream: SingleStream): void;
-    updateShareStreamModel(streamModel: BMStreamModel, stream: SingleStream): void;
-    /**
-     * 开关本地摄像头
-     * @param status true:开,false:关
-     * @param videoTrack 开启美颜之后，需要传递这个参数，携带美颜之后的videoTrack
-     */
-    setLocalVideoEnable(status: boolean, videoTrack?: MediaStreamTrack): Promise<void>;
-    /**
-     * 开关本地麦克风
-     * @param status true:开,false:关
-     */
-    setLocalAudioEnable(status: boolean): Promise<undefined>;
-    /**
-     * 该方法只是在入会的时候，同时开启音频和视频的时候使用，其他时候禁止使用该方法
-     * 切换音频和视频状态请使用 setLocalAudioEnable 和 setLocalVideoEnable
-     * @param audio
-     * @param video
-     */
-    joinWithAudioAndAudio(audio: boolean, video: boolean): Promise<undefined>;
-    /**
-     * 切换扬声器
-     * @param device
-     */
-    changeSpeaker(device: Device): Promise<void>;
-    /**
-     * 设置单个流的扬声器
-     * @param streamModel
-     */
-    changeSingleStreamSpeaker(streamModel: BMStreamModel): Promise<void>;
-    changeAudioInput(device: Device): Promise<void>;
-    changeVideoInput(device: Device): Promise<void>;
-    /**
-     * 是否静音扬声器
-     * @param enable
-     */
-    muteSpeaker(enable: boolean): Promise<undefined>;
-    /**
-     * 创建流并且发布
-     * @param audio 是否发布音频流
-     * @param video 是否发布视频流
-     * @param localModel 本地的streamModel
-     * @param videoTrack
-     * @private
-     */
-    private createStreamAndPublish;
-    muteHandler(type: 'video' | 'audio'): Promise<void>;
-    /**
-     * 更改音视频状态或者取消发布
-     * @param type 更改类型
-     * @param mute 是否取消发布
-     * @param localModel 本地的streamModel
-     * @private
-     */
-    private muteOrUnpublishStream;
-    /**
-     * 是否开启屏幕共享
-     * @param enable
-     * @param opts 开启屏幕共享参数
-     * @param customShare
-     * @param opts.audio 是否开启音频
-     * @param opts.source_name Electron 下窗口名称
-     * @param opts.width 共享屏幕宽度
-     * @param opts.height 共享屏幕高度
-     * @param opts.contentHint 视频的contentHint 可选值： '' | 'motion' | 'detail' | 'text'
-     */
-    toggleShareScreen(enable: boolean, opts: any, customShare?: Result): Promise<unknown>;
-    setShareScreenContentHint(contentHint: '' | 'motion' | 'detail' | 'text'): Promise<void>;
-    /**
-     * 排序变化之后的处理逻辑
-     */
-    updateUserSort: any;
-    updateModelSort: any;
-    handleNoContainer: (info: NoPlayerContainer) => void;
-    /**
-     * 创建canvas，目的是为了捕获空track流，给brtc使用
-     */
-    createCanvas(): void;
-    private canvasDisplay;
-    private static getCanvasStream;
-    private createVideoStream;
-    /**
-     * 启动录制
-     * @param {String} opts.filename - 录制文件名
-     * @param {Object} opts.capture - 采集属性
-     * @param {Number} opts.capture.width - 宽度
-     * @param {Number} opts.capture.height - 高度
-     * @param {Number} opts.capture.fps - 帧率
-     * @param {Number} opts.record - 编码属性
-     * @param {Number} opts.record.bitrate - 编码码率
-     * @param {String|undefined} opts.record.format - 编码格式
-     * @return {boolean}
-     */
-    startRecord(opts: any): Promise<boolean | undefined>;
-    /**
-     * 添加流对象到录制器，用于音频轨道录制
-     * @param stream
-     */
-    addToRecorder(stream: any): void;
-    /**
-     * 从录制器中删除流对象
-     * @param stream
-     */
-    removeFromRecorder(stream: any): void;
-    /**
-     * 停止录制
-     */
-    stopRecord(): Promise<void>;
-    /**
-     * 启用下一个录制分片
-     * @param filename - 下一分片文件名
-     */
-    sliceRecord(filename: string): Promise<boolean | undefined>;
-    /**
-     * 启动说话人检测器
-     */
-    startSpeakerDetector(): void;
-    addToDetector(speaker: BMSpeaker): void;
-    removeFromDetector(speakerId: string): void;
-    shareCustomMedia(enable: boolean, shareOptions: ShareMediaOptions): Promise<undefined>;
-    /**
-     * 根据videoElement 获取内部流数据
-     */
-    getHTMLMediaStream: typeof getHTMLMediaStreamOptions;
-    getMediaStream: typeof getMediaStreamInfo;
-    /**
-     * brtc断网重连之后，不知道在断网期间有那些用户取消了推流，
-     * 然后如果是brtc的ws没重连上，然后自己走的重新入会重连的话，就会导致
-     * 可能存在本地的流有一部分可能是不存在的流了，这个方法就是在重连入会之后
-     * 把所有远端流清空
-     */
-    resetAllRemoteStream(): void;
-    clearCache(): void;
-}
+/**
+ * @name: BMStreamModelVM
+ * @author: yangliye
+ * @date: 2022-04-27 15:25
+ * @description：BMStreamModelVM
+ * @update: 2022-04-27 15:25
+ * @description
+ * 这个模块的功能是去管理展示窗口的处理逻辑，主要包括创建streamModel，更新streamModel(主要是流相关信息的更新，和用户更新)
+ * 创建streamModel的操作：
+ *  初始化整个流程是根据bloud的用户来创建的
+ *  然后在根据brtc里面流的信息来更新对应的streamModel
+ *  bloud的用户和brtc的流信息是根据uid来进行关联。
+ *
+ * 共享屏幕用户做了特殊处理，因为web端共享屏幕和移动端共享屏幕处理逻辑不一样
+ */
+/// <reference types="node" />
+import BMStreamModel, { NoPlayerContainer } from "./BMStreamModel";
+import BMUser from '../BMUser/BMUser';
+import { SingleLocalStream, SingleRemoteStream, SingleStream } from '../type';
+import BMRoom from '../BMRoom/BMRoom';
+import { BehaviorSubject, Subject } from 'rxjs';
+import { Device } from '@hysc/core/esm/BoomAdapter/type/value';
+import BMSpeaker from './BMSpeaker';
+import { ShareMediaOptions } from "@hysc/core/esm/BoomCore/BCClient/BCClient";
+import { getHTMLMediaStreamOptions, Result, getMediaStreamInfo } from "./getHTMLMediaStreamOptions";
+export declare function transShareScreen2User(userId: string): string;
+export declare const pubFailedStreamMap: Map<string, import("@hysc/core/esm/BoomAdapter/singleMode/stream/RemoteStream").default>;
+/**
+ * 全量的brtc流记录，把所有brtc用户推的流都做记录
+ * stream-added 的时候添加
+ * stream-removed 的时候删除
+ * mute/unmute-video/audio 的时候更新流
+ * 当用户进来的时候，去查看这个流对象，如果流存在，就给这个人添加流
+ *
+ */
+export declare const BRTCStreamMap: Map<string, import("@hysc/core/esm/BoomAdapter/singleMode/stream/RemoteStream").default>;
+export declare const BRTCShareStreamMap: Map<string, import("@hysc/core/esm/BoomAdapter/singleMode/stream/RemoteStream").default>;
+export default class BMStreamModelVM {
+    streamModels: Map<string, BMStreamModel>;
+    /**
+     * 因为投屏码用户进来以后，他是不在小窗口展示的，所以要把投屏的用户过滤掉给业务的展示
+     */
+    streamModelsWatcher: BehaviorSubject<BMStreamModel[]>;
+    shareStreamModels: Map<string, BMStreamModel>;
+    shareStreamModelsWatcher: BehaviorSubject<BMStreamModel[]>;
+    localStreamErrorWatcher: Subject<string>;
+    localModel: BMStreamModel | null;
+    private room;
+    bloudStream: any;
+    audioStream: SingleLocalStream | undefined;
+    brtcStream: SingleLocalStream | undefined;
+    /**
+     * 本地是否在屏幕共享
+     */
+    localIsShare: boolean;
+    _speaker_enable: boolean;
+    speakerEnableWatcher: BehaviorSubject<boolean>;
+    /**
+     * 混流
+     */
+    mixStreamModelWatcher: BehaviorSubject<BMStreamModel | null>;
+    isShareWatcher: Subject<boolean>;
+    canvasTimer: NodeJS.Timeout | null;
+    /**
+     * 后面打开摄像头存储的流，主要是关闭摄像头的时候得把它清除掉
+     */
+    videoStream: SingleLocalStream | null;
+    private _recorder;
+    private _isRecording;
+    private _slicingRecord;
+    isRecordingWatcher: BehaviorSubject<boolean>;
+    private _speaker;
+    private _speakerDetector;
+    private _speakers;
+    speakerWatcher: BehaviorSubject<BMUser | null>;
+    /**
+     * 窗口没有播放容器的错误处理
+     */
+    noContainerWatcher: Subject<BMStreamModel>;
+    /**
+     * 窗口没有大窗口播放容器的错误处理
+     */
+    noBigContainerWatcher: Subject<BMStreamModel>;
+    constructor();
+    private static filterStreamModels;
+    initWithRoom(room: BMRoom): this;
+    /**
+     * 设置扬声器是否打开
+     * @param enable
+     * @private
+     */
+    private setSpeakerEnable;
+    getStreamModels(): Array<BMStreamModel>;
+    /**
+     * 获取streamModel
+     * @param userId 用户Id
+     * @returns
+     */
+    getStreamModelByUId(userId: string): BMStreamModel | undefined;
+    getShareStreamModelByUId(userId: string): BMStreamModel | undefined;
+    getLocalStreamModel(): BMStreamModel | null;
+    createStreamModel(user: BMUser, stream?: SingleStream): BMStreamModel;
+    addStreamModel(streamModel: BMStreamModel): void;
+    addShareStreamModel(streamModel: BMStreamModel): void;
+    removeStreamModel(streamModel: BMStreamModel): void;
+    removeShareStreamModel(streamModel: BMStreamModel): void;
+    /**`
+     * 通过用户id删除streamModel
+     * @param userId
+     * @returns
+     */
+    removeStreamModelByUId(userId: string): BMStreamModel | undefined;
+    remoteStreamPublished(stream: SingleRemoteStream): void;
+    /**
+     * 有人取消流触发，有人取消流之后brtc底层会把流销毁掉，除了流Id和userId，其他的信息都不稳定能取到
+     * @param stream
+     * @returns
+     */
+    remoteStreamUnpublished(stream: SingleRemoteStream): BMStreamModel | undefined;
+    sortStreamModels(): BMStreamModel[];
+    updateStreamModel(streamModel: BMStreamModel, stream: SingleStream): void;
+    updateShareStreamModel(streamModel: BMStreamModel, stream: SingleStream): void;
+    /**
+     * 开关本地摄像头
+     * @param status true:开,false:关
+     * @param videoTrack 开启美颜之后，需要传递这个参数，携带美颜之后的videoTrack
+     */
+    setLocalVideoEnable(status: boolean, videoTrack?: MediaStreamTrack): Promise<void>;
+    /**
+     * 开关本地麦克风
+     * @param status true:开,false:关
+     */
+    setLocalAudioEnable(status: boolean): Promise<undefined>;
+    /**
+     * 该方法只是在入会的时候，同时开启音频和视频的时候使用，其他时候禁止使用该方法
+     * 切换音频和视频状态请使用 setLocalAudioEnable 和 setLocalVideoEnable
+     * @param audio
+     * @param video
+     */
+    joinWithAudioAndAudio(audio: boolean, video: boolean): Promise<undefined>;
+    /**
+     * 切换扬声器
+     * @param device
+     */
+    changeSpeaker(device: Device): Promise<void>;
+    /**
+     * 设置单个流的扬声器
+     * @param streamModel
+     */
+    changeSingleStreamSpeaker(streamModel: BMStreamModel): Promise<void>;
+    changeAudioInput(device: Device): Promise<void>;
+    changeVideoInput(device: Device): Promise<void>;
+    /**
+     * 是否静音扬声器
+     * @param enable
+     */
+    muteSpeaker(enable: boolean): Promise<undefined>;
+    /**
+     * 创建流并且发布
+     * @param audio 是否发布音频流
+     * @param video 是否发布视频流
+     * @param localModel 本地的streamModel
+     * @param videoTrack
+     * @private
+     */
+    private createStreamAndPublish;
+    muteHandler(type: 'video' | 'audio'): Promise<void>;
+    /**
+     * 更改音视频状态或者取消发布
+     * @param type 更改类型
+     * @param mute 是否取消发布
+     * @param localModel 本地的streamModel
+     * @private
+     */
+    private muteOrUnpublishStream;
+    /**
+     * 是否开启屏幕共享
+     * @param enable
+     * @param opts 开启屏幕共享参数
+     * @param customShare
+     * @param opts.audio 是否开启音频
+     * @param opts.source_name Electron 下窗口名称
+     * @param opts.width 共享屏幕宽度
+     * @param opts.height 共享屏幕高度
+     * @param opts.contentHint 视频的contentHint 可选值： '' | 'motion' | 'detail' | 'text'
+     */
+    toggleShareScreen(enable: boolean, opts: any, customShare?: Result): Promise<boolean>;
+    setShareScreenContentHint(contentHint: '' | 'motion' | 'detail' | 'text'): Promise<void>;
+    /**
+     * 排序变化之后的处理逻辑
+     */
+    updateUserSort: import("lodash-es").DebouncedFunc<() => void>;
+    updateModelSort: import("lodash-es").DebouncedFunc<() => void>;
+    handleNoContainer: (info: NoPlayerContainer) => void;
+    /**
+     * 创建canvas，目的是为了捕获空track流，给brtc使用
+     */
+    createCanvas(): void;
+    private canvasDisplay;
+    private static getCanvasStream;
+    private createVideoStream;
+    /**
+     * 启动录制
+     * @param {String} opts.filename - 录制文件名
+     * @param {Object} opts.capture - 采集属性
+     * @param {Number} opts.capture.width - 宽度
+     * @param {Number} opts.capture.height - 高度
+     * @param {Number} opts.capture.fps - 帧率
+     * @param {Number} opts.record - 编码属性
+     * @param {Number} opts.record.bitrate - 编码码率
+     * @param {String|undefined} opts.record.format - 编码格式
+     * @return {boolean}
+     */
+    startRecord(opts: any): Promise<boolean | undefined>;
+    /**
+     * 添加流对象到录制器，用于音频轨道录制
+     * @param stream
+     */
+    addToRecorder(stream: any): void;
+    /**
+     * 从录制器中删除流对象
+     * @param stream
+     */
+    removeFromRecorder(stream: any): void;
+    /**
+     * 停止录制
+     */
+    stopRecord(): Promise<void>;
+    /**
+     * 启用下一个录制分片
+     * @param filename - 下一分片文件名
+     */
+    sliceRecord(filename: string): Promise<boolean | undefined>;
+    /**
+     * 启动说话人检测器
+     */
+    startSpeakerDetector(): void;
+    addToDetector(speaker: BMSpeaker): void;
+    removeFromDetector(speakerId: string): void;
+    shareCustomMedia(enable: boolean, shareOptions: ShareMediaOptions): Promise<undefined>;
+    /**
+     * 根据videoElement 获取内部流数据
+     */
+    getHTMLMediaStream: typeof getHTMLMediaStreamOptions;
+    getMediaStream: typeof getMediaStreamInfo;
+    /**
+     * brtc断网重连之后，不知道在断网期间有那些用户取消了推流，
+     * 然后如果是brtc的ws没重连上，然后自己走的重新入会重连的话，就会导致
+     * 可能存在本地的流有一部分可能是不存在的流了，这个方法就是在重连入会之后
+     * 把所有远端流清空
+     */
+    resetAllRemoteStream(): void;
+    clearCache(): void;
+}