@hysc/meeting 10.5.6 → 10.5.8

package/umd/src/BMStream/BMStreamModel.d.ts

@@ -0,0 +1,311 @@
+import { SingleStream } from "../type";
+import { SubscribeOptions } from "@hysc/brtc";
+import BMUser from "../BMUser/BMUser";
+import { BehaviorSubject, Subject } from "rxjs";
+import { Player } from "@hysc/core";
+import BMStreamModelVM from "./BMStreamModelVM";
+import { BloudStreamState } from "../handleEvent/attachEvents";
+import type { StreamCustomInfo } from '@hysc/bloud';
+/**
+ * @name: BMStreamModel
+ * @author: yangliye
+ * @date: 2022-04-25 11:14
+ * @description：BMStreamModel
+ * @update: 2022-04-25 11:14
+ */
+declare type StreamType = 'big' | 'small';
+export interface SubscribeMessage {
+    stream: BMStreamModel;
+}
+export interface ConnectErrorMessage {
+    stream: BMStreamModel;
+    isLocal: boolean;
+}
+export interface NoPlayerContainer {
+    type: 'share' | 'normal';
+    container: 'small' | 'big';
+    id: string;
+}
+export interface StreamPlayMessage {
+    uid: string;
+}
+/**
+ * 播放器状态
+ */
+declare enum PlayerState {
+    NO_CONTAINER = 0,
+    NO_PLAYING = 1,
+    PLAYING = 2
+}
+export default class BMStreamModel {
+    private user;
+    private _stream;
+    bloudStream: BloudStreamState | undefined;
+    /**
+     * 流类型
+     */
+    streamType: number;
+    pullFailedNum: number;
+    _video_enable: boolean;
+    _audio_enable: boolean;
+    videoEnableWatcher: BehaviorSubject<boolean>;
+    audioEnableWatcher: BehaviorSubject<boolean>;
+    streamUpdateWatcher: Subject<boolean>;
+    isSubScribedWatcher: Subject<boolean>;
+    playStateChangeWatcher: Subject<BMStreamModel>;
+    /**
+     * 找不到播放器，说明当前的streamModel可能是销毁重建的，或者是业务上绑定失败的，这个时候给端上一个提示，让他重新绑定一下播放器
+     */
+    noContainerWatcher: Subject<boolean>;
+    noBigContainerWatcher: Subject<boolean>;
+    audioLevelWatcher: Subject<number>;
+    isCurrentDisplay: boolean;
+    /**
+     * 当前窗口是不是在展示中目标状态
+     */
+    isDisplay: boolean;
+    isDisplayObserve: Subject<boolean>;
+    isInBig: boolean;
+    isInBigObserve: Subject<boolean>;
+    _hasPulled: boolean;
+    playerId: string;
+    /**
+     * 手动拉流配置, 默认是false, 如果是走手动拉流，设置成true，说明拉他的流
+     * shouldPull 是否应该拉
+     */
+    shouldPull: boolean;
+    smallPlayFailed: number;
+    get hasPulled(): boolean;
+    set hasPulled(value: boolean);
+    /**
+     * 当前拉取的是大流还是小流
+     */
+    _pulledStreamType: StreamType;
+    get pulledStreamType(): StreamType;
+    set pulledStreamType(type: StreamType);
+    /**
+     * 要拉取的流的目标状态
+     */
+    pulledStreamGoal: StreamType;
+    bigPlayerId: string;
+    player: Player | undefined | null;
+    isPlayingBig: boolean;
+    /**
+     * 是否静音了扬声器，brtc不会处理业务上静音的逻辑，所以需要自己处理
+     * 如果静音了，就把所有的流都重新静音播放一遍
+     */
+    muted: boolean;
+    private checkVideoTimer;
+    checkCount: number;
+    /**
+     * streamModel的唯一标识，用来给业务绑定播放容器
+     */
+    get uuid(): string;
+    get isAudience(): boolean;
+    /**
+     * 因为直播模式中，观众是不展示的
+     * 所以这个地方要判断一下
+     */
+    get canShow(): boolean;
+    changeMute(mute: boolean): void;
+    handleSpeakerChange(): void;
+    /**
+     * 排序数字
+     * 窗口的排序使用二进制运算进行了优化，为了提高运行速度牺牲了一部分代码可读性
+     */
+    sortNum: number;
+    isWhiteboard: boolean;
+    get isToupingma(): boolean;
+    get isMixer(): boolean;
+    get isSignal(): boolean;
+    /**
+     * 初始化展示的model
+     * @param user
+     * @param stream
+     */
+    constructor(user: BMUser, stream?: SingleStream, isWhiteboard?: boolean);
+    /**
+     * 生成订阅信息
+     */
+    genReceiveSubMsg(): SubscribeOptions;
+    /**
+     * display属性改变调整
+     * @private
+     */
+    private handleDisplayChange;
+    /**
+     * 处理当前窗口是不是在大窗的逻辑
+     * @param display
+     * @private
+     */
+    private handleIsInBig;
+    /**
+     * 设置是否打开摄像头状态
+     * @param enable
+     * @private
+     */
+    setVideoEnable(enable: boolean): void;
+    /**
+     * 设置是否打开麦克风状态
+     * @param enable
+     * @private
+     */
+    setAudioEnable(enable: boolean): void;
+    /**
+     * 更新当前streamModel中的流
+     * @param stream
+     * @param needReProcess
+     * @param bmStreamVm
+     */
+    updateStream(stream: SingleStream | undefined, needReProcess: boolean | undefined, bmStreamVm: BMStreamModelVM): void;
+    /**
+     * 更新bloud的stream，设置流状态
+     * @param streamState
+     * @param bmStreamVM
+     * @param forceSearch
+     */
+    updateBloudStream(streamState: BloudStreamState | undefined, bmStreamVM: BMStreamModelVM, forceSearch?: boolean): void;
+    updateBloudCustomInfo(customInfo: StreamCustomInfo): void;
+    private onPlayerStateChange;
+    handleStreamConnectError: () => void;
+    /**
+     * 获取当前的streamId
+     */
+    get streamId(): string;
+    get bStreamId(): string;
+    /**
+     * 获取当前窗口绑定的用户id
+     */
+    get userId(): string;
+    /**
+     * 获取当前的流对象
+     */
+    get stream(): SingleStream | undefined;
+    /**
+     * 是否是本地流
+     */
+    get isLocal(): boolean;
+    /**
+     * 是否是屏幕共享的流
+     */
+    get isShare(): boolean;
+    get isWeb(): boolean;
+    get isMobile(): boolean;
+    /**
+     * 当前音频是否开启
+     */
+    get audioEnable(): boolean;
+    /**
+     * 当前视频是否开启
+     */
+    get videoEnable(): boolean;
+    private get brtcPlayerId();
+    private get selfPlayerId();
+    /**
+     * 获取当前流绑定的用户昵称
+     */
+    get nickname(): string;
+    /**
+     * 获取流的麦克风音量
+     */
+    get audioLevel(): number;
+    getUser(): BMUser;
+    /**
+     * 设置远端流的播放声音
+     * @param volume
+     */
+    setRemoteAudioLevel(volume: number): void;
+    /**
+     * 获取流的传输信息
+     */
+    getStats(): Promise<import("@hysc/brtc").RemoteStreamStats> | Promise<import("@hysc/brtc").LocalStreamStats> | undefined;
+    /**
+     * BIND_ELEMENT 事件
+     * @param eleId
+     */
+    bindElement: (eleId: string) => void;
+    bindBigElement: (eleId: string) => void;
+    sendMessage2Room: any;
+    emitBindElement: any;
+    emitBindBigElement: any;
+    /**
+     * 当前是不是正在播放
+     * @param containerId sdk绑定播放器容器id
+     * @param small
+     */
+    currentIsPlaying: (containerId: string, small?: boolean) => PlayerState;
+    /**
+     * 播放当前流
+     */
+    play: (force?: boolean) => Promise<void>;
+    /**
+     * 在大窗口播放该流的时候调用这个方法
+     */
+    playInBig: (force?: boolean) => Promise<void>;
+    private initBigPlayer;
+    /**
+     * 停止播放当前流
+     */
+    stop(): void;
+    /**
+     * 销毁当前流
+     */
+    destroyBrtcStream(): void;
+    /**
+     * 获取当前流是否正在播放
+     */
+    isPlaying(): boolean | undefined;
+    /**
+     * 重新播放
+     */
+    replay(): Promise<void> | undefined;
+    /**
+     * 恢复播放音视频
+     * 在某些版本浏览器上移动传入 play() 的 div 容器可能会导致音视频播放器进入 ‘PAUSED’ 状态，此时 需要调用该接口恢复播放。
+     * 由于浏览器自动播放策略的限制，在 play() 返回 PLAY_NOT_ALLOWED 错误后需要引导用户通过手势 调用该接口恢复播放
+     *
+     * @returns
+     */
+    resume(): void;
+    /**
+     * 是否有音频流
+     */
+    hasAudio(): boolean;
+    /**
+     * 是否有视频流
+     */
+    hasVideo(): boolean;
+    /**
+     * 更新当前model的用户信息
+     * @param user
+     */
+    updateUser(user: BMUser): void;
+    updateSortNum(force?: boolean): void;
+    setSortNum(sortNum: number, force: boolean): void;
+    getSortNum(): number;
+    /**
+   * 启动音频音量检测
+   */
+    collectAudioLevel: () => void;
+    private handleAudioLevel;
+    checkSmallVideo: () => Promise<void>;
+    checkBigVideo: any;
+    /**
+     * 播放黑窗处理，主要是做一个容错处理，又可能这股流拉下来或者存在订阅就出现问题的情况
+     * 播放时黑窗的，这个时候需要，检测，然后重新拉流
+     * @param videoContainer
+     */
+    private checkVideoDecodeFrame;
+    /**
+     * 发送订阅该流的请求
+     */
+    subscribeStream(): void;
+    unSubscribeStream(): void;
+    checkStreamIsPlaying: any;
+    /**
+     * 取消流的播放
+     * @param type big: 大窗口 small: 小窗口 all: 全部
+     */
+    unAttach(type: 'big' | 'small' | 'all'): void;
+}
+export {};

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

