netender-web-sdk 1.0.0 → 1.1.0

package/dist/meeting-kit-lite/src/kit/impl/security_manager.d.ts

@@ -0,0 +1,108 @@
+import { AxiosInstance } from 'axios';
+import { NEResult } from 'neroom-types';
+import SecurityManager from '../interface/security_manager';
+import NEMeetingKitLite from './meeting_kit';
+export declare enum SecurityCtrlEnum {
+    ANNOTATION_DISABLE = "ANNOTATION_DISABLE",
+    /**
+     *  共享屏幕
+     */
+    SCREEN_SHARE_DISABLE = "SCREEN_SHARE_DISABLE",
+    /**
+     * 1: 共享白板关闭
+     * 0: 共享白板开启
+     */
+    WHILE_BOARD_SHARE_DISABLE = "WHILE_BOARD_SHARE_DISABLE",
+    /**
+     * 1: 不允许自己改名
+     * 0: 允许自己改名
+     */
+    EDIT_NAME_DISABLE = "EDIT_NAME_DISABLE",
+    /**
+     * 1: 全体音频关闭
+     * 0: 全体音频开启
+     */
+    AUDIO_OFF = "AUDIO_OFF",
+    /**
+     * 1: 音频不允许自己打开
+     * 0: 音频允许自己打开
+     */
+    AUDIO_NOT_ALLOW_SELF_ON = "AUDIO_NOT_ALLOW_SELF_ON",
+    /**
+     * 1: 全体视频关闭
+     * 0: 全体视频开启
+     */
+    VIDEO_OFF = "VIDEO_OFF",
+    /**
+     * 1: 视频不允许自己打开
+     * 0: 视频允许自己打开
+     */
+    VIDEO_NOT_ALLOW_SELF_ON = "VIDEO_NOT_ALLOW_SELF_ON",
+    /**
+     * 1: 表情回应功能关闭
+     * 0: 表情回应功能打开
+     */
+    EMOJI_RESP_DISABLE = "EMOJI_RESP_DISABLE",
+    /**
+     * 1: 本地录制功能关闭
+     * 0: 本地录制功能打开
+     */
+    LOCAL_RECORD_DISABLE = "LOCAL_RECORD_DISABLE",
+    /**
+     * 成员离开入会播放提示声音
+     *
+     *  1: 播放提示音
+     *  0：不播放提示音
+     */
+    PLAY_SOUND = "PLAY_SOUND",
+    /**
+     * 1: 隐藏头像
+     * 0: 显示头像
+     */
+    AVATAR_HIDE = "AVATAR_HIDE",
+    /**
+     * 智能会议纪要
+     * 1: 开启
+     * 0: 关闭
+     */
+    SMART_SUMMARY = "SMART_SUMMARY",
+    /**
+     * 本地录制
+     * 1: 开启
+     * 0: 关闭
+     */
+    LOCAL_RECORD = "LOCAL_RECORD"
+}
+export default class SecurityManagerImpl implements SecurityManager {
+    private _logger;
+    private _request;
+    private _appKey;
+    private _meetingKit;
+    private get _waitingRoomController();
+    private get _roomContext();
+    private get _meetingNum();
+    constructor(params: {
+        meetingKit: NEMeetingKitLite;
+        request: AxiosInstance;
+    });
+    enableWaitingRoomOnEntry(): Promise<NEResult<void>>;
+    disableWaitingRoomOnEntry(admitAll: boolean): Promise<NEResult<void>>;
+    lockRoom(): Promise<NEResult<void>>;
+    unlockRoom(): Promise<NEResult<void>>;
+    enableRoomBlacklist(enable: boolean): Promise<NEResult<void>>;
+    enableGuestJoin(enable: boolean): Promise<NEResult<void>>;
+    changeAvatarStatus(hide: boolean): Promise<NEResult<void>>;
+    changeChatroomPermission(crPerm?: '1' | '2' | '3' | '4', wtPrChat?: '0' | '1'): Promise<NEResult<void>>;
+    getChatroomPermission(): Promise<NEResult<{
+        crPerm: '1' | '2' | '3' | '4';
+        wtPrChat: '0' | '1';
+    }>>;
+    changeScreenSharePermission(allow: boolean): Promise<NEResult<void>>;
+    changeUnmuteAudioBySelfPermission(allow: boolean): Promise<NEResult<void>>;
+    changeUnmuteVideoBySelfPermission(allow: boolean): Promise<NEResult<void>>;
+    changeUpdateNicknamePermission(allow: boolean): Promise<NEResult<void>>;
+    changeWhiteboardPermission(allow: boolean): Promise<NEResult<void>>;
+    changeAnnotationPermission(allow: boolean): Promise<NEResult<void>>;
+    changeLocalRecordPermission(type: 'onlyHost' | 'some' | 'all'): Promise<NEResult<void>>;
+    private _securityControl;
+}

