netender-web-sdk 1.0.0 → 1.1.0

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

@@ -0,0 +1,60 @@
+import { NECustomSessionMessage, NEResult } from 'neroom-types';
+export type NotificationMessage = NECustomSessionMessage & {
+    content?: {
+        data: {
+            meetingId: string;
+            notifyCard: {
+                notifyCenterCardClickAction: string;
+                header: {
+                    icon: string;
+                    title: string;
+                    subject: string;
+                };
+                body: {
+                    title: string;
+                    content: string;
+                };
+                popUpCardBottomButton?: {
+                    name: string;
+                    action: string;
+                }[];
+            };
+            timestamp: number;
+        };
+    };
+};
+export interface NotificationManager {
+    /**
+     * 获取通知列表
+     */
+    getNotificationMessageList(): Promise<NEResult<NotificationMessage[]>>;
+    /**
+     * 删除某条通知
+     * @param messageId 消息ID
+     */
+    removeNotificationMessage(messageId: string): Promise<NEResult<void>>;
+    /**
+     * 标记通知为已读
+     * @param messageId 消息ID
+     */
+    markAsRead(messageId: string): Promise<NEResult<void>>;
+    /**
+     * 标记所有通知为已读
+     */
+    markAllAsRead(): Promise<NEResult<void>>;
+    /**
+     * 添加监听器
+     * @param listener 监听器
+     */
+    addListener(listener: {
+        onNotificationMessageReceived?: (message: NotificationMessage) => void;
+    }): void;
+    /**
+     * 移除监听器
+     * @param listener 监听器
+     */
+    removeListener(listener: {
+        onNotificationMessageReceived?: (message: NotificationMessage) => void;
+    }): void;
+}
+export default NotificationManager;

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

@@ -0,0 +1,43 @@
+import { NEResult } from 'neroom-types';
+export interface PluginInfo {
+    configDetails: {
+        availableDefault: boolean;
+        paid: boolean;
+        showInToolbar: boolean;
+    };
+    description: string;
+    homeUrl: string;
+    icon: {
+        defaultIcon: string;
+        mobileIcon: {
+            icon_dark: string;
+            icon_light: string;
+        };
+        notifyIcon: string;
+        pcIcon: {
+            icon_dark: string;
+            icon_light: string;
+        };
+    };
+    name: string;
+    notifySenderAccid: string;
+    pluginId: string;
+    type: number;
+}
+export interface PluginManager {
+    /**
+     * 获取插件列表
+     */
+    getPluginList(): Promise<NEResult<PluginInfo[]>>;
+    /**
+     * 获取插件认证码
+     */
+    getPluginAuthCode(pluginId: string): Promise<NEResult<{
+        authCode: string;
+    }>>;
+    /**
+     * 激活插件
+     */
+    getAIAssistantToken(): Promise<NEResult<string>>;
+}
+export default PluginManager;

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

@@ -0,0 +1,67 @@
+import { NEMeetingInfo, MeetingListItem, NEHistoryMeetingDetail, NEMeetingAppNoticeTip, NEMeetingCreateOptions, NEMeetingGetListBySizeParams, NEMeetingGetListOptions, NEScheduledMember } from '..';
+export interface PreMeetingManager {
+    /**
+     * 获取会议列表（已弃用）
+     * @param options 获取会议列表选项
+     * @deprecated 已弃用，请使用getMeetingListBySize代替
+     */
+    getMeetingList(options: NEMeetingGetListOptions): Promise<NEMeetingInfo[]>;
+    /**
+     * 获取会议列表
+     * @param options 获取会议列表选项
+     */
+    getMeetingListBySize(options: NEMeetingGetListBySizeParams): Promise<NEMeetingInfo[]>;
+    /**
+     * 获取应用提示
+     */
+    getAppTips(): Promise<{
+        tips: NEMeetingAppNoticeTip[];
+        curTime: number;
+        appKey: string;
+    }>;
+    /**
+     * 预约房间
+     * @param options 预约会议选项
+     */
+    scheduleMeeting(options: NEMeetingCreateOptions): Promise<NEMeetingInfo>;
+    /**
+     * 修改预定房间
+     * @param meetingId 会议ID
+     * @param options 修改选项
+     */
+    editMeeting(meetingId: number | string, options: Partial<NEMeetingCreateOptions>): Promise<void>;
+    /**
+     * 取消预定房间
+     * @param meetingId 会议ID
+     * @param cancelRecurringMeeting 是否取消重复会议
+     */
+    cancelMeeting(meetingId: number | string, cancelRecurringMeeting?: boolean): Promise<void>;
+    /**
+     * 获取预约会议成员列表
+     * @param meetingNum 会议号
+     */
+    getScheduledMembers(meetingNum: string): Promise<NEScheduledMember[]>;
+    /**
+     * 根据会议ID获取会议信息
+     * @param meetingId 会议ID
+     */
+    getMeetingInfoByMeetingId(meetingId: number | string): Promise<NEMeetingInfo>;
+    /**
+     * 根据会议号获取会议信息
+     * @param meetingNum 会议号
+     */
+    getMeetingInfoByMeetingNum(meetingNum: string): Promise<NEMeetingInfo>;
+    /**
+     * 获取参会记录列表
+     */
+    getHistoryMeetingList(params: {
+        startId?: number;
+        limit?: number;
+    }): Promise<{
+        meetingList: MeetingListItem[];
+    }>;
+    /**
+     * 获取参会记录详情
+     */
+    getHistoryMeetingDetail(roomArchiveId: number): Promise<NEHistoryMeetingDetail>;
+}

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

