@ylink-sdk/meeting 0.1.13 → 0.2.0-beta.2

package/dist/types/data.d.ts

@@ -1,737 +0,0 @@
-/// <reference types="node" />
-import { ENDPOINT_TYPE, RECORD_STATUS, ROLE } from './enums';
-/**
- * 入会后的实时会议数据
- */
-export interface Data {
-    /**
-     * 入会用户信息（自身）
-     */
-    me: Me;
-    /**
-     * 会议详情
-     */
-    meetingInfo?: {
-        /**
-         * 会议号
-         */
-        meetingNum?: string;
-        /**
-         * 会议ID
-         */
-        meetingID?: string;
-        /**
-         * 是否允许主持人之前加入会议
-         */
-        allowJoinBeforeHost?: boolean;
-        /**
-         * 是否开启解除静音需用户同意
-         */
-        askToUnmuteEnabled?: boolean;
-        /**
-         * 是否开启录制需要提示用户
-         */
-        consentToRecord?: boolean;
-        /**
-         * 会议创建类型，可选：vmr，scheduled(预约会议)，meetNow(即时会议)
-         */
-        createType?: 'vmr' | 'scheduled' | 'meetNow';
-        /**
-         * 企业ID 对应partyId
-         */
-        eid?: string;
-        /**
-         * 会议类型，可选：meeting(云会议室)， webinar(研讨会)
-         */
-        meetingType?: 'meeting' | 'webinar';
-        /**
-         * 组织者信息
-         */
-        organizer?: {
-            displayName?: string;
-            subjectID?: string;
-        };
-        /**
-         * 企业类型，0：企业，1：个人
-         */
-        partySubType?: number;
-        /**
-         * 预约会议ID
-         */
-        planID?: string;
-        /**
-         * 会议密码
-         */
-        pwd?: string;
-        /**
-         * 序列号
-         */
-        seq?: number;
-        /**
-         * 预约会议sequence
-         */
-        sequence?: number;
-        /**
-         * 会议实际开启时间(第一个媒体入会的时间)，单位毫秒
-         */
-        startTime?: number;
-        /**
-         * 会议主题
-         */
-        subject?: string;
-        /**
-         * 是否全局直播关闭
-         */
-        youtubeLiveStreamDisabled?: boolean;
-        /**
-         * VMR会议ID
-         */
-        vmrID?: string;
-        /**
-         * 是否允许直播
-         */
-        allowLiveStream?: boolean;
-        /**
-         * 是否启用虚拟教室
-         */
-        isVirtualClassroom?: boolean;
-        /**
-         * 语音激励显示本地画面
-         */
-        speakerShowSelf?: boolean;
-        [propName: string]: unknown;
-    };
-    /**
-     * 会议配置
-     */
-    meetingSetting?: {
-        /**
-         * 会议号
-         */
-        meetingNum?: string;
-        /**
-         * 会议ID
-         */
-        meetingID?: string;
-        /**
-         * 是否锁定会议
-         */
-        lock?: boolean;
-        /**
-         * 改名权限配置
-         */
-        allowRenameSelf?: boolean;
-        /**
-         * 是否显示头像
-         */
-        showAvatar?: boolean;
-        /**
-         * 聊天配置
-         */
-        chatSetting?: {
-            /**
-             * 参会者聊天权限，可选：all(与会者可以自由聊天)、public(与会者只能群聊)、host(与会者只能私聊主持人)、disabled(与会者不能聊天)
-             */
-            attendeePermission?: 'all' | 'public' | 'host' | 'disabled';
-            /**
-             * 观众聊天权限，可选：all(与会者可以自由聊天)、public(与会者只能群聊)、host(与会者只能私聊主持人)、disabled(与会者不能聊天)
-             */
-            audiencePermission?: 'all' | 'public' | 'host' | 'disabled';
-        };
-        /**
-         * 媒体配置
-         */
-        mediaSetting?: {
-            /**
-             * 音频配置
-             */
-            audio?: {
-                /**
-                 * 入会自动禁音
-                 */
-                muteOnJoin?: boolean;
-                /**
-                 * 发言模式，可选：free(自由发言)，handUp(举手发言)，举手发言会触发全体禁言。
-                 */
-                speakingMode?: 'free' | 'handUp';
-                /**
-                 * 允许自己解禁言
-                 */
-                allowUnmuteSelf?: boolean;
-            };
-            /**
-             * 视频配置
-             */
-            video?: {
-                /**
-                 * 入会自动关闭视频
-                 */
-                muteOnJoin?: boolean;
-                /**
-                 * 允许自己开启视频
-                 */
-                allowUnmuteSelf?: boolean;
-            };
-            /**
-             * 辅流配置
-             */
-            share?: {
-                /**
-                 * 批注权限,可选：all(所有人都可以批注、sharerHost(分享者和主持人可以批注)
-                 */
-                annotationPermission?: 'all' | 'sharerHost';
-                /**
-                 * 辅流分享权限,可选: allGrab(允许抢占)、hostGrab(只允许主持人抢占)、hostStart(只允许主持人分享)、multi(允许多人同时分享)
-                 */
-                sharePermission?: 'allGrab' | 'hostGrab' | 'hostStart' | 'multi';
-                /**
-                 * 是否允许水印
-                 */
-                watermark?: boolean;
-            };
-        };
-        /**
-         * 等候室配置
-         */
-        lobbySetting?: {
-            /**
-             * 0: 仅主持人可绕过大厅;1: 企业内所有人可绕过大厅;2: 受邀参会者可绕过大厅;3: 企业内所有人及受邀参会者可绕过大厅
-             */
-            autoAdmitted?: number;
-            /**
-             * 是否启用等候室
-             */
-            enabled?: boolean;
-        };
-        /**
-         * 提示音配置
-         */
-        ivrSetting?: {
-            /**
-             * 与会者入会/离会提示音，可选：off(无提示音)、self(仅入会方提示)、all(所有成员提示)、 selfAndHost(入会方和主持人提示)
-             */
-            chime?: 'off' | 'self' | 'all' | 'selfAndHost';
-        };
-        [propName: string]: unknown;
-    };
-    /**
-     * 互动方用户列表
-     */
-    interactiveUsers?: {
-        /**
-         * 序列号
-         */
-        seq?: number;
-        /**
-         * 互动方用户列表
-         */
-        users?: Array<User>;
-    };
-    /**
-     * 广播方用户列表
-     */
-    broadcastUsers?: {
-        /**
-         * 序列号
-         */
-        seq?: number;
-        /**
-         * 广播方用户列表
-         */
-        users?: Array<User>;
-    };
-    /**
-     * 等候室用户列表
-     */
-    lobbyUsers?: {
-        /**
-         * 序列号
-         */
-        seq?: number;
-        /**
-         * 等候室用户列表
-         */
-        users?: Array<User>;
-    };
-    /**
-     * 焦点视频用户
-     */
-    spotlightVideo?: {
-        /**
-         * 序列号
-         */
-        seq?: number;
-        /**
-         * 焦点视频会控用户ID列表
-         */
-        userIDs?: Array<number>;
-    };
-    /**
-     * 参会者人数统计
-     */
-    participantCount?: {
-        hostAttendee: number;
-        audience: number;
-    };
-    /**
-     * 主持人布局
-     */
-    hostLayout?: {
-        /**
-         * 序列号
-         */
-        seq?: number;
-        /**
-         * 布局模式
-         */
-        mode?: 'basic' | 'custom';
-        /**
-         * 布局
-         */
-        layout?: BasicLayout | CustomLayout;
-        /**
-         * 自定义布局是否同时应用于与会者
-         */
-        applyToAttendee?: boolean;
-    };
-    /**
-     * 与会者布局
-     */
-    attendeeLayout?: {
-        /**
-         * 序列号
-         */
-        seq?: number;
-        /**
-         * 布局模式
-         */
-        mode?: 'basic' | 'custom';
-        /**
-         * 布局
-         */
-        layout?: BasicLayout | CustomLayout;
-        /**
-         * 自定义布局是否同时应用于与会者
-         */
-        applyToAttendee?: boolean;
-    };
-    audienceLayout?: {
-        /**
-         * 序列号
-         */
-        seq?: number;
-        /**
-         * 布局模式
-         */
-        mode?: 'basic' | 'custom';
-        /**
-         * 布局
-         */
-        layout?: BasicLayout | CustomLayout;
-    };
-    /**
-     * 录制
-     */
-    recording?: {
-        /**
-         * 序列号
-         */
-        seq: number;
-        /**
-         * 状态，stopped：关闭 starting：正在开始 started：已开始 paused：已暂停
-         */
-        status: string;
-        /**
-         * 录制持续时长
-         */
-        duration?: number;
-        /**
-         * 最后开启时间，时间戳
-         */
-        lastStartTime?: number;
-        /**
-         * 布局信息
-         */
-        layout?: {
-            /**
-             * speaker：演讲者布局 gallery：画廊布局 pip：画中画布局 single：单方全屏
-             */
-            type: string;
-        };
-    };
-    /**
-     * 直播
-     */
-    liveStream?: {
-        /**
-         * 序列号
-         */
-        seq: number;
-        /**
-         * 直播详情
-         */
-        liveStreams: liveStreams[];
-    };
-    /**
-     * 字幕
-     */
-    meetingBarrage?: Barrage;
-}
-/**
- * 字幕信息
- */
-export interface Barrage {
-    /**
-     * 接收对象
-     */
-    receiver: {
-        host: boolean;
-        attendee: boolean;
-        audience: boolean;
-    };
-    /**
-     * 字幕显示位置，top(画面顶部)，medium(画面中部)，bottom(画面底部)
-     */
-    position: string;
-    /**
-     * 字幕内容格式，'text/plain' | 'text/enriched'
-     */
-    contentType: string;
-    /**
-     * 字幕内容
-     */
-    content: string;
-    /**
-     * 显示时长,单位秒(不限时传值-1)
-     */
-    duration: number;
-    /**
-     * 字体大小，可选：32, 34（默认）, 36, 40, 44
-     */
-    fontSize?: number;
-    /**
-     * 字体颜色，可选：白色(#FFFFFF)、黄色(#FFA51E)、蓝色(#006CE6)、红色(#F54849)、黑色(#1A1A1A)
-     */
-    fontColor?: string;
-    /**
-     * 背景颜色，可选：红色(#F54849)、黄色(#FFA51E)、蓝色(#006CE6)、黑色(#1A1A1A)、透明(传空值)
-     */
-    backgroundColor?: string;
-}
-/**
- * 媒体状态
- */
-export interface MediaStream {
-    /**
-     * 设备的开启状态，true设备可用/false设备不可用
-     */
-    deviceOn?: boolean;
-    /**
-     * 暂不使用
-     */
-    recvOn?: boolean;
-    /**
-     * 媒体开关状态，比如:false禁言/true解禁言
-     */
-    sendOn?: boolean;
-    /**
-     * 操作者 1(other) 表示被别人操作；0(self) 或没有该字段 表示自己操作
-     */
-    opBy?: number;
-    /**
-     * 是否开启虚拟辅流协作，若取true,需处理sourceID
-     */
-    serverCoop?: boolean;
-    /**
-     * 虚拟辅流协助终端ID
-     */
-    sourceID?: number;
-}
-/**
- * 用户实体信息
- */
-export interface User {
-    /**
-     * 会控用户ID
-     */
-    userID?: number;
-    /**
-     * 用户账号
-     */
-    account?: string;
-    /**
-     * 音频能力
-     */
-    audio?: MediaStream;
-    /**
-     * 视频能力 观众无此能力
-     */
-    video?: MediaStream;
-    /**
-     * 辅流能力 观众无此能力
-     */
-    share?: MediaStream;
-    /**
-     * 终端能力 TODO
-     */
-    caps?: number;
-    /**
-     * 用户名
-     */
-    displayName?: string;
-    /**
-     * 终端类型
-     */
-    endpointType?: ENDPOINT_TYPE;
-    /**
-     * 所属组织
-     */
-    groupIDs?: Array<string>;
-    /**
-     * 是否举手
-     */
-    isHandUp?: boolean;
-    /**
-     * 是否在大厅
-     */
-    isInLobby?: boolean;
-    /**
-     * 入会时间，单位毫秒
-     */
-    joinTime?: number;
-    /**
-     * 角色
-     */
-    role?: ROLE;
-    /**
-     * 用户ID
-     */
-    subjectID?: string;
-    /**
-     * 举手时间
-     */
-    handUpTime?: number;
-    /**
-     * 变更原因
-     */
-    resultInfo?: Record<string, any>;
-    /**
-     * 本地录制
-     */
-    localRecord?: {
-        status: RECORD_STATUS;
-    };
-}
-/**
- * 自身实体信息
- */
-export interface Me extends User {
-    /**
-     * 媒体链接信息
-     */
-    mediaContent?: {
-        /**
-         * topMC的地址
-         */
-        topMC: string;
-        /**
-         * accessMC的地址，正常情况下只会返回一台。
-         */
-        accessMCs: Array<string>;
-        /**
-         * 媒体加密key，为空则表示不加密
-         */
-        crypto: string;
-        /**
-         * 1 表示内网优先， 2 表示外网优先
-         */
-        addrType: number;
-    };
-    /**
-     * 默认的媒体状态，例如：若会议开启入会自动禁言，audio的sendOn为false
-     */
-    initialMediaState?: {
-        audio: {
-            sendOn: boolean;
-        };
-        video: {
-            sendOn: boolean;
-        };
-    };
-    /**
-     * 重订阅标识，将在重订阅过程中移除，外部无须理会
-     * @ignore
-     */
-    reSub?: boolean;
-    /**
-     * 是否焦点视频，只针对当前用户
-     */
-    isSpotlightVideo?: boolean;
-    /**
-     * 是否离开会议
-     */
-    isLeave?: boolean;
-    /**
-     * 是否已上报本地音视频状态
-     */
-    isUpdatedUserState?: boolean;
-    /**
-     * 字幕消息
-     */
-    barrage?: {
-        /**
-         * 字幕显示位置，top(画面顶部)，medium(画面中部)，bottom(画面底部)
-         */
-        position: string;
-        /**
-         * 字幕内容格式，'text/plain' | 'text/enriched'
-         */
-        contentType: string;
-        /**
-         * 字幕内容
-         */
-        content: string;
-    };
-}
-/**
- * 异常信息
- */
-export interface ResultInfo {
-    bizCode?: number;
-    reasonCode?: number;
-    message?: string;
-}
-/**
- * 收件箱
- * @ignore
- */
-export interface Inbox {
-    name: string;
-    seqId: string;
-    limit?: number;
-}
-/**
- * 轮询任务状态
- */
-export interface JobStatus {
-    /**
-     * 定时器对象
-     */
-    timer?: NodeJS.Timeout | null;
-    /**
-     * 间隔时间
-     */
-    interval?: number;
-    /**
-     * 重试次数
-     */
-    attempts: number;
-    /**
-     * 是否运行
-     */
-    running?: boolean;
-    /**
-     * 错误次数
-     */
-    errorTimes: number;
-    /**
-     * 错误信息
-     */
-    errors: Array<any>;
-    /**
-     * 最后请求时间
-     */
-    lastReqTime?: number;
-}
-/**
- * 用户媒体状态上报
- */
-export interface UserState {
-    /**
-     * 音频状态
-     */
-    audio: MediaStream;
-    /**
-     * 视频状态
-     */
-    video: MediaStream;
-    /**
-     * 辅流状态
-     */
-    share?: MediaStream;
-    /**
-     * 终端能力 第一位 是否支持聊天 第二位 是否支持fecc 第三位 是否支持dtmf控制 第四位 是否支持协作
-     */
-    caps?: number;
-    /**
-     * 被分配的权限
-     */
-    perm?: number;
-}
-export interface BasicLayout {
-    /**
-     * 基础布局类型
-     */
-    type: 'speaker' | 'gallery' | 'pip' | 'single';
-}
-export interface CustomLayout {
-    /**
-     * 布局名称
-     */
-    name: string;
-    /**
-     * 布局类型
-     */
-    type: string;
-    /**
-     * 画面列表
-     */
-    pictures: {
-        /**
-         * 画面序号
-         */
-        index: number;
-        /**
-         * 视频源类型
-         */
-        subscribeType: 'speaker' | 'poll' | 'users';
-        /**
-         * 用户视频源列表
-         */
-        subscribeToUsers?: {
-            userID?: number;
-            subjectID?: number;
-        };
-    }[];
-    /**
-     * 轮询秒数
-     */
-    pollSeconds: number;
-    /**
-     * 最大轮询图数量，-1表示无上限，全屏轮询
-     */
-    pollCount: number;
-}
-interface liveStreams {
-    /**
-     * 直播的平台
-     */
-    platform: 'youtube' | 'aliyun' | 'thirdParty';
-    /**
-     * 直播状态
-     */
-    status: 'stopped' | 'starting' | 'started' | 'paused';
-    /**
-     * 观看链接
-     */
-    watchURL: string;
-    /**
-     * 最近一次开始时间
-     */
-    lastStartTime: number;
-    /**
-     * 持续时间
-     */
-    duration: number;
-}
-export {};