package/dist/meeting-kit-lite/src/kit/impl/transcription_manager.d.ts

@@ -0,0 +1,21 @@
+import { NEResult, NERoomCaptionTranslationLanguage } from 'neroom-types';
+import TranscriptionManager from '../interface/transcription_manager';
+import { AxiosInstance } from 'axios';
+import NEMeetingKitLite from './meeting_kit';
+import { LogDebug } from '../../utils/logDebug';
+export default class TranscriptionManagerImpl implements TranscriptionManager {
+    private _logger;
+    private _meetingKit;
+    private _request;
+    constructor(params: {
+        meetingKit: NEMeetingKitLite;
+        request: AxiosInstance;
+        debugLog: LogDebug;
+    });
+    isTranscriptionEnabled(): boolean;
+    setCaptionTranslationLanguage(language: NERoomCaptionTranslationLanguage): Promise<number | undefined>;
+    isAllowParticipantsEnableCaption(): boolean;
+    enableCaption(enable: boolean): Promise<number>;
+    allowParticipantsEnableCaption(allow: boolean): Promise<NEResult<null>>;
+    checkCaptionPermission(roomUuid: string): Promise<boolean>;
+}

package/dist/meeting-kit-lite/src/kit/impl/video_manager.d.ts

@@ -0,0 +1,37 @@
+import { NEDeviceBaseInfo, NEDeviceSwitchInfo, NEResult, NERoomVideoView, NEVideoStreamType } from 'neroom-types';
+import VideoManager from '../interface/video_manager';
+import { VideoFrameRate, VideoResolution } from '../../types/innerType';
+import { AxiosInstance } from 'axios';
+import NEMeetingKitLite from './meeting_kit';
+import { LogDebug } from '../../utils/logDebug';
+export default class VideoManagerImpl implements VideoManager {
+    private _logger;
+    private _meetingKit;
+    constructor(params: {
+        meetingKit: NEMeetingKitLite;
+        request: AxiosInstance;
+        debugLog: LogDebug;
+    });
+    getCameraDeviceList(): Promise<NEResult<NEDeviceBaseInfo[]>>;
+    getCameraDeviceId(): Promise<string | undefined>;
+    setCameraDevice(deviceId: string): Promise<NEResult<NEDeviceSwitchInfo>>;
+    setCameraDevicePreview(deviceId: string): Promise<NEResult<NEDeviceSwitchInfo>>;
+    setupLocalVideoCanvas(view: NERoomVideoView): Promise<NEResult<void>>;
+    removeLocalVideoCanvas(): Promise<NEResult<void>>;
+    setupVideoPreviewCanvas(view: NERoomVideoView): Promise<NEResult<void>>;
+    startVideoPreview(): Promise<NEResult<void>>;
+    stopVideoPreview(): Promise<NEResult<void>>;
+    setVideoProfile(resolution: VideoResolution, frameRate?: VideoFrameRate): void;
+    enableBeauty(enable: boolean, beautyLevel?: number): Promise<NEResult<void>>;
+    enableVirtualBackground(enable: boolean, path: string, force: boolean, type: number): Promise<NEResult<void>>;
+    unmuteMyVideo(): Promise<NEResult<void>>;
+    muteMyVideo(): Promise<NEResult<void>>;
+    setupRemoteVideoCanvas(userId: string, view: NERoomVideoView): Promise<NEResult<void>>;
+    removeRemoteVideoCanvas(userId: string): Promise<NEResult<void>>;
+    setupRemoteVideoSubStreamCanvas(userId: string, view: NERoomVideoView): Promise<NEResult<void>>;
+    removeRemoteVideoSubStreamCanvas(userId: string): Promise<NEResult<void>>;
+    subscribeRemoteVideoStream(userId: string, streamType: NEVideoStreamType): Promise<NEResult<void>>;
+    unsubscribeRemoteVideoStream(userId: string, streamType: NEVideoStreamType): Promise<NEResult<void>>;
+    subscribeRemoteVideoSubStream(userId: string): Promise<NEResult<void>>;
+    unsubscribeRemoteVideoSubStream(userId: string): Promise<NEResult<void>>;
+}