@@ -0,0 +1,70 @@
+import { NEResult } from 'neroom-types';
+export interface NetworkStats {
+    rtt: number;
+    packetLossRate: number;
+    bandwidth: number;
+    jitter: number;
+}
+export interface AudioStats {
+    recordVolume: number;
+    playVolume: number;
+    audioTxBitrate: number;
+    audioRxBitrate: number;
+    audioLevel: number;
+}
+export interface VideoStats {
+    videoTxBitrate: number;
+    videoRxBitrate: number;
+    videoFrameRate: number;
+    videoResolution: {
+        width: number;
+        height: number;
+    };
+}
+export interface QualityStats {
+    network: NetworkStats;
+    audio: AudioStats;
+    video: VideoStats;
+    timestamp: number;
+}
+export interface QualityMonitorManager {
+    /**
+     * 添加监控回调
+     * @param listener 监听器
+     */
+    addListener(listener: {
+        onQualityStatsChanged?: (stats: QualityStats) => void;
+        onNetworkQualityChanged?: (quality: 'excellent' | 'good' | 'poor' | 'bad') => void;
+        onAudioQualityChanged?: (quality: 'excellent' | 'good' | 'poor' | 'bad') => void;
+        onVideoQualityChanged?: (quality: 'excellent' | 'good' | 'poor' | 'bad') => void;
+    }): void;
+    /**
+     * 移除监控回调
+     * @param listener 监听器
+     */
+    removeListener(listener: {
+        onQualityStatsChanged?: (stats: QualityStats) => void;
+        onNetworkQualityChanged?: (quality: 'excellent' | 'good' | 'poor' | 'bad') => void;
+        onAudioQualityChanged?: (quality: 'excellent' | 'good' | 'poor' | 'bad') => void;
+        onVideoQualityChanged?: (quality: 'excellent' | 'good' | 'poor' | 'bad') => void;
+    }): void;
+    /**
+     * 开始质量监控
+     * @param interval 监控间隔（毫秒）
+     */
+    startQualityMonitor(interval?: number): Promise<NEResult<void>>;
+    /**
+     * 停止质量监控
+     */
+    stopQualityMonitor(): Promise<NEResult<void>>;
+    /**
+     * 获取当前质量统计
+     */
+    getCurrentQualityStats(): Promise<NEResult<QualityStats>>;
+    /**
+     * 获取历史质量数据
+     * @param duration 时间范围（毫秒）
+     */
+    getHistoricalQualityStats(duration: number): Promise<NEResult<QualityStats[]>>;
+}
+export default QualityMonitorManager;

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

