netender-web-sdk 1.0.0 → 1.1.0

package/dist/meeting-kit-lite/src/utils/common.d.ts

@@ -0,0 +1,11 @@
+import { DebugPrivateConfig, MeetingSetting } from '../types/innerType';
+export declare function getDefaultLanguage(): 'zh-CN' | 'en-US' | 'ja-JP';
+export declare function md5Password(password: string): string;
+export declare function generateTraceId(): string;
+export declare function debounce<T extends (...args: unknown[]) => unknown>(func: T, wait: number): (...args: Parameters<T>) => void;
+export declare function setLocalStorageSetting(str: string): void;
+export declare function createDefaultCaptionSetting(): MeetingSetting['captionSetting'];
+export declare function createDefaultSetting(): MeetingSetting;
+export declare function getLocalStorageSetting(): MeetingSetting;
+export declare function getDebugLocalStorage(): null | DebugPrivateConfig;
+export declare function isTestEnv(): boolean;

package/dist/meeting-kit-lite/src/utils/highAvailableRequest.d.ts

@@ -0,0 +1,10 @@
+import { NEDomainInfo } from 'neroom-types';
+/**
+ * 高可用请求结果类型
+ */
+export interface HighAvailableResult<T> {
+    domain: string;
+    result: T;
+}
+declare function highAvailableRequest<T = unknown>(request: (domain?: string) => Promise<T>, availableInfo?: NEDomainInfo, totalTimeout?: number): Promise<HighAvailableResult<T>>;
+export default highAvailableRequest;

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

@@ -0,0 +1,13 @@
+import { AttendeeOffType, BreakoutRoomInfo, MeetingPermission } from '../kit';
+import { NERoomCaptionTranslationLanguage } from 'neroom-types';
+export * from './common';
+export declare function isTestEnv(domain: string): boolean;
+export declare function serverLanguageToSettingASRTranslationLanguage(lang: string): NERoomCaptionTranslationLanguage;
+export declare function getThumbnailUrl(url: string): string;
+export declare function getMeetingPermission(value: number): MeetingPermission;
+export declare function getBreakoutRoomInLocalStorage(): BreakoutRoomInfo | undefined;
+export declare function formatDate(time: Date | number | string, fmt?: string): string;
+export declare function formatAudioOff(attendeeAudioOffType: AttendeeOffType | undefined, attendeeAudioOff: boolean): string;
+export declare function getIsElectron(): boolean;
+export declare function getH5App(): boolean;
+export declare function getIsRooms(): boolean;

package/dist/meeting-kit-lite/src/utils/logDebug.d.ts

@@ -0,0 +1,62 @@
+export type LogLevel = 'log' | 'trace' | 'debug' | 'info' | 'warn' | 'error';
+export declare const LevelMap: Readonly<Record<LogLevel, number>>;
+export interface ILogger {
+    log?: (...args: unknown[]) => void;
+    info?: (...args: unknown[]) => void;
+    warn?: (...args: unknown[]) => void;
+    error?: (...args: unknown[]) => void;
+    trace?: (...args: unknown[]) => void;
+    debug?: (...args: unknown[]) => void;
+}
+export interface LogDebugOptions {
+    level?: LogLevel;
+    moduleName?: string;
+    actionType?: string;
+    logger?: Console;
+}
+export declare class LogDebug {
+    private level;
+    private moduleName;
+    private appKey;
+    private isOpenEventTracking;
+    private actionType;
+    private logger;
+    constructor({ level, moduleName, actionType, logger, }: LogDebugOptions);
+    setModuleName(moduleName: string): void;
+    setLogger(logger: ILogger): void;
+    setLevel(level: LogLevel): void;
+    setEventTracking(isOpen: boolean): void;
+    setAppKey(appKey: string): void;
+    private shouldPrint;
+    log(...msgs: unknown[]): void;
+    trace(...msgs: unknown[]): void;
+    debug(...msgs: unknown[]): void;
+    info(...msgs: unknown[]): void;
+    warn(...msgs: unknown[]): void;
+    error(...msgs: unknown[]): void;
+    private _print;
+    private _genTime;
+    private _sensitive;
+    private _replace;
+    private _replacePos;
+}
+export declare class ApiLog extends LogDebug {
+    constructor({ moduleName }?: {
+        moduleName?: string;
+    });
+}
+export declare class ApiResultLog extends LogDebug {
+    constructor({ moduleName }?: {
+        moduleName?: string;
+    });
+}
+export declare class ApiEventLog extends LogDebug {
+    constructor({ moduleName }?: {
+        moduleName?: string;
+    });
+}
+export declare class UILog extends LogDebug {
+    constructor({ moduleName }?: {
+        moduleName?: string;
+    });
+}

package/dist/meeting-kit-lite/src/utils/report.d.ts