package/dist/meeting-kit-lite/src/kit/impl/waitingRoom_manager.d.ts

@@ -0,0 +1,29 @@
+import { LogDebug } from '../../utils/logDebug';
+import NEMeetingKitLite from './meeting_kit';
+import WaitingRoomManager from '../interface/waitingRoom_manager';
+import { NEResult, NEWaitingRoomInfo, NEWaitingRoomListener, NEWaitingRoomMember } from 'neroom-types';
+import { AxiosInstance } from 'axios';
+export default class WaitingRoomManagerImpl implements WaitingRoomManager {
+    listeners: NEWaitingRoomListener[];
+    private _logger;
+    private _meetingKit;
+    private _request;
+    constructor(params: {
+        meetingKit: NEMeetingKitLite;
+        debugLog: LogDebug;
+        request: AxiosInstance;
+    });
+    getWaitingRoomMemberList(time: number, limit: number, asc: boolean): Promise<NEResult<NEWaitingRoomMember[]>>;
+    getWaitingRoomInfo(): NEWaitingRoomInfo;
+    putInWaitingRoom(userUuid: string): Promise<NEResult<void>>;
+    admitMember(userUuid: string, autoAdmit?: boolean): Promise<NEResult<void>>;
+    expelMember(userUuid: string, notAllowJoin?: boolean): Promise<NEResult<void>>;
+    admitAllMembers(): Promise<NEResult<void>>;
+    expelAllMembers(disallowRejoin: boolean): Promise<NEResult<void>>;
+    getWaitingRoomConfig(roomUuid: string): Promise<{
+        wtPrChat: number;
+    }>;
+    addListener(listener: NEWaitingRoomListener): void;
+    removeListener(listener?: NEWaitingRoomListener): void;
+    private _checkWaitingRoomApi;
+}

package/dist/meeting-kit-lite/src/kit/impl/whiteboard_manager.d.ts

@@ -0,0 +1,23 @@
+import { NEResult } from 'neroom-types';
+import WhiteboardManager, { WhiteboardManagerListener } from '../interface/whiteboard_manager';
+import NEMeetingKit from './meeting_kit';
+export default class WhiteboardManagerImpl implements WhiteboardManager {
+    private _logger;
+    private _meetingKit;
+    private _listeners;
+    private get _whiteboardController();
+    constructor(params: {
+        meetingKit: NEMeetingKit;
+    });
+    addListener(listener: WhiteboardManagerListener): void;
+    removeListener(listener: WhiteboardManagerListener): void;
+    getWhiteboardUrl(): Promise<NEResult<string>>;
+    login(): Promise<NEResult<void>>;
+    logout(): Promise<NEResult<void>>;
+    auth(): Promise<NEResult<void>>;
+    startWhiteboardShare(): Promise<NEResult<void>>;
+    stopWhiteboardShare(): Promise<NEResult<void>>;
+    stopMemberWhiteboardShare(userUuid: string): Promise<NEResult<void>>;
+    setEnableDraw(enable: boolean): Promise<NEResult<void>>;
+    private _setupWhiteboardCanvas;
+}

package/dist/meeting-kit-lite/src/kit/index.d.ts