@@ -0,0 +1,41 @@
+import { NEResult, NERoomRecordConfig, NERoomStartLocalRecordOptions, NERoomStreamLayer, NERoomUpdateLocalRecordLayoutsOptions, NERoomVideoFrame } from 'neroom-types';
+export interface RecordConfig {
+    recordType: 'video' | 'audio' | 'mixed';
+    layout: 'single' | 'gallery' | 'speaker';
+    resolution: '720p' | '1080p';
+    frameRate: 15 | 30;
+    bitrate: number;
+}
+export interface RecordManager {
+    /**
+     * 开启云录制
+     * @param config 录制配置
+     */
+    startCloudRecord(config?: NERoomRecordConfig): Promise<NEResult<void>>;
+    /**
+     * 停止云录制
+     */
+    stopCloudRecord(): Promise<NEResult<void>>;
+    /**
+     * 开启本地录制
+     * @param config 录制配置
+     */
+    startLocalRecord(config?: NERoomStartLocalRecordOptions): number | undefined;
+    /**
+     * 停止本地录制
+     */
+    stopLocalRecord(): number | undefined;
+    /**
+     * 更新本地录制布局
+     * @param options 布局配置
+     */
+    updateLocalRecordLayouts(options: NERoomUpdateLocalRecordLayoutsOptions[]): number | undefined;
+    /**
+     * 推送本地录制视频帧
+     * @param uid 用户ID
+     * @param streamLayer 流层
+     * @param frame 视频帧
+     */
+    pushLocalRecorderVideoFrame(uid: string, streamLayer: NERoomStreamLayer, frame: NERoomVideoFrame): number | undefined;
+}
+export default RecordManager;

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

@@ -0,0 +1,43 @@
+import { NEResult, NERoomRtcScreenCaptureSource, NERoomScreenConfig, NERoomStopScreenConfig } from 'neroom-types';
+export type NERoomStartScreenConfigEnhanced = NERoomScreenConfig & {
+    preferMotion?: boolean;
+    isLinux?: boolean;
+};
+export type CastToScreenShareResult = {
+    meetingNum: string;
+};
+export interface ScreenShareManager {
+    /**
+     * 投屏到屏幕共享
+     * @param code 投屏码
+     */
+    castToScreenShare(code: string): Promise<NEResult<CastToScreenShareResult>>;
+    /**
+     * 获取共享提示信息
+     */
+    getScreenShareMessage(): Promise<NEResult<string>>;
+    /**
+     * 获取共享列表
+     */
+    getScreenCaptureSourceList(): Promise<NEResult<NERoomRtcScreenCaptureSource[]>>;
+    /**
+     * 开始共享
+     * @param sourceId 源ID
+     * @param options 共享选项
+     */
+    startScreenShare(config?: NERoomStartScreenConfigEnhanced): Promise<NEResult<void>>;
+    /**
+     * 结束共享
+     */
+    stopScreenShare(config?: NERoomStopScreenConfig): Promise<NEResult<void>>;
+    /**
+     * 共享电脑音频
+     * @param enable 是否启用
+     */
+    startShareSystemAudio(enable: boolean): Promise<NEResult<void>>;
+    /**
+     * 安装共享电脑音频驱动
+     */
+    installAudioCaptureDriver(): Promise<NEResult<void>>;
+}
+export default ScreenShareManager;

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

@@ -0,0 +1,84 @@
+import { NEResult } from 'neroom-types';
+export interface SecurityManager {
+    /**
+     * 开启等候室
+     */
+    enableWaitingRoomOnEntry(): Promise<NEResult<void>>;
+    /**
+     * 关闭等候室
+     * @param admitAll 是否准入当前等候室中的所有成员
+     */
+    disableWaitingRoomOnEntry(admitAll: boolean): Promise<NEResult<void>>;
+    /**
+     * 锁定会议
+     */
+    lockRoom(): Promise<NEResult<void>>;
+    /**
+     * 解锁会议
+     */
+    unlockRoom(): Promise<NEResult<void>>;
+    /**
+     * 启用会议黑名单
+     * @param enable 是否启用
+     */
+    enableRoomBlacklist(enable: boolean): Promise<NEResult<void>>;
+    /**
+     * 允许访客入会
+     * @param enable 是否允许
+     */
+    enableGuestJoin(enable: boolean): Promise<NEResult<void>>;
+    /**
+     * 隐藏头像
+     * @param hide 是否隐藏
+     */
+    changeAvatarStatus(hide: boolean): Promise<NEResult<void>>;
+    /**
+     * 变更聊天室权限
+     * @param crPerm 会内聊天室权限
+     * @param wtPrChat 等候室聊天权限
+     */
+    changeChatroomPermission(crPerm?: '1' | '2' | '3' | '4', wtPrChat?: '0' | '1'): Promise<NEResult<void>>;
+    /**
+     * 获取聊天室权限
+     */
+    getChatroomPermission(): Promise<NEResult<{
+        crPerm: '1' | '2' | '3' | '4';
+        wtPrChat: '0' | '1';
+    }>>;
+    /**
+     * 修改共享屏幕权限
+     * @param allow 是否允许
+     */
+    changeScreenSharePermission(allow: boolean): Promise<NEResult<void>>;
+    /**
+     * 修改解除静音权限
+     * @param allow 是否允许
+     */
+    changeUnmuteAudioBySelfPermission(allow: boolean): Promise<NEResult<void>>;
+    /**
+     * 修改开启视频权限
+     * @param allow 是否允许
+     */
+    changeUnmuteVideoBySelfPermission(allow: boolean): Promise<NEResult<void>>;
+    /**
+     * 修改自己改名权限
+     * @param allow 是否允许
+     */
+    changeUpdateNicknamePermission(allow: boolean): Promise<NEResult<void>>;
+    /**
+     * 修改共享白板权限
+     * @param allow 是否允许
+     */
+    changeWhiteboardPermission(allow: boolean): Promise<NEResult<void>>;
+    /**
+     * 修改互动批注权限
+     * @param allow 是否允许
+     */
+    changeAnnotationPermission(allow: boolean): Promise<NEResult<void>>;
+    /**
+     * 修改本地录制权限
+     * @param type 'onlyHost' | 'some' | 'all'
+     */
+    changeLocalRecordPermission(type: 'onlyHost' | 'some' | 'all'): Promise<NEResult<void>>;
+}
+export default SecurityManager;

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

