@hysc/meeting 10.0.67 → 10.1.0

package/esm/BMRoom/BMRoom.d.ts

@@ -1,638 +0,0 @@
-import BoomCore from '@hysc/core';
-import { MessageType } from './attachEvents';
-import BMRoomVM, { AudioProfileInfo } from "./BMRoomVM";
-import BMUserVM from '../BMUser/BMUserVM';
-import { SingleLocalStream, SingleRemoteStream, SingleRemoteStreamOption, SubscribeOptions } from '../type';
-import BMChatVM from '../BMChat/BMChatVM';
-import BMStreamModelVM from '../BMStream/BMStreamModelVM';
-import { Device, VideoProfile } from '@hysc/core/esm/BoomAdapter/type/value';
-import BMRoomInfo from './BMRoomInfo';
-import { BehaviorSubject, Subject } from 'rxjs';
-import BMStreamModel from '../BMStream/BMStreamModel';
-import BMUser from '../BMUser/BMUser';
-import BMLiveVM from './BMLiveVM';
-interface BMRoomProps {
-    initDevices: boolean;
-}
-export declare let _selfSortType: number;
-export default class BMRoom {
-    roomVM: BMRoomVM | null;
-    userVM: BMUserVM;
-    chatVM: BMChatVM;
-    bmStreamVm: BMStreamModelVM;
-    observes: any;
-    boomCore: BoomCore;
-    videoDevices: Device[];
-    audioDevices: Device[];
-    audioOutputDevices: Device[];
-    selectVideoDevice: Device | null;
-    selectAudioDevice: Device | null;
-    selectAudioOutputDevice: Device | null;
-    /**
-     * 这个参数是和业务相关的功能，业务上的参会者列表是可以配置的，如果设置了只展示一列，那么所有的用户都要存储
-     * 在commonUserList中
-     */
-    userListColumns: number;
-    /**
-     * 排序规则 1 是标品排序， 2 是中移排序
-     */
-    sortType: number;
-    /**
-     * brtc断网重连的时候,所有的订阅和播放相关的处理,都不需要
-     */
-    BRTCConnectFailed: boolean;
-    /**
-     * 会议模式
-     * 1 会议
-     * 2 直播
-     */
-    conferenceMode: 1 | 2;
-    /**
-     * 是不是大房间
-     */
-    isBig: boolean;
-    selectVideoDeviceWatcher: BehaviorSubject<Device | null>;
-    selectAudioDeviceWatcher: BehaviorSubject<Device | null>;
-    selectAudioOutputDeviceWatcher: BehaviorSubject<Device | null>;
-    audioDevicesWatcher: Subject<Device[]>;
-    videoDevicesWatcher: Subject<Device[]>;
-    audioOutputDevicesWatcher: Subject<Device[]>;
-    raiseHandleRespWatcher: Subject<{
-        raiseHandsType: 0 | 1 | 2;
-        raiseHands: boolean;
-    }>;
-    enableAudienceSpeakingWatcher: Subject<boolean>;
-    videoProfile: VideoProfile;
-    private audioProfile;
-    /**
-     * brtc断网重连要给端上事件响应，所有端上把流单独做处理的，需要在收到这个事件之后，重新处理所有的effect
-     */
-    streamWSReconnectWatcher: Subject<boolean>;
-    /**
-     * bloud断网重连的时候的提示
-     */
-    bloudWSReconnectWatcher: Subject<boolean>;
-    /**
-     * 会控底层相关处理, 比如是否取消自动拉流
-     */
-    private meetingControlOptions;
-    /**
-     * 传递信息用的，主要是用于message信令往上层业务发送消息
-     */
-    messageWatcher: BehaviorSubject<{
-        type: MessageType;
-        status: boolean;
-    }>;
-    roomInfo: BMRoomInfo;
-    localUser: BMUser;
-    bmLiveVM: BMLiveVM;
-    constructor({ initDevices }?: BMRoomProps);
-    /**
-     * 初始化底层会控相关
-     * @param options
-     */
-    setupMeetingControlOptions(options: any): void;
-    /**
-     * 收到对某个流状态的订阅和取消状态
-     * @private
-     * @param event
-     */
-    private handleSubMessage;
-    /**
-     * 设置视频分辨率， 需要在入会之前调用
-     * @param profile 设置视频分辨率
-     */
-    setVideoProfile(profile: VideoProfile): void;
-    setUserListColumns(column: number): void;
-    setSortType(type: number): void;
-    /**
-     * 设置声音增益的属性，回音消除 音频降噪 声音增益等
-     * @param audioProfile
-     */
-    setAudioProfile(audioProfile: AudioProfileInfo): void;
-    /**
-     * 设置共享屏幕用户的brtc Sig
-     * @param sig
-     */
-    setSig(sig: string): void;
-    /**
-     * 初始化输入设备
-     */
-    initDevices(): Promise<{
-        videoDevices: Device[];
-        audioDevices: Device[];
-        audioOutputDevices: Device[];
-        selectVideoDevice: Device | null;
-        selectAudioDevice: Device | null;
-        selectAudioOutputDevice: Device | null;
-    }>;
-    /**
-     * 筛选出默认选中的设备，如果没有，选择第一个
-     * @param devices
-     */
-    private filterDevice;
-    /**
-     * 处理用户设备变化之后的逻辑
-     */
-    private handleMediaDevicesChange;
-    setSelectAudioDevice(device: Device): void;
-    setSelectVideoDevice(device: Device): void;
-    setSelectSpeakerDevice(device: Device): void;
-    /**
-     * 事件相关 observes执行subscribe, 即执行observes,并添加回调
-     * @param observeName observe名称
-     * @param subscribeParam subscribe的参数
-     */
-    observe(observeName: string, subscribeParam: any): any;
-    /**
-   * 加入一个音视频通话房间(初始化房间对象)
-   * 进房代表开始一个音视频通话会话，这时候 SDK 会监听远端用户进房退房情况，若有远端用户进房并且发布流，本地会收到 'stream-added' 事件。
-   * 进房后用户可以通过 publish() 发布本地流，本地流发布成功后远端用户就会收到相应 'stream-added' 事件通知从而完成一个双向的音视频通话连接。
-   *
-   * @param {Object} props room创建所需属性
-   * @param {String} props.roomId 房间号
-   * @param {Number} props.userId 用户id
-   * @param {String} props.host 会议内的请求地址
-   * @param {String} props.getProxiesUrl 获取ws请求地址的路径
-   * @param {String} props.secret 房间密码
-   * @param {Boolean} props.create 是否执行房间的创建, 默认为自适应, 有房间则创建, 没房间则不创建
-   * @param {String} props.customToken 用户token
-   * @param {Number} props.limit 人数最大值
-   * @param {Number} props.brtcAppId
-   * @param {String} props.collection 数据上报地址
-   * @param {Object} props.userinfo 用户信息
-   * @param {Number} props.userinfo.cver 客户端版本
-   * @param {String} props.userinfo.nickname 用户昵称
-   * @param {String} props.userinfo.avatar 用户头像
-   * @param {String} props.userinfo.pos 客户端类型
-   * @param {Number} props.type //1:单一模式, 2:混合模式
-   * @param {String} props.name //房间名
-   * @example
-   * {
-        room: '111111',//房间号
-        host: 'https://v3test.boom.cn',//会议内的请求地址
-        getProxiesUrl: '/api/conference/v1/auth/token',//获取ws地址的路径
-        secret: '',//房间密码
-        type: 1,
-        nickname: 'zzy',
-        collection: '',//数据上报地址
-        token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJsb2dpbiIsImlhdCI6MTY1MDA5ODkwMSwibmJmIjoxNjUwMDk4OTAxLCJqdGkiOiIiLCJzdWIiOjk4NSwicHJ2IjoiODdlN2UxYmVlMjcyMmJmMzk4NjQxN2IzMzUxZTVmMjYzODQwY2ExYyIsImF0dHIiOjAsImJkIjowfQ.b-J9TnmjOzaVUJeY83tY_d1rdu_ELAWx8iH3odBN5kE',//用户token
-        userinfo: {
-            userId: 985,//用户id
-            pos: 'web',
-            nickname: 'zzy',//用户昵称
-            avatar: '',//用户头像
-        }
-    }
-   */
-    join(props: any): Promise<undefined>;
-    /**
-     * 离开房间
-     * @returns
-     */
-    leave(): Promise<void>;
-    /**
-     * 释放房间,会议结束时调用
-     */
-    releaseRoom(): Promise<void>;
-    /**
-     * 启动录制
-     * @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>;
-    /**
-     * 停止录制
-     */
-    stopRecord(): Promise<void>;
-    /**
-     * 启用下一个录制分片
-     * @param filename - 下一分片文件名
-     */
-    sliceRecord(filename: string): Promise<boolean | undefined>;
-    close(): void;
-    /**
-     * 开关对端摄像头
-     * @param status true:开,false:关
-     * @param uid 用户id
-     */
-    setRemoteVideoEnable(status: boolean, uid: string): Promise<void>;
-    /**
-     * 开关对端麦克风(现在还不知道怎么实现, 未找到实现逻辑)
-     * @param status true:开,false:关
-     * @param uid 用户id
-     */
-    setRemoteAudioEnable(status: boolean, uid: string): Promise<void>;
-    /**
-     * 开关本地摄像头
-     * @param status true:开,false:关
-     */
-    setLocalVideoEnable(status: boolean): Promise<void>;
-    /**
-     * 开关本地麦克风
-     * @param status true:开,false:关
-     */
-    setLocalAudioEnable(status: boolean): Promise<void>;
-    /**
-     * 开关本地麦克风
-     * @param status true:开,false:关
-     */
-    setLocalSpeakerEnable(status: boolean): Promise<void>;
-    private _attachEvents;
-    private _attachBrtcEvent;
-    /**
-     * 创建本地流
-     * @param options
-     * @param sid
-     */
-    createSingleLocalStream(options: {
-        video: boolean;
-        audio: boolean;
-        videoSource?: MediaStreamTrack | undefined;
-        audioSource?: MediaStreamTrack | undefined;
-    } | undefined, sid: string): Promise<any>;
-    /**
-     * 这个方法只是为了生成brtc的流，目的是在用户只打开音频的情况下，然后在打开视频的时候，去创建一个只有视频的track的流
-     * @param options
-     * @param sid
-     * @returns
-     */
-    createPBSingleLocalStream(options: {
-        video: boolean;
-        audio: boolean;
-    } | undefined, sid: string): Promise<any>;
-    /**
-       * 创建单一模式远端流
-       * @param options
-       * @returns stream 返回的流实例
-       * @example
-      const remoteStreamParams = {
-          uid: 996,
-          stream: stream,
-          subStream: subStreams,
-          sid: streamId,
-      }
-      let remoteStream = boomMeeting.createRemoteStream(remoteStreamParams)
-       */
-    createSingleRemoteStream(options: SingleRemoteStreamOption): import("@hysc/core/esm/BoomAdapter/singleMode/stream/RemoteStream").default;
-    /**
-     * 枚举视频输入设备
-     *
-     * @returns 设备列表
-     */
-    enumVideoDevices: any;
-    /**
-     * 枚举音频输入设备
-     *
-     * @returns 设备列表
-     */
-    enumAudioInputDevices: any;
-    /**
-     * 枚举音频输出设备
-     *
-     * @returns 设备列表
-     */
-    enumAudioOutputDevices: any;
-    /**
-     * 检查音视频权限
-     */
-    getPermissions: any;
-    checkSystemSupport: any;
-    createStream: any;
-    participantNotice: boolean;
-    /**
-     * 订阅远端流
-     * 可通过该订阅接口指明需要订阅音频、视频或者音视频流。
-     *
-     * @param remoteStream 需要订阅的远端流对象，由 ‘participant-published’ 事件获得
-     * @param options 订阅选项
-     * @returns
-     */
-    subscribe(remoteStream: SingleRemoteStream, options?: SubscribeOptions): Promise<void>;
-    /**
-     * 取消订阅远端流
-     *
-     * @param remoteStream 需要取消订阅的远端流对象
-     * @return
-     */
-    unsubscribe(remoteStream: SingleRemoteStream): Promise<any>;
-    /**
-     * 发布本地音视频流。
-     * 该方法需要在 join() 进房后调用，一次音视频会话中只能发布一个本地流。若想发布另外一个本地流，可先通过 unpublish() 取消发布当前本地流后再发布新的本地流。
-     * 在发布本地流后，可通过 removeTrack()、addTrack()、 replaceTrack() 来更新本地流中的某个音频或视频流。
-     * 发布本地流后远端会收到 ‘participant-published’ 事件通知。
-     *
-     * @param stream 创建的本地流对象
-     * @return
-     */
-    publish(stream: SingleLocalStream): Promise<any>;
-    /**
-     * 取消发布本地流。
-     * 取消发布本地流后远端会收到 'participant-unpublished' 事件通知。
-     * 请在 leave() 退房前取消已经发布的本地流。
-     *
-     * @param stream 取消发布的本地流对象
-     * @return
-     */
-    unpublish(stream: SingleLocalStream): Promise<any>;
-    /**
-     * 获取userList的用户对象
-     * @param userId
-     */
-    getUser(userId: string): BMUser | undefined;
-    /**
-     * 改变主持人,只有主持人权限和房间创建者可以改变主持人(房间创建者可以收回主持人)
-     * @param userId
-     * @param isKeep 是否保留转移人的联席主持人身份
-     */
-    changeMaster(userId: string, isKeep?: boolean): Promise<any>;
-    /**
-     * 改变联席主持人,返回设置为联席主持人的bmuser对象
-     * @param userId
-     * @param status true:设置成联席主持人 false:取消联席主持人身份
-     * @param hasS
-     */
-    updateManager(userId: string, status: boolean, hasS?: boolean): Promise<any>;
-    /**
-     * 获取房间主持人id
-     */
-    getMaster(): string;
-    /**
-     * 获取房间创建者
-     */
-    getCreator(): string;
-    /**
-     * 获取房间名称
-     */
-    getName(): string;
-    /**
-     * 踢出用户
-     * @param {String} userId 用户ID
-     * @param withoutBlack 是否拉进黑名单 true 可以再进来 false 进不来
-     */
-    evictUser(userId: string, withoutBlack: boolean): Promise<any>;
-    /**
-     * 更新用户信息
-     * @param {String} target - 目标用户id
-     * @param {String} info - 用户信息或者自定义的字段
-     */
-    updateUser(target: string, info: any): Promise<void>;
-    /**
-     * 获取最新消息序列号
-     */
-    getMsgSeq(): number;
-    /**
-     * 获取限制人数
-     */
-    getLimits(): number;
-    /**
-     * 是否允许房间加入成员
-     * @return {Boolean}
-     */
-    getSwitch(): Boolean;
-    /**
-     * 更新token
-     * @param {String} token
-     */
-    /**
-     * 同步房间信息，在事件 room-reconnected 触发后调用
-     * @return {Promise}
-     */
-    syncRoom(): Promise<any>;
-    /**
-     * 更新房间状态
-     * @param {Object} options - 更新房间信息参数
-     * @param {Boolean} options.audiooff - 房间是否开启全员静音，可选
-     * @param {Boolean} options.selfopenaudio - 房间是否允许成员自行开启语音
-     * @param {Boolean} options.videooff - 房间是否开启禁用摄像头，可选
-     * @param {Boolean} options.msgoff - 房间是否开启全员禁言，可选
-     * @param {Boolean} options.switch - 房间是否开启准入开关，可选
-     * @param {Boolean} options.lock - 房间是否锁定
-     * @param {Boolean} options.secret - 不为空时表示房间密码，为以`md5(${room}.${secret})`计算所得值为参数
-     * @returns {Promise}
-     */
-    update(options: any): Promise<any>;
-    /**
-     * 获取用户列表
-     * @return {BMUser[]}
-     */
-    getUsers(): Map<string, BMUser>;
-    /**
-     * 获取用户总数
-     * @return {Number}
-     */
-    getTotalUsers(): Number;
-    /**
-     * 发送消息，缓存至服务器，会生成序列号
-     * 端上会收到 new-message 信令
-     * @param {String} message - 待发送消息, 必须是 JSON 格式的字符串
-     * @param {String|undefined} to - 如果为空，则为广播消息，不为空，则为定向到to用户的私聊消息
-     */
-    sendMessage(message: string, to: string | undefined): Promise<any>;
-    /**
-     * 发送自定义消息 可绕过 W 权限
-     * @param {String} message - 待发送消息
-     * @param {String|undefined} to - 如果为空，则为广播消息，不为空，则定向到to用户的消息
-     */
-    customMessage(message: string, to: string | undefined): Promise<any>;
-    /**
-     * 获取指定消息列表
-     * @param {Number} startSeq - 起始序列号
-     * @param {Number} endSeq - 终止序列号
-     * @return {Promise<>}
-     */
-    getMessages(startSeq: number, endSeq: number): Promise<any>;
-    /**
-     * 获取本地用户对象
-     * @return {BMUser}
-     */
-    getLocalParticipant(): BMUser;
-    /**
-     * 是否开启全员静音
-     * @return {Boolean}
-     */
-    getAudioOff(): boolean;
-    /**
-     * 是否允许自行开启语音
-     */
-    getSelfOpenAudio(): boolean;
-    /**
-     * 是否开启全员禁用摄像头
-     * @return {Boolean}
-     */
-    getVideoOff(): boolean;
-    /**
-     * 是否开启全员禁言[禁止发送消息]
-     * @return {Boolean}
-     */
-    getMsgOff(): boolean;
-    /**
-     * 是否锁定房间
-     * @return {Boolean}
-     */
-    getLock(): boolean;
-    /**
-     * 获取房间信息
-     * @return {Object}
-     */
-    getRoomInfo(): BMRoomInfo;
-    /**
-     * 设置全员静音
-     * @param {Boolean} audiooff - 是否静音
-     * @param {Boolean} selfopenaudio - 是否允许自行开启
-     * @return {Promise}
-     */
-    setAudioOff(audiooff: boolean, selfopenaudio: boolean): Promise<any>;
-    /**
-     * 设置全员禁用摄像头
-     * @param {Boolean} videooff - 是否禁用摄像头
-     * @return {Promise}
-     */
-    setVideoOff(videooff: boolean): Promise<any>;
-    /**
-     * 设置全员禁言
-     * @param {Boolean} msgoff - 是否禁言
-     * @return {Promise}
-     */
-    setMsgOff(msgoff: boolean): Promise<any>;
-    /**
-     * 设置是否允许加入成员
-     * @param {Boolean} switch_ - 是否开启
-     */
-    setSwitch(switch_: boolean): any;
-    /**
-     * 设置是否锁定房间
-     * @param {Boolean} lock - 是否锁定
-     */
-    setLock(lock: boolean): Promise<boolean>;
-    /**
-     * 发送聊天室消息
-     * @param msg
-     */
-    sendChatMessage(msg: string, userId: string | undefined): Promise<any>;
-    /**
-     * 获取聊天室消息
-     */
-    getChatMessage(): import("../BMChat/BMMessageInfo").default[];
-    /**
-     * 获取聊天室历史消息
-     */
-    getHistoryMessage(): Promise<import("../BMChat/BMMessageInfo").default[]>;
-    /**
-     * 更新房间自定义属性状态
-     * @param {Object} customStats - 更新自定义房间信息参数
-     * @param {Boolean} customStats.layoutMode - 0/1/2,   // 默认为0，0:自由模式，可随时切换；1:是使用 defaultLayout，布局内可控；2:是使用 mainLayout，主会场同内容
-     * @returns {Promise}
-     */
-    updateCustomStats(customStats: any): Promise<any>;
-    /**
-     * 获取自定义属性
-     */
-    getCustomStats(): any;
-    /**
-     * 获取会议时间进度,返回秒数
-     */
-    getDuration(): number;
-    /**
-     * 检测目标用户是否有主持人权限
-     */
-    checkUserHasMaster(userId: string): boolean;
-    changeNickName(userId: string, nickName: string): Promise<any>;
-    handleQueueTask(streamModel: BMStreamModel, noPlayChanged?: boolean): Promise<void>;
-    handleStreamTask(streamModel: BMStreamModel, noPlayChanged?: boolean): Promise<void>;
-    /**
-     * 处理拉流的逻辑
-     * @param streamModel
-     */
-    handlePull(streamModel: BMStreamModel): Promise<void>;
-    /**
-     * 手动订阅流的处理
-     */
-    manualSubscribeStreamModel(streamModel: BMStreamModel): void;
-    /**
-     * 取消订阅流的处理
-     * @param streamModel
-     */
-    handleUnsubscribe(streamModel: BMStreamModel): void;
-    /**
-     * 处理streamModel绑定 element 只处理播放逻辑
-     * @param sm
-     */
-    handleStreamBindElement(sm: BMStreamModel): void;
-    /**
-     * 处理streamModel 绑定另一个播放器(主要是大窗口), 只处理播放逻辑
-     * @param sm
-     */
-    handleStreamBindBigElement(sm: BMStreamModel): void;
-    handleUnsubscribeStream(streamModel: BMStreamModel): Promise<void>;
-    handleSubscribeSteam(streamModel: BMStreamModel): Promise<void>;
-    /**
-     * 处理大小流切换
-     * @param streamModel
-     */
-    handleChangeStreamType(streamModel: BMStreamModel): Promise<void>;
-    /**
-     * 处理播放相关的逻辑
-     * @param streamModel
-     * @param noPlayChanged
-     * @param bigMute 大窗口的是否静音
-     */
-    handlePlay(streamModel: BMStreamModel, noPlayChanged: boolean, bigMute?: boolean): Promise<void>;
-    handlePlayInBIg(streamModel: BMStreamModel, bigMute?: boolean): Promise<void>;
-    /**
-     * 处理brtc订阅这股流失败的处理
-     * @param streamModel
-     */
-    private handlePulledFailed;
-    /**
-     * 处理流出现connect-error的逻辑，本地流需要重新推流，远端流需要重新拉流
-     * @param event
-     */
-    private handleStreamConnectError;
-    /**
-     * 设置用户禁止/允许发言
-     * @param bmUser
-     * @param status
-     */
-    toggleAudienceSpeaking(bmUser: BMUser, status: boolean): void;
-    /**
-     * 更新用户的嘉宾身份 true 设置为嘉宾 false 设置为普通参会者
-     * S -> permission
-     * 普通参会者缺少S权限，嘉宾有S权限
-     * @param user
-     * @param status
-     */
-    updateUserIsGuest(user: BMUser, status: boolean): Promise<void>;
-    /**
-     * 联席主持人设置嘉宾的操作
-     * @param userId
-     */
-    managerChangeToGuest(userId: string): void;
-    /**
-     * 获取业务端是否开启参会者进入/离开直播通知
-     * @param status
-     */
-    getParticipantNotice(status: boolean): void;
-    /**
-     *私有化部署url地址
-     * @param url
-     */
-    setCustomUrl(url: string): void;
-    /**
-     * 重推本地流，在收到brtc的code 4001 之后，说明本地掉线了
-     * 需要重新推本地流
-     */
-    handleRePushSelf(): Promise<void>;
-    /**
-     * 重拉远端流
-     */
-    handleRePullOthers(): void;
-}
-export {};