@@ -0,0 +1,26 @@
+import NEMeetingKitLite from './impl/meeting_kit';
+export { NEMeetingKitLite as NEMeetingKit };
+export * from './interface/meeting_kit';
+export * from './interface/account_manager';
+export * from './interface/meeting_manager';
+export * from './interface/audio_manager';
+export * from './interface/video_manager';
+export * from './interface/security_manager';
+export * from './interface/invite_manager';
+export * from './interface/member_manager';
+export * from './interface/chatroom_manager';
+export * from './interface/screen_share_manager';
+export * from './interface/whiteboard_manager';
+export * from './interface/annotation_manager';
+export * from './interface/record_manager';
+export * from './interface/plugin_manager';
+export * from './interface/notification_manager';
+export * from './interface/transcription_manager';
+export * from './interface/interpretation_manager';
+export * from './interface/breakout_manager';
+export * from './interface/quality_monitor_manager';
+export * from './interface/pre_meeting_manager';
+export * from 'neroom-types';
+export * from '../utils';
+export * from '../types';
+export default NEMeetingKitLite;

package/dist/meeting-kit-lite/src/kit/interface/account_manager.d.ts

@@ -0,0 +1,56 @@
+import { NEAccountInfo } from '../../types';
+import { IntervalEvent } from '@xkit-yx/utils';
+export interface AccountManager {
+    /**
+     * 账号登录
+     * @param options 登录选项
+     */
+    loginByToken(options: {
+        accountId: string;
+        accountToken: string;
+        authType?: string;
+        isTemporary?: boolean;
+        loginReport?: IntervalEvent;
+    }): Promise<NEAccountInfo>;
+    /**
+     * 账号密码登录
+     * @param options 登录选项
+     */
+    loginByPassword(options: {
+        username: string;
+        password: string;
+        loginReport?: IntervalEvent;
+    }): Promise<NEAccountInfo>;
+    /**
+     * 手机号验证码登录
+     * @param options 登录选项
+     */
+    loginBySmsCode(options: {
+        phoneNumber: string;
+        smsCode: string;
+        loginReport?: IntervalEvent;
+    }): Promise<NEAccountInfo>;
+    /**
+     * 获取账号信息
+     */
+    getAccountInfo(): Promise<NEAccountInfo>;
+    /**
+     * 账号登出
+     */
+    logout(): Promise<void>;
+    /**
+     * 更新用户昵称
+     * @param nickname 新昵称
+     */
+    updateNickname(nickname: string): Promise<void>;
+    /**
+     * 重置密码
+     * @param params 重置密码参数
+     */
+    resetPassword(params: {
+        userUuid: string;
+        newPassword: string;
+        oldPassword: string;
+    }): Promise<void>;
+}
+export default AccountManager;

package/dist/meeting-kit-lite/src/kit/interface/annotation_manager.d.ts

@@ -0,0 +1,57 @@
+import { NEResult } from 'neroom-types';
+export declare enum AnnotationManagerType {
+    onLogin = "onLogin",
+    onLogout = "onLogout",
+    onAuth = "onAuth",
+    onToolConfigChanged = "onToolConfigChanged",
+    onDrawEnableChanged = "onDrawEnableChanged"
+}
+export type AnnotationManagerListener = {
+    onWebJsBridge: (message: string, type: AnnotationManagerType) => void;
+};
+export interface AnnotationManager {
+    /**
+     * 添加批注管理器监听器
+     * @param listener 批注管理器监听器
+     */
+    addListener(listener: AnnotationManagerListener): void;
+    /**
+     * 移除批注管理器监听器
+     * @param listener 批注管理器监听器
+     */
+    removeListener(listener: AnnotationManagerListener): void;
+    /**
+     * 获取批注URL
+     * @returns 批注URL
+     */
+    getWhiteboardUrl(): Promise<NEResult<string>>;
+    /**
+     * 登录批注
+     * AnnotationManagerListener.onWebJsBridge 类型为 AnnotationManagerType.onLogin
+     */
+    login(): Promise<NEResult<void>>;
+    /**
+     * 登出批注
+     * AnnotationManagerListener.onWebJsBridge 类型为 AnnotationManagerType.onLogout
+     */
+    logout(): Promise<NEResult<void>>;
+    /**
+     * 授权批注
+     * AnnotationManagerListener.onWebJsBridge 类型为 AnnotationManagerType.onAuth
+     */
+    auth(): Promise<NEResult<void>>;
+    /**
+     * 开始批注
+     */
+    startAnnotation(): Promise<NEResult<void>>;
+    /**
+     * 停止批注
+     */
+    stopAnnotation(): Promise<NEResult<void>>;
+    /**
+     * 设置批注是否可绘制
+     * @param enable 是否可绘制
+     */
+    setEnableDraw: (enable: boolean) => Promise<NEResult<void>>;
+}
+export default AnnotationManager;