@@ -0,0 +1,8 @@
+import { EventPriority, IntervalEvent as IEvent } from '@xkit-yx/utils';
+export declare class IntervalEvent extends IEvent {
+    static appKey: string;
+    constructor(options: {
+        eventId: string;
+        priority: EventPriority;
+    });
+}

package/dist/meeting-kit-lite/src/utils/throwError.d.ts

@@ -0,0 +1,6 @@
+export type CommonError = {
+    code?: number;
+    message?: string;
+    msg?: string;
+};
+export declare function throwError(message: string, error?: CommonError): import("neroom-types").NEResult<unknown>;

package/dist/tender-sdk-web/src/index.d.ts

@@ -0,0 +1,14 @@
+export { NEMeetingKit as NETenderWebSDK } from 'nemeeting-kit-lite';
+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/pre_meeting_manager';
+export * from './interface/types';
+export * from 'neroom-types';

package/dist/tender-sdk-web/src/interface/account_manager.d.ts

@@ -0,0 +1,42 @@
+import { NEAccountInfo } from './types';
+export interface AccountManager {
+    /**
+     * 账号登录
+     * @param options 登录选项
+     */
+    loginByToken(options: {
+        accountId: string;
+        accountToken: string;
+    }): Promise<NEAccountInfo>;
+    /**
+     * 账号密码登录
+     * @param options 登录选项
+     */
+    loginByPassword(options: {
+        username: string;
+        password: string;
+    }): 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/tender-sdk-web/src/interface/audio_manager.d.ts

@@ -0,0 +1,146 @@
+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>>;
+    /**
+     * 开始检测扬声器
+     */
+    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>>;
+    /**
+     * 音频是否混音播放
+     * web端sdk专用（C++忽略）
+     */
+    setMixAudioStream(need: boolean): void;
+    /**
+     * 开启本端音频发送
+     */
+    unmuteMyAudio(need?: boolean): void;
+    /**
+     * 关闭本端音频发送
+     */
+    muteMyAudio(): Promise<NEResult<void>>;
+    /**
+     * 开启音频特效
+     */
+    enableAudioEffect?: () => Promise<void>;
+    /**
+     * 设置变声效果
+     * web端sdk专用
+     */
+    setAudioEffect?: (type: number, value: number | Array<number> | ReverbConfig) => void;
+    /**
+     * 关闭音频特效
+     * web端sdk专用
+     */
+    disableAudioEffect?: () => Promise<void>;
+    /**
+     * 开启AI降噪
+     * web端sdk专用
+     */
+    enableAIDenoise?: () => Promise<void>;
+    /**
+     * 设置背景人声消除阈值
+     * web端sdk专用
+     */
+    setVoiceGate?: (level: number) => void;
+    /**
+     * 关闭AI降噪
+     * web端sdk专用
+     */
+    disableAIDenoise?: () => Promise<void>;
+}
+export default AudioManager;

package/dist/tender-sdk-web/src/interface/chatroom_manager.d.ts