@@ -0,0 +1,35 @@
+import { NEResult } from 'neroom-types';
+export interface CaptionMessage {
+    messageId: string;
+    speakerId: string;
+    speakerName: string;
+    content: string;
+    timestamp: number;
+    language: string;
+}
+export interface TranscriptionManager {
+    /**
+     * 是否已开启转写
+     */
+    isTranscriptionEnabled(): boolean;
+    /**
+     * 获取是否允许成员使用字幕
+     */
+    isAllowParticipantsEnableCaption(): boolean;
+    /**
+     * 开关字幕
+     * @param enable 是否启用
+     */
+    enableCaption(enable: boolean): Promise<number>;
+    /**
+     * 允许/不允许成员使用字幕
+     * @param allow 是否允许
+     */
+    allowParticipantsEnableCaption(allow: boolean): Promise<NEResult<null>>;
+    /**
+     * 检查字幕权限
+     * @param roomUuid 房间ID
+     */
+    checkCaptionPermission(roomUuid: string): Promise<boolean>;
+}
+export default TranscriptionManager;

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

@@ -0,0 +1,121 @@
+import { VideoFrameRate, VideoResolution } from '../../types/innerType';
+import { NEDeviceBaseInfo, NEDeviceSwitchInfo, NEResult, NERoomVideoView, NEVideoStreamType } from 'neroom-types';
+export interface VideoDevice {
+    deviceId: string;
+    deviceName: string;
+    isDefault?: boolean;
+}
+export interface VideoView {
+    element: HTMLElement;
+    userId?: string;
+    isLocal?: boolean;
+}
+export interface VideoManager {
+    /**
+     * 获取视频设备列表
+     */
+    getCameraDeviceList(): Promise<NEResult<NEDeviceBaseInfo[]>>;
+    /**
+     * 获取当前视频设备
+     */
+    getCameraDeviceId(): Promise<string | undefined>;
+    /**
+     * 会中设置当前视频设备
+     * @param deviceId 设备ID
+     */
+    setCameraDevice(deviceId: string): Promise<NEResult<NEDeviceSwitchInfo>>;
+    /**
+     * 会前检查设置当前视频设备
+     * @param deviceId 设备ID
+     */
+    setCameraDevicePreview(deviceId: string): Promise<NEResult<NEDeviceSwitchInfo>>;
+    /**
+     * 设置本地视频视图画布
+     * @param view 视频视图
+     */
+    setupLocalVideoCanvas(view: NERoomVideoView): Promise<NEResult<void>>;
+    /**
+     * 移除本地视频视图画布
+     */
+    removeLocalVideoCanvas(): Promise<NEResult<void>>;
+    setupVideoPreviewCanvas(view: NERoomVideoView): Promise<NEResult<void>>;
+    /**
+     * 开始预览
+     */
+    startVideoPreview(): Promise<NEResult<void>>;
+    /**
+     * 关闭预览
+     */
+    stopVideoPreview(): Promise<NEResult<void>>;
+    /**
+     * 设置视频分辨率
+     * @param resolution 分辨率
+     * @param frameRate 帧率
+     */
+    setVideoProfile(resolution: VideoResolution, frameRate?: VideoFrameRate): void | undefined;
+    /**
+     * 开启美颜
+     * @param enable 是否启用
+     * @param level 美颜级别 (0-10)
+     */
+    enableBeauty(enable: boolean, level?: number): Promise<NEResult<void>>;
+    /**
+     * 设置虚拟背景
+     * @param enable 是否启用
+     * @param path 背景图片URL
+     * @param force 是否强制
+     * @param type 背景类型
+     */
+    enableVirtualBackground(enable: boolean, path: string, force: boolean, type: number): Promise<NEResult<void>>;
+    /**
+     * 打开本端视频并发送
+     */
+    unmuteMyVideo(): Promise<NEResult<void>>;
+    /**
+     * 关闭本端视频取消发送
+     */
+    muteMyVideo(): Promise<NEResult<void>>;
+    /**
+     * 设置成员视频视图
+     * @param userId 用户ID
+     * @param view 视频视图
+     */
+    setupRemoteVideoCanvas(userId: string, view: NERoomVideoView): Promise<NEResult<void>>;
+    /**
+     * 设置成员辅流视频视图
+     * @param userId 用户ID
+     * @param view 视频视图
+     */
+    setupRemoteVideoSubStreamCanvas(userId: string, view: NERoomVideoView): Promise<NEResult<void>>;
+    /**
+     * 移除成员辅流视频视图
+     * @param userId 用户ID
+     */
+    removeRemoteVideoSubStreamCanvas(userId: string): Promise<NEResult<void>>;
+    /**
+     * 移除成员视频视图
+     * @param userId 用户ID
+     */
+    removeRemoteVideoCanvas(userId: string): Promise<NEResult<void>>;
+    /**
+     * 订阅远端视频流
+     * @param userId 用户ID
+     */
+    subscribeRemoteVideoStream(userId: string, streamType: NEVideoStreamType): Promise<NEResult<void>>;
+    /**
+     * 取消订阅远端视频流
+     * @param userId 用户ID
+     */
+    unsubscribeRemoteVideoStream(userId: string, streamType: NEVideoStreamType): Promise<NEResult<void>>;
+    /**
+     * 订阅远端视频辅流
+     * @param userUuid 用户ID
+     */
+    subscribeRemoteVideoSubStream(userUuid: string): Promise<NEResult<void>>;
+    /**
+     * 取消订阅远端视频辅流
+     * @param userUuid 用户ID
+     */
+    unsubscribeRemoteVideoSubStream(userUuid: string): Promise<NEResult<void>>;
+}
+export default VideoManager;

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

