netender-web-sdk 1.0.1 → 1.1.1

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

@@ -0,0 +1,563 @@
+import { NERoomMemberInviteState, NERoomMemberInviteType, NERtcEx, NEClientType } from 'neroom-types';
+export declare enum NEMeetingInviteStatus {
+    unknown = 0,
+    waitingCall = 1,
+    calling = 2,
+    rejected = 3,
+    noAnswer = 4,
+    error = 5,
+    removed = 6,
+    canceled = 7,
+    waitingJoin = 8,
+    busy = 9
+}
+export type NEProps = unknown;
+export interface NEMember {
+    /**
+     * 音频是否连接
+     */
+    isAudioConnected: boolean;
+    /**
+     * 音频是否打开
+     */
+    isAudioOn: boolean;
+    /**
+     * 当前成员是否在聊天室内
+     */
+    isInChatroom: boolean;
+    /**
+     * 当前成员是否在RTC房间内
+     */
+    isInRtcChannel: boolean;
+    /**
+     * 当前成员是否正在屏幕共享中
+     */
+    isSharingScreen: boolean;
+    /**
+     * 当前成员是否正在屏幕共享中
+     */
+    isSharingSystemAudio: boolean;
+    /**
+     * 是否是屏幕共享的视图
+     */
+    isSharingScreenView?: boolean;
+    /**
+     * 视频是否打开
+     */
+    isVideoOn: boolean;
+    /**
+     * 当前成员是否正在共享白板
+     */
+    isSharingWhiteboard?: boolean;
+    /**
+     * 当前成员是否正在共享白板
+     */
+    isSharingWhiteboardView?: boolean;
+    /**
+     * 当前成员是否正在本地录制
+     */
+    isLocalRecording?: boolean;
+    /**
+     * 当前成员是否有本地录制权限
+     */
+    localRecordAvailable?: boolean;
+    /**
+     * 用户名
+     */
+    name: string;
+    /**
+     * 属性
+     */
+    properties: {
+        wbDrawable?: {
+            value: '1' | '0';
+        };
+        /** 当前成员是否在系统通过状态 */
+        phoneState?: {
+            value: '1' | '0';
+        };
+        /** 当前成员标签 */
+        tag?: {
+            value: string;
+        };
+        /** 当前成员是否开启扬声器 */
+        speakerOn?: {
+            value: '1' | '0';
+        };
+        [key: string]: NEProps;
+    };
+    /**
+     * 角色
+     */
+    role: Role;
+    /**
+     * 用户id
+     */
+    uuid: string;
+    /**
+     * 用户的终端类型[NEClientType]
+     */
+    clientType: NEClientType;
+    /**
+     * 当前成员邀请状态
+     */
+    inviteState: NEMeetingInviteStatus | NERoomMemberInviteState;
+    inviteType?: NERoomMemberInviteType;
+    /**
+     * @ignore 不对外暴露
+     */
+    rtcUid?: number;
+    /**
+     * 当前成员是否举手
+     */
+    isHandsUp?: boolean;
+    /**
+     * @ignore 不对外暴露
+     */
+    hide?: boolean;
+    volume?: number;
+    avatar?: string;
+}
+export interface ServerError {
+    msg: string;
+    message: string;
+    code: number;
+}
+export type NEError = ServerError | Error;
+export type userUuid = string;
+/**
+ * 角色
+ */
+export declare enum Role {
+    /** 参会者 */
+    member = "member",
+    /** 主持人 */
+    host = "host",
+    /** 联席主持人 */
+    coHost = "cohost",
+    /** 影子用户 */
+    observer = "observer",
+    /** 访客 */
+    guest = "guest",
+    /** 屏幕共享者 */
+    screenSharer = "screen_sharer",
+    /** 专家 */
+    evaluator = "evaluator",
+    /** 投标者 */
+    bidder = "bidder"
+}
+export type NEMeetingRoleType = Role;
+/**
+ * 视频分辨率
+ */
+export type VideoResolution = 180 | 480 | 720 | 1080;
+/**
+ * 视频帧率
+ */
+export type VideoFrameRate = 5 | 10 | 15 | 20 | 25;
+/**
+ * 全局事件监听
+ */
+export interface GlobalEventListener {
+    /**
+     * rtc engine 初始化前回调
+     */
+    beforeRtcEngineInitialize?: (meetingId: string) => void;
+    /**
+     * rtc engine 初始化后回调
+     */
+    afterRtcEngineInitialize?: (meetingId: string, rtcWrapper: RtcWrapper) => void;
+    /**
+     * rtc engine 销毁前回调
+     */
+    beforeRtcEngineRelease?: (meetingId: string, rtcWrapper: RtcWrapper) => void;
+}
+/**
+ * RTC实例包装类，可获取RTC实例，添加/删除RTC回调
+ */
+export interface RtcWrapper {
+    /**
+     * 获取RTC实例
+     */
+    rtcEngine: NERtcEx;
+}
+export declare enum NEChatMessageNotificationType {
+    barrage = 0,
+    bubble = 1,
+    noRemind = 2
+}
+export type SaveSettingInterface = {
+    [key: string]: string | number | boolean | Record<string, string | number | boolean | Record<string, string | number | boolean>>;
+};
+export type ServiceBundle = {
+    /** 会议服务 */
+    name: string;
+    /** 会议服务过期时间: -1 永不过期 */
+    expireTimeStamp: number;
+    /** 会议服务过期提示 */
+    expireTip: string;
+    /** 会议服务最大人数 */
+    maxMembers: number;
+    /** 套餐支持的最大时长，以分钟为单位，小于0或为空表示不限时长 */
+    maxMinutes: number;
+    /** @deprecated 请使用 maxMembers */
+    meetingMaxMembers: number;
+    /** @deprecated 请使用 maxMinutes */
+    meetingMaxMinutes: number;
+};
+export type NEAccountInfo = {
+    /** 用户 */
+    userUuid: string;
+    /** 用户token */
+    userToken: string;
+    /** 用户昵称 */
+    nickname: string;
+    /** 个人会议号 */
+    privateMeetingNum: string;
+    /** @deprecated 请使用 {@link NEAccountInfo#userUuid} */
+    account?: string;
+    /** 用户头像 */
+    avatar?: string;
+    /** 用户手机号 */
+    phoneNumber?: string;
+};
+export type InnerAccountInfo = {
+    settings: {
+        asrTranslationLanguage: string;
+        beauty: {
+            level: number;
+        };
+        captionBilingual: boolean;
+        transcriptionBilingual: boolean;
+    };
+};
+export interface EnterPriseInfo {
+    appKey: string;
+    appName: string;
+    idpList: Array<IdpInfo>;
+    ssoLevel: number;
+}
+export interface IdpInfo {
+    id: number;
+    name: string;
+    type: number;
+}
+export interface NEResult<T = null> {
+    code: number;
+    msg?: string | null;
+    message?: string | null;
+    data: T;
+    requestId?: string;
+    cost?: number;
+}
+export interface DebugPrivateConfig {
+    enableCloudProxy: boolean;
+    privateConfigUrl: string;
+}
+/**
+ * 音频降噪模式
+ */
+export declare enum NEAudioAINSMode {
+    /**
+     * 关闭
+     */
+    NERTCAudioAINSModeOff = 0,
+    /**
+     * 正常
+     */
+    NERTCAudioAINSModeNormal = 1,
+    /**
+     * 增强
+     */
+    NERTCAudioAINSModeEnhanced = 2
+}
+export interface LoginUserInfo {
+    username: string;
+    userUuid: string;
+    userToken: string;
+    nickname: string;
+    privateMeetingNum: string;
+    initialPassword?: boolean;
+    shortMeetingNum: string;
+    sipCid: string;
+    avatar: string;
+    phoneNumber: string;
+    email: string;
+    settings: Record<string, unknown>;
+    serviceBundle: {
+        name: string;
+        meetingMaxMinutes: number;
+        meetingMaxMembers: number;
+    };
+    appKey?: string;
+}
+export declare enum MeetingErrorCode {
+    MeetingNumIncorrect = -5,
+    ReuseIMError = 112001,
+    RtcNetworkError = 10002,// rtc所有的服务器地址都连接失败 <NETWORK_ERROR 10002>
+    NoPermission = 10212,// 无权限
+    RepeatJoinRtc = 30004
+}
+export declare enum StaticReportType {
+    MeetingKit_login = "MeetingKit_login",
+    Account_info = "account_info",
+    Roomkit_login = "roomkit_login",
+    MeetingKit_start_meeting = "MeetingKit_start_meeting",
+    MeetingKit_join_meeting = "MeetingKit_join_meeting",
+    Create_room = "create_room",
+    Join_room = "join_room",
+    Join_rtc = "join_rtc",
+    Server_join_rtc = "server_join_rtc",
+    Anonymous_login = "anonymous_login",
+    Meeting_info = "meeting_info",
+    MeetingKit_meeting_end = "MeetingKit_meeting_end",
+    MeetingKit_access_denied = "MeetingKit_access_denied"
+}
+export interface ApiResult<T = null> {
+    code: number;
+    msg?: string | null;
+    message?: string | null;
+    data: T;
+    requestId?: string;
+    cost?: string;
+}
+export declare enum RecordState {
+    NotStart = "notStart",
+    Recording = "recording",
+    Starting = "starting",
+    Stopping = "stopping"
+}
+export declare enum LocalRecordState {
+    NotStart = "notStart",
+    Recording = "recording",
+    Starting = "starting",
+    Stopping = "stopping"
+}
+export declare enum NEChatPermission {
+    FREE_CHAT = 1,
+    PUBLIC_CHAT_ONLY = 2,
+    PRIVATE_CHAT_HOST_ONLY = 3,
+    NO_CHAT = 4
+}
+export type RoleType = 'host' | 'evaluator' | 'bidder' | 'supervise';
+export interface NEScheduledMember {
+    userUuid: string;
+    role: RoleType;
+}
+export interface NEMeetingScheduledMember {
+    userUuid: string;
+    role: RoleType;
+}
+export interface NEMeetingInfo {
+    localMember?: {
+        userUuid: string;
+        name: string;
+        role: RoleType;
+    };
+    /** 会议id */
+    meetingId: number;
+    /** 会议号 */
+    meetingNum: string;
+    /** 房间uuid */
+    roomUuid: string;
+    /** 会议状态 */
+    state: number;
+    /** 会议开始时间 */
+    startTime: number;
+    /** 会议结束时间 */
+    endTime: number;
+    /** 会议主题 */
+    subject: string;
+    /** 房间拥有者 uuid */
+    ownerUserUuid: string;
+    /** 房间拥有者 用户名 */
+    ownerNickname: string;
+    /** 预约指定角色的成员  */
+    scheduledMembers?: NEMeetingScheduledMember[];
+    /** 是否开启云录制 */
+    noCloudRecord?: boolean;
+    /** 是否开启聊天室 */
+    noChat?: boolean;
+    /** 配置会议是否默认开启等候室 */
+    enableWaitingRoom: boolean;
+}
+export interface NEMeetingSDKInfo {
+    localMember: NEMember;
+    myUuid: string;
+    hostUuid: string;
+    hostName: string;
+    activeSpeakerUuid: string;
+    isSupportChatroom: boolean;
+    subject: string;
+    startTime: number;
+    endTime: number;
+    type: number;
+    ownerUserUuid: string;
+    rtcStartTime: number;
+    roomArchiveId: string;
+    meetingNum: string;
+    meetingId?: number;
+    isWaitingRoomEnabled?: boolean;
+    inWaitingRoom?: boolean;
+    /** 房间最大人数 */
+    maxMembers?: number;
+    /**
+     * 会议录制状态
+     */
+    isCloudRecording: boolean;
+    /** 加入会议的时间 */
+    joinMeetingTime: number;
+    isBreakoutRoom?: boolean;
+}
+export interface GetAccountInfoListResponse {
+    meetingAccountListResp: SearchAccountInfo[];
+    notFindUserUuids: string[];
+}
+export interface SearchAccountInfo {
+    role?: RoleType;
+    disabled?: boolean;
+    inInviting?: boolean;
+    userUuid: string;
+    name: string;
+    avatar?: string;
+    dept?: string;
+    phoneNumber?: string;
+}
+export interface NEESearchAccountInfo {
+    role?: RoleType;
+    disabled?: boolean;
+    inInviting?: boolean;
+    userUuid: string;
+    name: string;
+    avatar?: string;
+    dept?: string;
+    phoneNumber?: string;
+}
+export interface NEAccountInfoListResponse {
+    accountInfoList: NEAccountInfo[];
+}
+export interface initOptions {
+    appKey: string;
+    serverUrl: string;
+}
+export interface TenderKitOptions {
+    containerId?: string;
+    onError?: (error: Error) => void;
+}
+export interface NEMeetingCreateOptions {
+    /** 会议号（字符串类型），原先使用meetingId后续兼容meetingNum */
+    meetingNum?: string;
+    /** 用户昵称 */
+    nickname: string;
+    /** 会议密码 */
+    password?: string;
+    /** 成员标签 */
+    memberTag?: string;
+    /** 是否禁用聊天功能 */
+    noChat?: boolean;
+    /** 是否禁用白板功能 */
+    noWhiteboard?: boolean;
+    /** 是否禁用字幕功能 */
+    noCaptions?: boolean;
+    /** 组织名称 */
+    orgName?: string;
+    /** 用户头像URL */
+    avatar?: string;
+    /**
+     * 视频分辨率及帧率设置
+     */
+    videoProfile?: {
+        resolution: VideoResolution;
+        frameRate: VideoFrameRate;
+    };
+    /** 加入会议超时时间（毫秒） */
+    joinTimeout?: number;
+    /** 会话标识 */
+    session?: string;
+    /** 会议子类型，0 默认普通会议，1 个人录音秒录 */
+    subType?: number;
+    /** 会议主题 */
+    subject?: string;
+    /** 会议开始时间戳 */
+    startTime?: number;
+    /** 会议结束时间戳 */
+    endTime?: number;
+    /** 是否开启等候室 */
+    enableWaitingRoom?: boolean;
+    cloudRecordConfig?: {
+        enable: boolean;
+    };
+}
+export interface NEMeetingGetListBySizeParams {
+    states?: number[];
+    offset?: number;
+    size?: number;
+}
+export interface RolePermission {
+    /** 入会前进入音视频检测 */
+    detectMedia: boolean;
+    /** 查看本人视频 */
+    viewOwnVideo: boolean;
+    /** 听房间其他人音频 */
+    hearOthersAudio: boolean;
+    /** 查看房间其他人视频 */
+    viewOthersVideo: boolean;
+    /** 查看房间屏幕共享画面 */
+    viewScreenShare: boolean;
+    /** 音频操作权限（包含显示按钮、开关音频、选择设备） */
+    audioControl: boolean;
+    /** 摄像头操作权限（包含显示按钮、开关摄像头、选择设备） */
+    videoControl: boolean;
+    /** 显示屏幕共享按钮 */
+    showScreenShareButton: boolean;
+    /** 入会强制开启屏幕共享 */
+    forceScreenShare: boolean;
+    /** 显示变声按钮 */
+    showVoiceEffectButton: boolean;
+    /** 降噪权限 */
+    showDenoiseButton: boolean;
+    /** 举手操作权限（包含显示按钮、举手、放下举手） */
+    raiseHandControl: boolean;
+    /** 默认进入等候室，废弃，等候室开启只能由服务端控制 */
+    /** 查看聊天 */
+    viewChatRoom: boolean;
+    /** 查看聊天上下文记录 */
+    viewChatHistory: boolean;
+    /** 发送消息权限,该权限用于处理禁言状态 */
+    sendChatMessage: boolean;
+    /****** 服务端控制相关 ******/
+    /** 服务端操作摄像头 */
+    serverControlCamera: boolean;
+    /** 远端控制静音/解除静音 */
+    serverControlAudio: boolean;
+    /** 查看参会成员列表 */
+    viewMemberList: boolean;
+    /** 单个成员静音 */
+    muteSingleMember: boolean;
+    /** 全体成员静音 */
+    muteAllMembers: boolean;
+    /** 设置聊天权限 */
+    setChatPermission: boolean;
+    /** 操作成员转入/移除等候室 */
+    serverControlWaitingRoom: boolean;
+    /** 控制成员举手 */
+    serverControlHandsUp: boolean;
+    /****** 默认值 ******/
+    /** 默认打开音频 */
+    defaultOnAudio: boolean;
+    /** 默认打开视频 */
+    defaultOnVideo: boolean;
+    /** 默认开启降噪 */
+    defaultDenoise: boolean;
+    /** 默认降噪等级 */
+    defaultDenoiseLevel: number;
+    /** 默认开启变声 */
+    defaultVoiceEffect: boolean;
+    /** 展示聊天室输入框 */
+    defaultChatInput: boolean;
+}
+export interface NEMeetingJoinOptions {
+    meetingNum: string;
+    userUuid?: string;
+    nickname: string;
+}

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

@@ -0,0 +1,97 @@
+import { VideoFrameRate, VideoResolution } from './types';
+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;
+    /**
+     * 打开本端视频并发送
+     */
+    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
+     */
+    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/tender-sdk-web/src/interface/waitingRoom_manager.d.ts

@@ -0,0 +1,51 @@
+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 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;

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

@@ -0,0 +1,2 @@
+export * from './type';
+export * from './innerType';