@@ -0,0 +1,178 @@
+import { NEResult } from 'neroom-types';
+export type NERoomChatMessageType = 'text' | 'image' | 'audio' | 'video' | 'file' | 'geo' | 'custom' | 'tip' | 'notification';
+export interface Progress {
+    total?: string;
+    loaded?: string;
+    percentage: number;
+    percentageText?: string;
+}
+/**
+ * 房间内聊天消息
+ */
+export type NERoomChatMessage = {
+    /**
+     * 消息 id
+     */
+    messageUuid?: string;
+    /**
+     * 客户端类型
+     */
+    fromClientType: 'Android' | 'iOS' | 'PC' | 'Web' | 'Mac';
+    /**
+     * 消息类型
+     */
+    messageType: NERoomChatMessageType;
+    /**
+     * 发送端用户ID。如果为空字符串，则说明该用户可能未加入房间内。
+     */
+    fromUserUuid: string;
+    /**
+     * 发送端昵称
+     */
+    fromNick: string;
+    /**
+     * 接收端; 为空表示聊天室全体成员
+     */
+    toUserUuidList?: string[];
+    /**
+     * 消息时间戳
+     */
+    time: number;
+    /**
+     * 消息类型
+     */
+    type: string;
+    /**
+     * 文本内容
+     */
+    text: string;
+    /**
+     * 消息状态
+     */
+    status: string;
+    /**
+     * 附加信息
+     */
+    attach?: {
+        from: string;
+        fromNick: string;
+        type: string;
+        to: string[];
+        toNick: string[];
+        url: string;
+        name: string;
+        msgId: string;
+        msgTime: number;
+        id: number;
+        operator: string;
+    };
+    /**
+     * 消息来源
+     */
+    from: string;
+    /**
+     * 消息是否来自自己
+     */
+    isMe?: boolean;
+    /**
+     * 重发
+     */
+    resend?: boolean;
+    /**
+     * 客户端唯一ID
+     */
+    idClient: string;
+    /**
+     * 文件
+     */
+    file?: {
+        name: string;
+        ext: string;
+        size: number;
+        url: string;
+        filePath: string;
+        w: number;
+        h: number;
+    };
+    /**
+     * 自定义信息
+     */
+    custom?: string;
+    /**
+     * 0: 会内聊天室；1: 等候室
+     */
+    chatroomType?: number;
+    /**
+     *  临时文件，用于重发
+     */
+    tempFile?: File;
+    /**
+     * 是否是私聊
+     */
+    isPrivate?: boolean;
+    /**
+     * 发送给的昵称
+     */
+    toNickname?: string;
+    /**
+     * 头像
+     */
+    fromAvatar?: string;
+    progress: Progress;
+};
+export type NERoomChatMessageExt = {
+    url: string;
+    displayName: string;
+    size: number;
+    md5: string;
+    extension: string;
+    width: number;
+    height: number;
+    attachStr?: string;
+};
+export type FileEx = File & {
+    base64?: string;
+    url?: string;
+    filePath?: string;
+    height?: number;
+    width?: number;
+};
+export interface ChatroomManager {
+    /**
+     * 发送文本消息
+     * @param content 消息内容
+     * @param toUserUuids 私聊用户UUID（可选）
+     */
+    sendTextMessage(idClient: string, content: string, isWaitingRoom?: boolean, toUserUuids?: string[]): Promise<NEResult<NERoomChatMessage>>;
+    /**
+     * 发送文件图片消息
+     * @param type 文件类型
+     * @param file 文件对象
+     * @param toUserUuids 私聊用户UUID（可选）
+     */
+    sendFileMessage(idClient: string, type: 'image' | 'file', file: FileEx, isWaitingRoom?: boolean, toUserUuids?: string[]): Promise<NEResult<NERoomChatMessage>>;
+    /**
+     * 撤回消息
+     * @param messageId 消息ID
+     */
+    recallMessage(msg: NERoomChatMessage): Promise<NEResult<void>>;
+    /**
+     * 取消发送
+     * @param messageId 消息ID
+     */
+    cancelSendFileMessage(msg: NERoomChatMessage): Promise<NEResult<void>>;
+    /**
+     * 下载附件
+     * web端不支持
+     * @param msg 消息
+     * @param path 保存路径
+     */
+    downloadAttachment(msg: NERoomChatMessage, path: string): Promise<NEResult<void>>;
+    /**
+     * 取消下载附件
+     * web端不支持
+     * @param msg 消息
+     */
+    cancelDownloadAttachment(msg: NERoomChatMessage): Promise<NEResult<void>>;
+}
+export default ChatroomManager;

package/dist/tender-sdk-web/src/interface/invite_manager.d.ts

@@ -0,0 +1,27 @@
+import { NEESearchAccountInfo, NEAccountInfoListResponse } from './types';
+export interface InviteInfo {
+    meetingNum: string;
+    meetingId: number;
+    subject: string;
+    password?: string;
+    inviteUrl: string;
+    shortInviteUrl: string;
+}
+export interface ContactInfo {
+    userUuid: string;
+    nickname: string;
+    avatar?: string;
+}
+export interface InviteManager {
+    /**
+     * 获取账号信息列表
+     * @param userUuids 用户UUID列表
+     */
+    getAccountInfoList(userUuids: string[]): Promise<NEAccountInfoListResponse>;
+    /**
+     * 根据手机号获取账号信息
+     * @param phone 手机号
+     */
+    searchAccountInfoByPhone(phone: string): Promise<NEESearchAccountInfo[]>;
+}
+export default InviteManager;

package/dist/tender-sdk-web/src/interface/meeting_kit.d.ts