@@ -0,0 +1,281 @@
+/**
+ * @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, StreamPlayMessage } from "./BMStreamModel";
+import BMUser from "../BMUser/BMUser";
+import { SingleLocalStream, SingleRemoteStream, SingleStream } from "../type";
+import BMRoom from "../BMRoom/BMRoom";
+import { BehaviorSubject, Subject } from "rxjs";
+import { BoomError } from "@hysc/utils";
+import type { Device, LocalStream } from "@hysc/brtc";
+import BMSpeaker from "./BMSpeaker";
+import { ShareMediaOptions } from "@hysc/core";
+import { getHTMLMediaStreamOptions, getMediaStreamInfo, Result } from "./getHTMLMediaStreamOptions";
+import type { StreamCustomInfo, BloudStream } from '@hysc/bloud';
+import { BloudStreamEventState } from "../handleEvent/attachEvents";
+export declare function transShareScreen2User(userId: string): string;
+export default class BMStreamModelVM {
+    streamModels: Map<string, BMStreamModel>;
+    /**
+     * 因为投屏码用户进来以后，他是不在小窗口展示的，所以要把投屏的用户过滤掉给业务的展示
+     */
+    streamModelsWatcher: BehaviorSubject<BMStreamModel[]>;
+    shareStreamModels: Map<string, BMStreamModel>;
+    shareStreamModelsWatcher: BehaviorSubject<BMStreamModel[]>;
+    localStreamErrorWatcher: Subject<string>;
+    localModel: BMStreamModel | null;
+    room: BMRoom | null;
+    bloudStream: BloudStream | null;
+    /** 白板窗口 */
+    whiteboard: BMStreamModel | null;
+    whiteboardWatcher: BehaviorSubject<BMStreamModel | null>;
+    /**
+     * brtc  stream对象
+     */
+    brtcStream: SingleLocalStream | null;
+    /**
+     * 后面打开摄像头存储的流，主要是关闭摄像头的时候得把它清除掉
+     */
+    videoStream: SingleLocalStream | null;
+    audioStream: SingleLocalStream | null;
+    /**
+     * 本地是否在屏幕共享
+     */
+    localIsShare: boolean;
+    isShareWatcher: Subject<boolean>;
+    localShareCustomStats: any;
+    _speaker_enable: boolean;
+    speakerEnableWatcher: BehaviorSubject<boolean>;
+    /**
+     * 混流
+     */
+    mixStreamUid: string | null;
+    get mixStreamModel(): BMStreamModel | null | undefined;
+    mixStreamModelWatcher: BehaviorSubject<BMStreamModel | null>;
+    canvasTimer: NodeJS.Timeout | null;
+    private _recorder;
+    private _isRecording;
+    private _slicingRecord;
+    isRecordingWatcher: BehaviorSubject<boolean>;
+    private _speaker;
+    private _speakerDetector;
+    private _speakers;
+    speakerWatcher: BehaviorSubject<BMUser | null>;
+    private rtcPublishing;
+    /**
+     * 窗口没有播放容器的错误处理
+     */
+    noContainerWatcher: Subject<BMStreamModel>;
+    /**
+     * 窗口没有大窗口播放容器的错误处理
+     */
+    noBigContainerWatcher: Subject<BMStreamModel>;
+    localStreamConnectErrorWatcher: Subject<BoomError>;
+    /**
+     * 共享屏幕相关错误
+     * 包括，共享客户端错误
+     * 共享屏幕流错误
+     */
+    localShareError: Subject<BoomError>;
+    localShareEndedError: Subject<boolean>;
+    /**
+     * 共享屏幕流是单独处理的逻辑，不是先创建streamModel然后在去查流，而是先去查流，在创建streamModel
+     */
+    shareBloudStateMap: Map<string, BloudStreamEventState>;
+    /**
+     * 窗口播放事件，给到端上去做埋点
+     */
+    streamPlayWatcher: Subject<StreamPlayMessage>;
+    private muteHandlerVideo;
+    private muteHandlerAudio;
+    constructor();
+    private static filterStreamModels;
+    handleStreamPlay: (info: StreamPlayMessage) => void;
+    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;
+    createWhiteBoard(userId: string): BMStreamModel | undefined;
+    removeWhiteBoard(): void;
+    createStreamModel(user: BMUser, stream?: SingleStream): BMStreamModel;
+    addStreamModel(streamModel: BMStreamModel): void;
+    addShareStreamModel(streamModel: BMStreamModel): void;
+    removeStreamModel(streamModel: BMStreamModel): void;
+    removeShareStreamModelByUId(uid: string): 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<undefined>;
+    /**
+     * brtc流更新状态失败，这个时候重新推流
+     */
+    handleStreamUpdateFailed(): Promise<void>;
+    /**
+     * 开关本地麦克风
+     * @param status true:开,false:关
+     */
+    setLocalAudioEnable(status: boolean): Promise<undefined>;
+    /**
+     * 该方法只是在入会的时候，同时开启音频和视频的时候使用，其他时候禁止使用该方法
+     * 切换音频和视频状态请使用 setLocalAudioEnable 和 setLocalVideoEnable
+     * @param audio
+     * @param video
+     */
+    joinWithAudioAndAudio(audio: boolean, video: boolean): Promise<boolean | undefined>;
+    /**
+     * 切换扬声器
+     * @param device
+     * @param force 是否需要强制更新
+     */
+    changeSpeaker(device: Device, force?: boolean): Promise<void>;
+    /**
+     * 设置单个流的扬声器
+     * @param streamModel
+     */
+    changeSingleStreamSpeaker(streamModel: BMStreamModel): Promise<void>;
+    changeAudioInput(device: Device): Promise<boolean | undefined>;
+    changeVideoInput(device: Device): Promise<boolean | undefined>;
+    /**
+     * 是否静音扬声器
+     * @param enable
+     */
+    muteSpeaker(enable: boolean): Promise<undefined>;
+    /**
+     * 创建本地音频流
+     */
+    createLocalAudioStream(): Promise<LocalStream | null>;
+    onlyBrtcPublish(): Promise<boolean>;
+    /**
+     * 创建流并且发布
+     * @param audio 是否发布音频流
+     * @param video 是否发布视频流
+     * @param localModel 本地的streamModel
+     * @param videoTrack
+     * @private
+     */
+    private createStreamAndPublish;
+    brtcStreamAddEvent(): void;
+    brtcStreamRemoveEvent(): void;
+    publishBloudStream(audio: boolean, video: boolean): Promise<void>;
+    muteHandler(type: 'video' | 'audio'): void;
+    unpublishStream(isUnpubRTC?: boolean): Promise<void>;
+    /**
+     * 更改音视频状态或者取消发布
+     * @param type 更改类型
+     * @param mute 是否取消发布
+     * @param localModel 本地的streamModel
+     * @private
+     */
+    private muteOrUnpublishStream;
+    private justReplaceVideoTrack;
+    toggleShareScreen(enable: boolean, opts?: any, customShare?: Result): Promise<boolean>;
+    setShareScreenContentHint(contentHint: '' | 'motion' | 'detail' | 'text'): void;
+    updateModelSort: any;
+    handleNoContainer: (info: NoPlayerContainer) => void;
+    /**
+     * 创建canvas，目的是为了捕获空track流，给brtc使用
+     */
+    createCanvas(): void;
+    private canvasDisplay;
+    private static getCanvasStream;
+    private createVideoStreamTrack;
+    /**
+     * 启动录制
+     * @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: SingleStream): void;
+    /**
+     * 从录制器中删除流对象
+     * @param stream
+     */
+    removeFromRecorder(stream: any): void;
+    /**
+     * 停止录制
+     */
+    stopRecord(): Promise<void>;
+    /**
+     * 启用下一个录制分片
+     * @param filename - 下一分片文件名
+     */
+    sliceRecord(filename: string, stream?: MediaStream, capture?: any): Promise<boolean | undefined>;
+    /**
+     * 启动说话人检测器
+     */
+    startSpeakerDetector(): void;
+    addToDetector(speaker: BMSpeaker): void;
+    removeFromDetector(speakerId: string): void;
+    clearDetector(): void;
+    shareCustomMedia(enable: boolean, shareOptions: ShareMediaOptions): Promise<undefined>;
+    /**
+     * 根据videoElement 获取内部流数据
+     */
+    getHTMLMediaStream: typeof getHTMLMediaStreamOptions;
+    getMediaStream: typeof getMediaStreamInfo;
+    /**
+     * 更新流信息 会给服务端发送updateStream信令，会收到updateStream的广播
+     */
+    updateBloudStreamCustomStats(uid: string, streamId: string, streamInfo: StreamCustomInfo): Promise<void>;
+    /**
+     * 布局发生变化之后去调用一下这个方法去检测所有流的播放状态
+     * @param {string} status tag 用于区分是什么状态下调用的
+     */
+    checkStreamStats(status: string): void;
+    clearCache(): void;
+}

