@hysc/meeting 6.0.0 → 6.1.1

package/esm/boom-meeting/src/BMRoom/BMRoomVM.d.ts

@@ -0,0 +1,317 @@
+import BoomCore from "@hysc/core";
+import BMRoom from "./BMRoom";
+import BMUserVM from "../BMUser/BMUserVM";
+import BMRoomInfo from "./BMRoomInfo";
+import { HostLayout } from "../type/customStats";
+import { Subject } from "rxjs";
+/**
+ * 0 仅支持人 1 嘉宾 2 全员
+ */
+export declare type FilePermission = 0 | 1 | 2;
+declare type giveLikeItem = {
+    userId: string | undefined;
+    nickName: string | undefined;
+    time: number;
+    type: number;
+};
+export declare type CloudRecord = {
+    recordStatus: 0 | 1 | 2;
+    userId: string;
+};
+declare type SupportVideoProfile = '180p' | '240p' | '360p' | '480p' | '720p';
+declare type SampleDeviceInfo = {
+    name: string;
+};
+interface DeviceList {
+    microphoneDeviceList: SampleDeviceInfo[];
+    speakerDeviceList: SampleDeviceInfo[];
+    videoDeviceList: SampleDeviceInfo[];
+    selectVideoDevice: SampleDeviceInfo;
+    selectMicrophoneDevice: SampleDeviceInfo;
+    selectSpeakerDevice: SampleDeviceInfo;
+    videoProfile: SupportVideoProfile;
+    echoCancellation: boolean;
+    noiseSuppression: boolean;
+    autoGainControl: boolean;
+    speakerVolume: number;
+}
+export interface AudioProfileInfo {
+    /**
+     * 音频采集设备
+     */
+    microphoneDevice?: SampleDeviceInfo;
+    /**
+     * 音频输出设备
+     */
+    speakerDevice?: SampleDeviceInfo;
+    /**
+     * 回音消除
+     */
+    echoCancellation?: boolean;
+    /**
+     * 音频降噪
+     */
+    noiseSuppression?: boolean;
+    /**
+     * 声音增益
+     */
+    autoGainControl?: boolean;
+    /**
+     * 调整扬声器音量 0 - 100
+     */
+    speakerVolume?: number;
+    /**
+     * 调整麦克风音量 0 - 100
+     */
+    microVolume?: number;
+}
+export default class BMRoomVM {
+    roomInfo: BMRoomInfo;
+    boomCore: BoomCore;
+    userVM: BMUserVM;
+    giveLikeListWatcher: Subject<Array<giveLikeItem>>;
+    giveLikeList: Array<giveLikeItem>;
+    private room;
+    tipQueueObj: any;
+    constructor(boomCore: BoomCore, userVM: any, roomInfo: BMRoomInfo);
+    initWithRoom(room: BMRoom): void;
+    /**
+     * 踢出用户
+     * @param {String} userId 用户ID
+     * @param {boolean} withoutBlack
+     */
+    evictUser(userId: string, withoutBlack: boolean): Promise<any>;
+    /**
+     * 更新用户信息，端上会收到 participant-update 信令
+     * @param userId
+     * @param info
+     */
+    updateUser(userId: string, info: any): Promise<undefined>;
+    /**
+     * 改变主持人
+     * @param {String} userId 用户ID
+     * @param isKeep
+     */
+    changeMaster(userId: string, isKeep: boolean): Promise<any>;
+    updateManager(userId: string, status: boolean, hasS?: boolean): Promise<import("../BMUser/BMUser").default>;
+    /**
+      * 改变昵称 需要调用http请求
+      * @param {String} userId 用户ID
+      * @param {String} nickName 用户ID
+      */
+    changeNickName(userId: string, nickName: string): Promise<any>;
+    /**
+     * 主持人send-message
+     * @param message 发送的消息
+     * @param uid 指定的userId
+     */
+    sendMessageWithMaster(message: any, uid?: string): Promise<undefined>;
+    /**
+     * 开关对端麦克风-信令发送
+     * @param status true:开,false:关
+     * @param uid 用户id
+     * @param isNotCancelRootReport 当打开麦克风时, 是否不取消音频权限申请
+     */
+    setRemoteAudioEnable(status: boolean, uid: string, isNotCancelRootReport: boolean | undefined): Promise<void>;
+    /**
+     * 开关对端摄像头-信令发送
+     * @param status true:开,false:关
+     * @param uid 用户id
+     */
+    setRemoteVideoEnable(status: boolean, uid: string): Promise<void>;
+    /**
+     * 关闭对端共享屏幕
+     * @param uid 用户id
+     */
+    closeRemoteShare(uid: string): Promise<void>;
+    /**
+       * 提醒用户
+       * @param uid 用户id
+       * @param uid msg
+       */
+    tipUser(uid: string, msg: string, richMsg: object, time: any): Promise<void>;
+    /**
+     * 举手相关操作
+     * @param type 视频还是音频举手 audio/video
+     * @param raise 举手还是放下举手 true/false
+     */
+    raiseHands(type: 'audio' | 'video' | 'raiseHand', raise: boolean): Promise<void>;
+    /**
+     * 主持人处理举手操作
+     * @param raiseHandsType 0 音视频 1 音频 2 视频 3 单纯的举手
+     * @param raiseHands true 同意 false 拒绝
+     * @param uid 指定的用户Id
+     * @description 如果不指定用户ID就是广播处理所有的举手的人员
+     */
+    handleRaiseHands(raiseHandsType: 0 | 1 | 2 | 3, raiseHands: boolean, uid?: string): Promise<undefined>;
+    /**
+     * 更新自定义属性 updateCustomStats
+     * @param stats
+     * @param {boolean} replace 是否替换原数据
+     */
+    private updateCustomStats;
+    /**
+     * 发送聊天公告
+     * @param notice
+     */
+    sendChatNotice(notice: string, richNotice: object, showTipNotice: boolean): Promise<void>;
+    /**
+     * 是否允许点赞
+     * @param enable 0 不允许 1 允许
+     */
+    giveLikeEnable(enable: 0 | 1): Promise<void>;
+    /**
+     * 入会自动静音配置 0 关闭 1 开启自动静音 2 超过6个人入会自动静音
+     * @param enable
+     */
+    changeAutoMute(enable: 0 | 1 | 2): Promise<void>;
+    /**
+     * 允许成员接收进入/离开会议通知配置 0 关闭 1 开启自动静音
+     * @param enable
+     */
+    allUserReceiveJoinLeaveMessages(enable: 0 | 1): Promise<void>;
+    /**
+     * 成员入会时给主持人播放提示音配置 0 关闭 1 开启自动静音
+     * @param enable
+     */
+    userJoinMasterVoice(enable: 0 | 1): Promise<void>;
+    /**
+     * 观众点赞(走customMessage)
+     * @param type 1:点赞, 2:送花, 3:爱心, 4: 鼓掌, 5: 喝彩
+     */
+    userGiveLike(type: 1 | 2 | 3 | 4 | 5): Promise<void>;
+    /**
+     * 聊天是否可用
+     * @param enable 0 不允许 1 允许  2仅主持人 3嘉宾
+     */
+    chatEnable(enable: 0 | 1 | 2 | 3): Promise<void>;
+    /**
+     * 入会时是否允许开启麦克风
+     * @param enable 0全员 1嘉宾 2仅主持人 3全员禁止
+     */
+    joinAudioEnable(enable: 0 | 1 | 2 | 3): Promise<void>;
+    /**
+     * 入会时是否允许开启摄像头
+     * @param enable 0全员 1嘉宾 2仅主持人 3全员禁止
+     */
+    joinVideoEnable(enable: 0 | 1 | 2 | 3): Promise<void>;
+    /**
+     * 参会者列表权限
+     * @param enable 0全员 1嘉宾 2仅主持人
+     */
+    userListEnable(enable: 0 | 1 | 2): Promise<void>;
+    /**
+     * 会议中是否允许开麦克风
+     * @param enable 0全员 1嘉宾 2仅主持人
+     */
+    audioEnable(enable: 0 | 1 | 2): Promise<void>;
+    /**
+     * 会议中是否允许开启摄像头
+     * @param enable 0全员 1嘉宾 2仅主持人
+     */
+    videoEnable(enable: 0 | 1 | 2): Promise<void>;
+    /**
+     * 是否允许自行改名
+     * @param enable 0全员 1嘉宾
+     */
+    modifyNameEnable(enable: 0 | 1 | 2): Promise<void>;
+    /**
+     * 是否允许开启虚拟背景
+     * @param enable 0全员 1嘉宾 2仅主持人
+     */
+    backgroundAIEnable(enable: 0 | 1 | 2): Promise<void>;
+    /**
+     * 强制开启对方视频
+     * @param enable true开启 false关闭
+     */
+    forceOpenUserCamera(enable: true | false): Promise<void>;
+    /**
+     * 强制开启对方音频
+     * @param enable true开启 false关闭
+     */
+    forceOpenUserMic(enable: true | false): Promise<void>;
+    /**
+    * 入会提示音设置
+    * @param enable 0关闭 1开启
+    */
+    joinCueVoice(enable: 0 | 1): Promise<void>;
+    /**
+    * 是否全员可录制
+    * @param enable 0全员 1嘉宾 2仅主持人
+    */
+    recordEnable(enable: 0 | 1 | 2): Promise<void>;
+    /**
+   * 是否全员可录制
+   * @param enable 0禁止全员举手 1嘉宾可举手 2全员可举手
+   */
+    raiseHandEnable(enable: 0 | 1 | 2): Promise<void>;
+    /**
+    * 入会麦克风禁用
+    * @param enable 0全员禁止使用 1嘉宾和学员不可使用 2不开启
+    */
+    joinMicrophoneDisable(enable: 0 | 1 | 2): Promise<void>;
+    /**
+    * 入会摄像头禁用
+    * @param enable 0全员禁止使用 1嘉宾和学员不可使用 2不开启
+    */
+    joinCameraDisable(enable: 0 | 1 | 2): Promise<void>;
+    /**
+     * 上传文档权限
+     * @param permission 0 仅支持人 1 嘉宾 2 全员
+     */
+    changeFileUpdateModelPermission(permission: FilePermission): Promise<void>;
+    changeFileUpdateLookPermission(permission: FilePermission): Promise<void>;
+    changeFileUpdateDownPermission(permission: FilePermission): Promise<void>;
+    changeFileUpdateEditPermission(permission: FilePermission): Promise<void>;
+    /**
+     * 共享屏幕权限
+     * @param permission  0全员可共享 1允许嘉宾共享 2仅主持人可共享
+     */
+    changeScreenShareModelPermission(permission: 0 | 1 | 2): Promise<void>;
+    /**
+     * 是否仅一人共享权限
+     * @param permission  1: 是  2: 否
+     */
+    changeOnlyOnePersonSharePermission(permission: 0 | 1): Promise<void>;
+    /**
+     * 设为焦点主屏
+     * @param {string} userid 设为焦点主屏的userId
+     */
+    setForceOnUser(userid: string): Promise<void>;
+    /**
+     * 主持人上报布局状态
+     * @param layoutData
+     * @param replace
+     */
+    updateHostLayout(layoutData: HostLayout, replace?: boolean): Promise<void>;
+    checkDevices(userId: string): Promise<void>;
+    resp2CheckDevices(deviceList: DeviceList, userId: string): Promise<void>;
+    /**
+     * 调节对方的视频分辨率
+     * @param {SupportVideoProfile} videoInfo 调节对方视频信息
+     * @param {string} userId
+     */
+    changeRemoteVideoProfile(videoInfo: {
+        profile: SupportVideoProfile;
+        videoDevice: SampleDeviceInfo;
+    }, userId: string): Promise<any>;
+    /**
+     * 设置完本地的视频分辨率之后，给对方响应
+     * @param {boolean} status 设置是否成功
+     * @param {string} userId
+     */
+    resp2ChangeRemoteVideoProfile(status: boolean, userId: string, profile: string): Promise<any>;
+    /**
+     * 调节远端的音频参数
+     * @param {Object} profileInfo
+     * @param uid
+     */
+    changeRemoteAudioProfile(profileInfo: AudioProfileInfo, uid: string): Promise<any>;
+    /**
+     * 响应调节远端音频的结果
+     * @param status
+     * @param uid
+     */
+    resp2ChangeRemoteAudioProfile(status: boolean, uid: string): Promise<any>;
+}
+export {};