package/dist/meeting-kit-lite/src/kit/interface/audio_manager.d.ts

@@ -0,0 +1,171 @@
+import { NEDeviceBaseInfo, NEResult } from 'neroom-types';
+export interface ReverbConfig {
+    /**
+     * 湿信号增益
+     */
+    wetGain: number;
+    /**
+     * 干信号增益
+     */
+    dryGain: number;
+    /**
+     * 混响阻尼
+     */
+    damping: number;
+    /**
+     * 房间大小
+     */
+    roomSize: number;
+    /**
+     * 持续强度
+     */
+    decayTime: number;
+    /**
+     * 延迟长度
+     */
+    preDelay: number;
+}
+export interface AudioManager {
+    /**
+     * 获取扬声器列表
+     */
+    getSpeakerDeviceList(): Promise<NEResult<NEDeviceBaseInfo[]>>;
+    /**
+     * 获取当前扬声器
+     */
+    getSpeakerDeviceId(): Promise<NEResult<string>>;
+    /**
+     * 会中设置当前扬声器
+     * @param deviceId 设备ID
+     */
+    setSpeakerDevice(deviceId: string): Promise<NEResult<void>>;
+    /**
+     * 会前设置当前扬声器
+     * @param deviceId 设备ID
+     */
+    setSpeakerDevicePreview(deviceId: string): Promise<NEResult<void>>;
+    /**
+     * 获取扬声器音量
+     */
+    getSpeakerVolume(): Promise<NEResult<number>>;
+    /**
+     * 设置扬声器音量
+     * @param volume 音量值 (0-100)
+     */
+    setSpeakerVolume(volume: number): Promise<NEResult<void>>;
+    /**
+     * 获取扬声器静音状态
+     */
+    getSpeakerMute(): Promise<NEResult<boolean>>;
+    /**
+     * 设置扬声器静音状态
+     * @param mute 是否静音
+     */
+    setSpeakerMute(mute: boolean): Promise<NEResult<void>>;
+    /**
+     * 开始检测扬声器
+     */
+    startSpeakerDeviceTest(audioResource: string): Promise<NEResult<void>>;
+    /**
+     * 停止检测扬声器
+     */
+    stopSpeakerDeviceTest(): Promise<NEResult<void>>;
+    /**
+     * 获取麦克风列表
+     */
+    getMicrophoneDeviceList(): Promise<NEResult<NEDeviceBaseInfo[]>>;
+    /**
+     * 获取当前麦克风
+     */
+    getMicrophoneDeviceId(): Promise<NEResult<string>>;
+    /**
+     * 会前设置当前麦克风
+     * @param deviceId 设备ID
+     */
+    setMicrophoneDevicePreview(deviceId: string): Promise<NEResult<void>>;
+    /**
+     * 设置当前麦克风
+     * @param deviceId 设备ID
+     */
+    setMicrophoneDevice(deviceId: string): Promise<NEResult<void>>;
+    /**
+     * 获取麦克风音量
+     */
+    getMicrophoneVolume(): number;
+    /**
+     * 会前获取麦克风音量
+     */
+    getMicrophoneVolumePreview(): number;
+    /**
+     * 设置麦克风音量
+     * @param volume 音量值 (0-100)
+     */
+    setMicrophoneVolume(volume: number): Promise<NEResult<void>>;
+    /**
+     * 开始检测麦克风
+     */
+    startMicrophoneDeviceTest(): Promise<NEResult<void>>;
+    /**
+     * 停止检测麦克风
+     */
+    stopMicrophoneDeviceTest(): Promise<NEResult<void>>;
+    /**
+     * 自动调节麦克风音量
+     * @param enable 是否启用
+     */
+    enableAudioVolumeAutoAdjust(enable: boolean): Promise<NEResult<void>>;
+    /**
+     * 音频模式（音频降噪或音乐模式）
+     * @param mode 音频模式
+     */
+    setAdvancedAudioMode(mode: 'normal' | 'music'): Promise<NEResult<void>>;
+    /**
+     * 音频降噪配置（普通、增强）
+     * @param level 降噪级别 ('normal' | 'enhanced')
+     */
+    setAudioNoise(level: 'normal' | 'enhanced'): Promise<NEResult<void>>;
+    /**
+     * 音乐模式配置（回声消除&启动立体声）
+     * @param enable 是否启用
+     */
+    setAudioMusic(enable: boolean): Promise<NEResult<void>>;
+    /**
+     * 设置远端音频播放是否需要混音
+     * @param need 是否需要混音播放
+     */
+    setMixAudioStream(need: boolean): void;
+    /**
+     * 开启本端音频发送
+     * @param enableMediaPub 是否开启媒体发布
+     */
+    unmuteMyAudio(enableMediaPub?: boolean): Promise<NEResult<void>>;
+    /**
+     * 关闭本端音频发送
+     */
+    muteMyAudio(): Promise<NEResult<void>>;
+    /**
+     * 开启音频特效
+     */
+    enableAudioEffect?: () => Promise<void>;
+    /**
+     * 设置变声效果
+     */
+    setAudioEffect?: (type: number | string, value: number | Array<number> | ReverbConfig) => void;
+    /**
+     * 关闭音频特效
+     */
+    disableAudioEffect?: () => Promise<void>;
+    /**
+     * 开启AI降噪
+     */
+    enableAIDenoise?: () => Promise<void>;
+    /**
+     * 设置背景人声消除阈值
+     */
+    setVoiceGate?: (level: number) => void;
+    /**
+     * 关闭AI降噪
+     */
+    disableAIDenoise?: () => Promise<void>;
+}
+export default AudioManager;