package/umd/src/BMStream/getHTMLMediaStreamOptions.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @name: getHTMLMediaStreamOptions
+ * @author: yangliye
+ * @date: 2022-09-15 14:58
+ * @description：getHTMLMediaStreamOptions
+ * @update: 2022-09-15 14:58
+ */
+interface Options {
+    videoElement: HTMLVideoElement;
+}
+export interface Result {
+    video: boolean;
+    audio: boolean;
+    videoSource: MediaStreamTrack;
+    audioSource: MediaStreamTrack;
+    width: number;
+    height: number;
+}
+/**
+ * 获取video标签中的mediaStream
+ * @param opts
+ */
+export declare function getHTMLMediaStreamOptions(opts: Options): Result | null;
+export declare function getMediaStreamInfo(mediaStream: MediaStream, videoInfo: {
+    width: number;
+    height: number;
+}): {
+    video: boolean;
+    audio: boolean;
+    videoSource: MediaStreamTrack;
+    audioSource: MediaStreamTrack;
+    width: number;
+    height: number;
+} | null;
+export {};

package/umd/src/BMStream/sortStream.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @name: sortStream
+ * @author: yangliye
+ * @date: 2023-04-18 11:40
+ * @description：sortStream
+ * @update: 2023-04-18 11:40
+ */
+export declare function getMasterSort(a: boolean, v: boolean): number;
+/**
+ * 12 - 15
+ */
+export declare function getLocalSort(a: boolean, v: boolean): number;
+/**
+ * 8 - 11
+ * @param a
+ * @param v
+ */
+export declare function getManagerSort(a: boolean, v: boolean): number;
+/**
+ * 取值范围 4 - 7
+ * @param a
+ * @param v
+ */
+export declare function getGuestSort(a: boolean, v: boolean): number;
+/**
+ * 取值范围 0 - 3
+ * @param a
+ * @param v
+ */
+export declare function getCommonSort(a: boolean, v: boolean): number;