netender-web-sdk 1.0.1 → 1.1.0

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;

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

@@ -0,0 +1,85 @@
+import { NEMember } from './types';
+import { NEResult } from 'neroom-types';
+export interface MemberInfo {
+    userUuid: string;
+    nickname: string;
+    avatar?: string;
+    role: 'host' | 'coHost' | 'attendee';
+    isAudioMuted: boolean;
+    isVideoMuted: boolean;
+    isScreenSharing: boolean;
+    isWhiteboardSharing: boolean;
+    isInWaitingRoom: boolean;
+    isFocus: boolean;
+}
+export interface MemberManager {
+    /**
+     * 获取成员列表
+     */
+    getMemberList(): NEMember[];
+    /**
+     * 静音
+     * @param userUuid 用户UUID
+     */
+    muteMemberAudio(userUuid: string): Promise<NEResult<void>>;
+    /**
+     * 关闭视频
+     * @param userUuid 用户UUID
+     */
+    muteMemberVideo(userUuid: string): Promise<NEResult<void>>;
+    /**
+     * 解除静音
+     * @param userUuid 用户UUID
+     */
+    unmuteMemberAudio(userUuid: string): Promise<NEResult<void>>;
+    /**
+     * 开启视频
+     * @param userUuid 用户UUID
+     */
+    unmuteMemberVideo(userUuid: string): Promise<NEResult<void>>;
+    /**
+     * 关闭音视频
+     * @param userUuid 用户UUID
+     */
+    muteVideoAndAudio(userUuid: string): Promise<NEResult<void>>;
+    /**
+     * 开启音视频
+     * @param userUuid 用户UUID
+     */
+    unmuteVideoAndAudio(userUuid: string): Promise<NEResult<void>>;
+    /**
+     * 全部静音
+     */
+    muteAllAudio(): Promise<NEResult<void>>;
+    /**
+     * 解除全部静音
+     */
+    unmuteAllAudio(): Promise<NEResult<void>>;
+    /**
+     * 全体开启视频
+     */
+    unmuteAllVideo(): Promise<NEResult<void>>;
+    /**
+     * 全体关闭视频
+     */
+    muteAllVideo(): Promise<NEResult<void>>;
+    /**
+     * 关闭屏幕共享
+     * @param userUuid 用户UUID
+     */
+    stopMemberScreenShare(userUuid: string): Promise<NEResult<void>>;
+    /**
+     * 手放下所有成员
+     */
+    handsDownAll(): Promise<void>;
+    /**
+     * 手放下单个成员
+     * @param userUuid 用户UUID 如果为空默认为自己
+     */
+    handsDown(userUuid?: string): Promise<NEResult<null>>;
+    /**
+     * 举手
+     */
+    handsUp(): Promise<NEResult<null>>;
+}
+export default MemberManager;

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

@@ -0,0 +1,36 @@
+import { NEMeetingInfo, NEMeetingCreateOptions, NEMeetingGetListBySizeParams, NEScheduledMember } from './types';
+export interface PreMeetingManager {
+    /**
+     * 获取会议列表
+     * @param options 获取会议列表选项
+     */
+    getMeetingListBySize(options: NEMeetingGetListBySizeParams): Promise<NEMeetingInfo[]>;
+    /**
+     * 预约房间
+     * @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[]>;
+    /**
+     * 根据会议号获取会议信息
+     * @param meetingNum 会议号
+     */
+    getMeetingInfoByMeetingNum(meetingNum: string): Promise<NEMeetingInfo>;
+}
+export default PreMeetingManager;

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

@@ -0,0 +1,35 @@
+import { NEResult, NERoomRtcScreenCaptureSource, NERoomScreenConfig, NERoomStopScreenConfig } from 'neroom-types';
+export type NERoomStartScreenConfigEnhanced = NERoomScreenConfig & {
+    preferMotion?: boolean;
+    isLinux?: boolean;
+};
+export interface ScreenShareManager {
+    /**
+     * 获取共享提示信息
+     */
+    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/tender-sdk-web/src/interface/security_manager.d.ts

@@ -0,0 +1,17 @@
+import { NEResult } from 'neroom-types';
+export interface SecurityManager {
+    /**
+     * 变更聊天室权限
+     * @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';
+    }>>;
+}
+export default SecurityManager;