@@ -0,0 +1,58 @@
+import { NEResult, NEWaitingRoomInfo, NEWaitingRoomMember, NEWaitingRoomListener } from 'neroom-types';
+export interface WaitingRoomManager {
+    /**
+     * 获取等候室成员列表
+     * @param joinTime 起始时间戳，第一次传0
+     * @param size 每次获取的数量
+     * @param asc 是否升序
+     */
+    getWaitingRoomMemberList(time: number, limit: number, asc: boolean): Promise<NEResult<NEWaitingRoomMember[]>>;
+    /**
+     * 获取等候室信息
+     */
+    getWaitingRoomInfo(): NEWaitingRoomInfo;
+    /**
+     * 获取等候室配置
+     * @param roomUuid 房间UUID
+     */
+    getWaitingRoomConfig(roomUuid: string): Promise<{
+        wtPrChat: number;
+    }>;
+    /**
+     * 移至等候室
+     * @param userUuid 用户UUID
+     */
+    putInWaitingRoom(userUuid: string): Promise<NEResult<void>>;
+    /**
+     * 等候室准入
+     * @param userUuid 用户UUID
+     * @param autoAdmit 是否自动准入
+     */
+    admitMember(userUuid: string, autoAdmit?: boolean): Promise<NEResult<void>>;
+    /**
+     * 等候室移除
+     * @param userUuid 用户UUID
+     * @param notAllowJoin 是否不允许加入等候室
+     */
+    expelMember(userUuid: string, notAllowJoin?: boolean): Promise<NEResult<void>>;
+    /**
+     * 等候室全部准入
+     */
+    admitAllMembers(): Promise<NEResult<void>>;
+    /**
+     * 等候室全部移除
+     * @param disallowRejoin 是否不允许重新加入
+     */
+    expelAllMembers(disallowRejoin: boolean): Promise<NEResult<void>>;
+    /**
+     * 添加等候室事件监听器
+     * @param listener 监听器
+     */
+    addListener(listener: NEWaitingRoomListener): void;
+    /**
+     * 移除等候室事件监听器
+     * @param listener 监听器
+     */
+    removeListener(listener?: NEWaitingRoomListener): void;
+}
+export default WaitingRoomManager;