package/dist/meeting-kit-lite/src/kit/interface/breakout_manager.d.ts

@@ -0,0 +1,64 @@
+import { BreakoutRoomsConfig } from '../../types';
+import { NEResult } from 'neroom-types';
+export type { BreakoutRoomsConfig };
+export type CreateBreakoutRoomsConfig = {
+    rooms: {
+        name: string;
+    }[];
+    config: {
+        autoAssign: boolean;
+        selfSelect: boolean;
+        freeReturn: boolean;
+        minutes: number;
+        closeType: number;
+        secondsBeforeClose: number;
+    };
+};
+export type AddOrDeleteBreakoutRoomMembersConfig = {
+    addUserUuids?: {
+        [key: string]: string[];
+    };
+    deleteUserUuids?: {
+        [key: string]: string[];
+    };
+};
+export interface BreakoutManager {
+    /**
+     * 主持人获取当前分组讨论
+     */
+    getBreakoutRooms(): Promise<NEResult<BreakoutRoomsConfig>>;
+    /**
+     * 普通成员获取当前分组讨论
+     */
+    getBreakoutRoomsSimple(): Promise<NEResult<BreakoutRoomsConfig>>;
+    /**
+     * 创建分组讨论
+     * @param config 分组配置
+     */
+    createBreakoutRooms(config: CreateBreakoutRoomsConfig): Promise<NEResult<BreakoutRoomsConfig>>;
+    /**
+     * 添加分组
+     * @param name 房间名称
+     * @param roomUuid 房间UUID
+     */
+    addBreakoutRoom(name: string, roomUuid?: string): Promise<NEResult<BreakoutRoomsConfig>>;
+    /**
+     * 删除分组
+     * @param roomUuid 房间UUID
+     */
+    deleteBreakoutRoom(roomUuid: string): Promise<NEResult<BreakoutRoomsConfig>>;
+    /**
+     * 添加删除成员
+     * @param config 配置
+     */
+    addOrDeleteBreakoutRoomMembers(config: AddOrDeleteBreakoutRoomMembersConfig): Promise<NEResult<BreakoutRoomsConfig>>;
+    /**
+     * 开始分组讨论
+     */
+    startBreakoutRooms(): Promise<NEResult<BreakoutRoomsConfig>>;
+    /**
+     * 结束分组讨论
+     */
+    stopBreakoutRooms(): Promise<NEResult<BreakoutRoomsConfig>>;
+}
+export default BreakoutManager;