@@ -0,0 +1,71 @@
+import { NEGlobalEventListener, NEServerConfig, NEResult } from 'neroom-types';
+import AccountManager from './account_manager';
+import MeetingManager from './meeting_manager';
+import AudioManager from './audio_manager';
+import VideoManager from './video_manager';
+import SecurityManager from './security_manager';
+import InviteManager from './invite_manager';
+import MemberManager from './member_manager';
+import ChatroomManager from './chatroom_manager';
+import ScreenShareManager from './screen_share_manager';
+import PreMeetingManager from './pre_meeting_manager';
+export type NEMeetingKitServerConfig = NEServerConfig;
+export type ExceptionHandler = {
+    onError: (code: number) => void;
+};
+export type NEMeetingKitInitConfig = {
+    /**
+     * 是否开启日志打印(默认为true)
+     */
+    debug?: boolean;
+    /**
+     * 是否开启日志上(报默认为true)
+     */
+    eventTracking?: boolean;
+    /**
+     * 会议appKey
+     */
+    appKey: string;
+    /**
+     * 私有化配置使用，如果配置该字段则会从服务端对应接口拉取配置文件。但是优先级低于其他私有化配置字段，如果配置过其他字段则该配置不生效
+     */
+    serverUrl?: string;
+    /**
+     * 是否读取私有化配置文件(C++使用)
+     */
+    useAssetServerConfig?: boolean;
+    serverConfig?: NEServerConfig;
+    logPath?: string;
+};
+export interface NETenderWebSDK {
+    /**
+     * 初始化
+     * @param config 配置信息
+     */
+    initialize(config: NEMeetingKitInitConfig): Promise<NEResult<void>>;
+    /**
+     * 反初始化
+     */
+    unInitialize(): Promise<NEResult<void>>;
+    getAccountManager(): AccountManager | undefined;
+    getMeetingManager(): MeetingManager | undefined;
+    getAudioManager(): AudioManager | undefined;
+    getVideoManager(): VideoManager | undefined;
+    getSecurityManager(): SecurityManager | undefined;
+    getInviteManager(): InviteManager | undefined;
+    getMemberManager(): MemberManager | undefined;
+    getChatroomManager(): ChatroomManager | undefined;
+    getScreenShareManager(): ScreenShareManager | undefined;
+    getPreMeetingManager(): PreMeetingManager | undefined;
+    addGlobalEventListener: (listener: NEGlobalEventListener) => void;
+    removeGlobalEventListener: (listener: NEGlobalEventListener) => void;
+    /**
+     * 写日志
+     * @param moduleName 模块名称
+     * @param level 日志级别
+     * @param content 日志内容
+     */
+    writeLog(moduleName: string, level: number, content: string): void;
+}
+export type { NEGlobalEventListener, NEServerConfig, NEDeviceBaseInfo, NERoomListener, NEStatsListener, NEMessageChannelListener, NEResult, NERoomRtcScreenCaptureSource, NERoomScreenConfig, NERoomStopScreenConfig, NEDeviceSwitchInfo, NERoomVideoView, NEVideoStreamType, NEWaitingRoomInfo, NEWaitingRoomMember, NEWaitingRoomListener, NERoomMemberInviteState, NERoomMemberInviteType, NERtcEx, NEClientType, } from 'neroom-types';
+export * from './types';

package/dist/tender-sdk-web/src/interface/meeting_manager.d.ts

@@ -0,0 +1,65 @@
+import { NERoomListener, NEStatsListener, NEMessageChannelListener } from 'neroom-types';
+import { NEMeetingCreateOptions, NEMeetingJoinOptions, NEMeetingSDKInfo } from './types';
+export interface MeetingManager {
+    /**
+     * 创建房间
+     * @param options 创建会议选项
+     */
+    createMeeting(options: NEMeetingCreateOptions): Promise<void>;
+    /**
+     * 加入房间
+     * @param options 加入会议选项
+     */
+    joinMeeting(options: NEMeetingJoinOptions): Promise<void>;
+    /**
+     * 重新加入房间(被准入后重新加入房间)
+     */
+    rejoinAfterAdmittedToRoom(): Promise<void>;
+    /**
+     * 离开房间
+     * @param closeIfHost 是否结束会议
+     */
+    leaveMeeting(closeIfHost: boolean): Promise<void>;
+    /**
+     * 结束房间
+     */
+    endMeeting(): Promise<void>;
+    /**
+     * 获取会议信息
+     */
+    getMeetingInfo(): NEMeetingSDKInfo | null;
+    /**
+     * 添加会议事件监听器
+     * @param listener 监听器
+     */
+    addMeetingListener(listener: NERoomListener): void;
+    /**
+     * 移除会议事件监听器
+     * @param listener 监听器
+     */
+    removeMeetingListener(listener?: NERoomListener): void;
+    /**
+     * 获取房间监Rtc听器
+     */
+    addRtcStatsListener(listener: NEStatsListener): void;
+    /**
+     * 移除房间Rtc监听器
+     * @param listener 监听器
+     */
+    removeRtcStatsListener(listener: NEStatsListener): void;
+    /**
+     * 添加自定义透传消息监听
+     * @param listener 消息监听器
+     */
+    addMessageChannelListener(listener: NEMessageChannelListener): void;
+    /**
+     * 移除自定义透传消息监听
+     * @param listener 消息监听器
+     */
+    removeMessageChannelListener(listener: NEMessageChannelListener): void;
+    /**
+     * 释放会议资源,监听到离开或者结束会议事件后需调用
+     */
+    releaseMeeting(): void;
+}
+export default MeetingManager;