package/esm/boom-meeting/src/BMRoom/RoomEvent.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/boom-meeting/src/BMStream/BMStreamModel.d.ts

@@ -0,0 +1,305 @@
+import { SingleStream, SubscribeOptions } from "../type";
+import BMUser from "../BMUser/BMUser";
+import { BehaviorSubject, Subject } from "rxjs";
+import { Player } from "@hysc/core/esm";
+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;
+}
+/**
+ * 播放器状态
+ */
+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;
+    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;
+    private checkFailedCount;
+    /**
+     * streamModel的唯一标识，用来给业务绑定播放容器
+     */
+    get uuid(): string;
+    get isAudience(): boolean;
+    /**
+     * 因为直播模式中，观众默认是不展示的，只有开麦以后才会展示
+     * 所以这个地方要判断一下
+     */
+    get canShow(): boolean;
+    changeMute(mute: boolean): void;
+    handleSpeakerChange(): void;
+    /**
+     * 排序数字
+     * 窗口的排序使用二进制运算进行了优化，为了提高运行速度牺牲了一部分代码可读性
+     */
+    sortNum: number;
+    get isToupingma(): boolean;
+    get isMixer(): boolean;
+    get isSignal(): boolean;
+    /**
+     * 初始化展示的model
+     * @param user
+     * @param stream
+     */
+    constructor(user: BMUser, stream?: SingleStream);
+    /**
+     * 生成订阅信息
+     */
+    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 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/core/esm/BoomAdapter/type/stats").RemoteStreamStats> | Promise<import("@hysc/core/esm/BoomAdapter/type/stats").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 playerContainerId 播放器创建的容器id
+     */
+    currentIsPlaying: (containerId: string) => PlayerState;
+    /**
+     * 播放当前流
+     */
+    play: () => Promise<void>;
+    /**
+     * 在大窗口播放该流的时候调用这个方法
+     */
+    playInBig: () => Promise<void>;
+    private initBigPlayer;
+    /**
+     * 停止播放当前流
+     */
+    stop(): void;
+    /**
+     * 销毁当前流
+     */
+    destroy(): 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(): 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 {};