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

package/dist/meeting.d.ts

@@ -0,0 +1,1915 @@
+/// <reference types="node" />
+
+import { Canceler } from '@ylink-sdk/shared';
+import { Emitter } from '@ylink-sdk/shared';
+import { EventType } from '@ylink-sdk/shared';
+import { ICancelToken } from '@ylink-sdk/shared';
+import { Request as Request_2 } from '@ylink-sdk/shared';
+import { RequestError } from '@ylink-sdk/shared';
+
+declare type AddVirtualClassParams = VirtualClassParams & {
+    vmrId: string;
+    type: number;
+};
+
+declare interface BarrageRecord {
+    content: string;
+    time: number;
+    durationType: string;
+    duration: number;
+}
+
+/**
+ * 呼叫记录用户
+ */
+export declare interface callRecordUser {
+    type: InviteType;
+    contact: string;
+    displayName: string;
+    displayNamePinyin: string;
+    role: ROLE;
+    account: number;
+    groupIDs: number[];
+    zone: string;
+    inviteState: 'fail' | 'inviting' | 'success';
+    inviteTime: number;
+    inviteTransID: string;
+    inviterDisplayName: string;
+    resultInfo?: {
+        bizCode?: number;
+        reasonCode?: number;
+        message?: string;
+    };
+}
+
+export declare class Chat extends Module<ChatData> {
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 发送聊天信息
+     * @params
+     * @returns
+     */
+    msg(params: {
+        msgID: string;
+        contentType: string;
+        content: string;
+        msgType?: number;
+        receiver?: {
+            userID: number;
+        };
+        timestamp?: number;
+        sender?: {
+            userID?: number;
+            displayName?: string;
+        };
+    }): Promise<any>;
+    /**
+     * 查询聊天历史信息
+     * @returns
+     */
+    historyMsg(params: {
+        limit: number;
+    }): Promise<any>;
+}
+
+export declare type ChatData = object;
+
+export declare interface ChatMsgPayload {
+    body: Msg;
+    state: PollingPayloadState;
+}
+
+declare interface Config {
+    /**
+     * 服务器地址
+     * @example https://meetings.ylyun.com/control
+     */
+    baseURL: string;
+    /**
+     * 需加载的模块
+     * @example
+     * ```
+     * import { createMeeting, Users, Setting } from '@ylink-sdk/meeting'
+     * const meeting = createMeeting({
+     * 	...
+     * 	modules: [Users, Setting]
+     * })
+     * ```
+     */
+    modules: any[];
+    /**
+     * 消息推送采用子线程模式，避免推送过快，抢占请求资源
+     * @example
+     * ```
+     * // vite框架示例
+     * import { createMeeting } from '@ylink-sdk/meeting'
+     * import PollingWorker from '@ylink-sdk/meeting/dist/worker/polling.worker.prod.js?worker'
+     * const meeting = createMeeting({
+     * 	...
+     * 	worker: new PollingWorker()
+     * })
+     * ```
+     */
+    worker?: Worker;
+    /**
+     * 创建的meeting实例为单例
+     */
+    singleton?: boolean;
+}
+
+/**
+ * 全局上下文
+ */
+export declare interface Context {
+    /**
+     * 全局配置
+     */
+    config: {
+        /**
+         * 服务器地址
+         * @example https://meetings.ylyun.com/control
+         */
+        baseURL: string;
+        /**
+         * 传入的依赖模块
+         */
+        modules: Array<any>;
+        /**
+         * 是否采用单例模式
+         */
+        singleton: boolean;
+        /**
+         * 请求配置
+         */
+        request: {
+            /**
+             * 取消请求
+             * @summary SDK内部默认对polling和keepalive接口进行配置
+             */
+            cancelToken: {
+                token: ICancelToken;
+                cancel: Canceler;
+            };
+            /**
+             * Api接口前缀
+             */
+            prefix: {
+                /**
+                 * 会控
+                 * @default /meeting-ctrl/api/v1/
+                 */
+                ctrl: string;
+                /**
+                 * 会议管理
+                 * @default /conference-manager/api/v1/
+                 */
+                conference: string;
+                /**
+                 * 用户管理
+                 * @default /user-manager/api/v1/
+                 */
+                user: string;
+                /**
+                 * 投票
+                 * @default /vote/api/v1/
+                 */
+                vote: string;
+                [prop: string]: string;
+            };
+            /**
+             * 会议归属地
+             */
+            location: string;
+            /**
+             * 会议ID
+             */
+            meetingID: string;
+            /**
+             * 会控token
+             */
+            ctrlID: string;
+            /**
+             * 当前会话
+             */
+            sessionID: string;
+            /**
+             * 当前用户ID
+             */
+            userID: number;
+            /**
+             * 投票服务唯一标识
+             */
+            voteTk: string;
+        };
+    };
+    /**
+     * 消息推送子线程
+     */
+    worker?: Worker;
+    /**
+     * 事件通知
+     */
+    emitter: Emitter<Events>;
+    /**
+     * 请求能力
+     */
+    request: Request_2;
+    /**
+     * 业务模块
+     */
+    modules: Record<string, any>;
+    /**
+     * 会议状态
+     */
+    state: STATE;
+    /**
+     * 轮询定时器状态
+     */
+    status: {
+        /**
+         * 消息推送-长轮询状态
+         */
+        polling: {
+            /**
+             * 是否运行中
+             */
+            running: boolean;
+            /**
+             * 定时器
+             */
+            timer?: NodeJS.Timeout | null;
+        };
+        /**
+         * 保活轮询状态
+         */
+        keepalive: {
+            /**
+             * 是否运行中
+             */
+            running: boolean;
+            /**
+             * 定时器
+             */
+            timer?: NodeJS.Timeout | null;
+            /**
+             * 轮询间隔时间，正常为20S
+             */
+            interval: number;
+        };
+    };
+}
+
+/**
+ * 创建SDK会议实例
+ * @param config
+ * @returns YlinkSDKMeeting
+ */
+export declare function createMeeting(config: Config): YlinkSDKMeeting;
+
+declare type EditVirtualClassParams = VirtualClassParams & {
+    templateId: string;
+};
+
+/**
+ * 终端类型
+ */
+export declare enum ENDPOINT_TYPE {
+    /**
+     * webRTC
+     */
+    WEBAPP = "webApp",
+    /**
+     * web会控
+     */
+    WEBCTRL = "webCtrl",
+    /**
+     * 微信小程序
+     */
+    WECHATMP = "weChatMP",
+    /**
+     * 监视者
+     */
+    SUPERVISION = "supervision",
+    /**
+     * 虚拟教室终端
+     */
+    BIGSCREEN = "bigScreen",
+    /**
+     *  桌面客户端
+     */
+    DESKTOP = "desktop",
+    /**
+     * 移动客户端
+     */
+    MOBILE = "mobile",
+    /**
+     * 亿联硬件终端
+     */
+    VCS = "vcs",
+    /**
+     * SIP终端
+     */
+    SIP = "sip",
+    /**
+     * 323终端
+     */
+    H323 = "h323",
+    /**
+     * PSTN电话
+     */
+    PSTN = "pstn"
+}
+
+/**
+ * 全局事件
+ */
+export declare enum EVENT {
+    /**
+     * 请求异常
+     */
+    REQUEST_ERROR = "requestError",
+    /**
+     * 会议状态
+     */
+    STATE = "state"
+}
+
+/**
+ * emitter 事件
+ */
+declare type Events = {
+    [EVENT.STATE]: {
+        state: STATE;
+        reason?: ResultInfo;
+    };
+    [EVENT.REQUEST_ERROR]: RequestError;
+    me: any;
+    setUserVideo: any;
+    setUserAudio: any;
+    meetingState: any;
+    recording: any;
+    meetingSetting: any;
+    spotlightVideo: any;
+    interactiveUsers: any;
+    lobbyUsers: any;
+    broadcastUsers: any;
+    advCtrlUsers: any;
+    hostLayout: any;
+    attendeeLayout: any;
+    audienceLayout: any;
+    meetingView: any;
+    personalView: any;
+    vote: any;
+    meetingBarrage: any;
+    meetingInfo: any;
+    callRecord: any;
+    participantCount: any;
+    liveStream: any;
+    chatMsg: any;
+} & MeEvents;
+
+export declare class Info extends Module<InfoData> {
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 会议标题修改
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    subject(params: {
+        subject: string;
+    }): Promise<any>;
+    /**
+     * 关闭会议准备模式
+     * @returns 返回的数据
+     */
+    practiceSession(): Promise<any>;
+}
+
+export declare interface InfoData {
+    meetingNum: string;
+    meetingID: string;
+    allowJoinBeforeHost: boolean;
+    askToUnmuteEnabled: boolean;
+    consentToRecord: boolean;
+    createType: 'vmr' | 'scheduled' | 'meetNow';
+    eid: string;
+    meetingType: 'meeting' | 'webinar';
+    organizer: {
+        displayName: string;
+        subjectID: string;
+    };
+    partySubType: number;
+    pwd: string;
+    seq: number;
+    sequence: number;
+    startTime: number;
+    subject: string;
+    speakerShowSelf: boolean;
+    asrServiceAvailable: boolean;
+    recordUserEnabled: boolean;
+    premiseRecordEnabled?: boolean;
+    planID?: string;
+    vmrID?: string;
+    allowLocalRecord?: boolean;
+    youtubeLiveStreamDisabled?: boolean;
+    allowLiveStream?: boolean;
+    isVirtualClassroom?: boolean;
+    liveCaptionEnabled?: boolean;
+    practiceSession?: boolean;
+    audienceHideNonVideoEnabled?: boolean;
+    webinarSurveyLink?: string;
+    participantCount: {
+        hostAttendee: number;
+        audience: number;
+    };
+}
+
+export declare class Invite extends Module<InviteData> {
+    static setDisplayNamePinyinProp: (name: string) => string;
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 邀请
+     */
+    invite(params: {
+        type: InviteType;
+        contacts: string[];
+        zone?: string;
+    }): Promise<any>;
+}
+
+/**
+ * Invite 数据
+ */
+export declare interface InviteData {
+    callRecordUsers: callRecordUser[];
+}
+
+/**
+ * 邀请用户类型
+ */
+export declare type InviteType = 'account' | 'subjectID' | 'sip' | 'h323' | 'pstn' | 'teams' | 'number';
+
+/**
+ * 入会参数
+ */
+export declare interface JoinParams {
+    /**
+     * 会议号
+     */
+    meetingNum: string;
+    /**
+     * 会议明文密码
+     */
+    pwd?: string;
+    /**
+     * 用户显示名
+     */
+    displayName: string;
+    /**
+     * 终端类型
+     */
+    endpointType: ENDPOINT_TYPE;
+    /**
+     * 邀请入会的事务ID(邀请入会必选)
+     */
+    inviteTransID?: string;
+    /**
+     * 组织架构IDs
+     */
+    groupIDs?: Array<string>;
+    /**
+     * 云账号
+     */
+    account?: string;
+    /**
+     * 终端设备类型UA
+     */
+    userAgent?: string;
+    /**
+     * 账号的GroupName名称
+     */
+    groupName?: string;
+    /**
+     * 入会链接，不带meetingNum则必选
+     */
+    url?: string;
+    /**
+     * 手机区号
+     */
+    mobileCode?: string;
+    /**
+     * 手机号
+     */
+    mobile?: string;
+    /**
+     * 注册邮箱
+     */
+    regEmail?: string;
+    /**
+     * 云账号用户邮箱
+     */
+    accEmail?: string;
+    /**
+     * 观众注册唯一标识
+     */
+    tk?: string;
+}
+
+export declare interface Layout {
+    mode: 'custom' | 'basic';
+    layout: LayoutContent;
+    seq?: number;
+    applyToAttendee?: boolean;
+}
+
+export declare interface LayoutContent {
+    type: string;
+    disallowShowSameVideo?: boolean;
+    hideNonVideo?: boolean;
+    name?: string;
+    pollCount?: number;
+    pollSeconds?: number;
+    pictures?: Picture[];
+    count?: number;
+    layout?: string;
+    mode?: string;
+}
+
+export declare interface Live {
+    duration?: number;
+    lastStartTime?: number;
+    content?: string;
+    contentType?: string;
+    layout: {
+        type?: string;
+    };
+    liveCaptionEnabled?: boolean;
+    platform?: string;
+    status?: string;
+    watchURL?: string;
+    requesting?: boolean;
+    resultInfo?: {
+        bizCode?: string;
+    };
+    bizCode?: string;
+    watchPassword?: string;
+    userID?: string;
+}
+
+export declare class LiveStream extends Module<LiveStreamData> {
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 设置直播状态
+     * @returns 返回的数据
+     */
+    setStatus(params: {
+        platform: string;
+        action: string;
+    }): Promise<any>;
+    /**
+     * 设置直播描述信息
+     * @returns 返回的数据
+     */
+    liveStreamDescription(params: {
+        platform: string;
+        contentType: string;
+        content: string;
+    }): Promise<any>;
+    /**
+     * 录制状态修改
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    liveStreamSetting(params: {
+        platform: string;
+        layout: {
+            type: string;
+        };
+        liveCaptionEnabled: boolean;
+    }): Promise<any>;
+}
+
+export declare interface LiveStreamData {
+    liveStreams: Live[];
+    status: Status[];
+    resultInfo: {
+        bizCode?: string;
+    };
+    jetlag: number;
+}
+
+export declare class Me extends Module<MeData> {
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 上报客户端音视频状态
+     */
+    updateUserState(params: {
+        audio: Partial<MediaState>;
+        video: Partial<MediaState>;
+        share?: Partial<MediaState>;
+    }, isForce?: boolean): Promise<Response_2>;
+}
+
+export declare interface MeData {
+    /**
+     * 是否上报了媒体状态
+     */
+    isUpdatedUserState: boolean;
+    /**
+     * 是否被设为焦点视频
+     */
+    isSpotlightVideo: boolean;
+    userID: number;
+    role: ROLE;
+    joinTime: number;
+    endpointType: ENDPOINT_TYPE;
+    isInLobby: boolean;
+    isHandUp: boolean;
+    displayName: string;
+    subjectID: string;
+    caps: number;
+    initialMediaState: {
+        audio: MediaState;
+        video: MediaState;
+    };
+    mediaContent?: {
+        accessMCs: Array<string>;
+        addrType: number;
+        crypto: string;
+        meetingParam: string;
+        topMC: string;
+    };
+    audio?: MeMedia;
+    video?: MeMedia;
+    share?: MeMedia;
+    barrage?: {
+        content?: string;
+        contentType?: string;
+        duration?: number;
+        position?: string;
+        receiver?: {
+            host: boolean;
+            attendee: boolean;
+            audience: boolean;
+        };
+        type?: string;
+    };
+}
+
+/**
+ * 媒体
+ */
+declare interface MediaState {
+    /**
+     * 设备的开启状态，true设备可用/false设备不可用
+     */
+    deviceOn?: boolean;
+    /**
+     * 暂不使用
+     */
+    recvOn?: boolean;
+    /**
+     * 媒体开关状态
+     */
+    sendOn: boolean;
+}
+
+export declare enum MeEvent {
+    /**
+     * 初始化自身信息，正常为入会时进行调用
+     */
+    INIT = "meInit",
+    /**
+     * 涉及自身变更的通知，其他模块触发用
+     */
+    UPDATE = "meUpdate",
+    /**
+     * 客户上报自身媒体状态
+     */
+    UPDATE_USER_STATE = "updateUserState",
+    /**
+     * 角色变更
+     */
+    ROLECHANGE = "meRoleChange",
+    /**
+     * 音频状态变更
+     */
+    AUDIOCHANGE = "meAudioChange",
+    /**
+     * 举手状态变更
+     */
+    HANDUPCHANGE = "meHandupChange",
+    /**
+     * 远端请求开启音频
+     */
+    SETAUDIO = "setAudio",
+    /**
+     * 视频状态变更
+     */
+    VIDEOCHANGE = "meVideoChange",
+    /**
+     * 远端请求开启视频
+     */
+    SETVIDEO = "setVideo",
+    /**
+     * 辅流状态变更
+     */
+    SHARECHANGE = "meShareChange",
+    /**
+     * 显示名变更
+     */
+    DISPLAYNAMECHANGE = "meDisplayNameChange",
+    /**
+     * 焦点视频状态变更
+     */
+    SPOTLIGHTVIDEOCHANGE = "meSpotlightVideoChange",
+    /**
+     * 进入/离开等候室变更
+     */
+    LOBBYCHANGE = "meLobbyChange",
+    /**
+     * 横幅变更
+     */
+    BARRAGECHANGE = "meBarrageChange",
+    /**
+     * 离开会议
+     */
+    LEAVE = "leave"
+}
+
+export declare type MeEvents = {
+    [MeEvent.INIT]: any;
+    [MeEvent.UPDATE]: any;
+    [MeEvent.UPDATE_USER_STATE]: any;
+    [MeEvent.ROLECHANGE]: ROLE;
+    [MeEvent.AUDIOCHANGE]: MeMedia;
+    [MeEvent.HANDUPCHANGE]: boolean;
+    [MeEvent.SETAUDIO]: any;
+    [MeEvent.VIDEOCHANGE]: MeMedia;
+    [MeEvent.SETVIDEO]: any;
+    [MeEvent.SHARECHANGE]: MeMedia;
+    [MeEvent.DISPLAYNAMECHANGE]: string;
+    [MeEvent.SPOTLIGHTVIDEOCHANGE]: boolean;
+    [MeEvent.LOBBYCHANGE]: boolean;
+    [MeEvent.BARRAGECHANGE]: MeData['barrage'];
+    [MeEvent.LEAVE]: any;
+};
+
+declare type MeMedia = MediaState & {
+    opBy?: number;
+};
+
+declare abstract class Module<T extends object> {
+    moduleName: string;
+    ctx: Context;
+    data: T;
+    emitter: Emitter<Record<EventType, unknown>>;
+    constructor(ctx: Context, moduleName: string);
+    /**
+     * 关联外部响应式数据
+     * @param obj
+     */
+    reactive(obj: Record<any, any>): T & ReactiveReturn;
+    /**
+     * 数据变更监听
+     * @param type
+     * @param payload
+     * @returns
+     */
+    on(type: string, payload: any): void;
+    /**
+     * 取消监听
+     * @param type
+     * @param handler
+     * @returns
+     */
+    off(type: string, handler?: any): void;
+    /**
+     * 设置模块订阅的主题
+     */
+    abstract _topic(): string | string[];
+    /**
+     * 绑定对应的事件通知，来源polling
+     */
+    abstract _bindOn(): void;
+}
+
+export declare interface Msg {
+    msgID: string;
+    contentType: string;
+    content: string;
+    msgType: number;
+    receiver: {
+        userID: number;
+    };
+    sender: MsgSender;
+    timestamp: number;
+}
+
+/**
+ * 消息发送者
+ */
+declare interface MsgSender {
+    displayName: string;
+    userID: number;
+}
+
+export declare interface PersonalLayout {
+    mode: 'custom' | 'basic';
+    layouts: LayoutContent[];
+    seq: number;
+    subscriber?: PersonalLayoutSubscriber;
+    templateStatus?: number;
+}
+
+export declare interface PersonalLayoutSubscriber {
+    userID: number;
+    subjectID?: string;
+}
+
+export declare interface Picture {
+    index: number;
+    subscribeToUsers?: {
+        subjectID: string;
+        userID?: string;
+    }[];
+    subscribeType: string;
+    priorSubscribeType?: string;
+}
+
+/**
+ * polling 下发事件状态
+ */
+export declare type PollingPayloadState = 'full' | 'delete' | 'update';
+
+declare type ReactiveReturn = {
+    /**
+     * 取消响应式关联
+     */
+    _destory: () => void;
+};
+
+/**
+ * 录制状态
+ */
+export declare enum RECORD_STATUS {
+    STARTED = "started",
+    PAUSED = "paused",
+    STARTING = "starting",
+    STOPPED = "stopped"
+}
+
+export declare class Recording extends Module<RecordingData> {
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 录制记录
+     * @returns 返回的数据
+     */
+    history(): Promise<any>;
+    /**
+     * 录制状态修改
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    status(params: {
+        action: 'start' | 'pause' | 'stop';
+    }): Promise<any>;
+    /**
+     * 录制布局控制
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    layout(params: {
+        mode?: 'basic' | 'custom';
+        layoutOption: string;
+        layout?: LayoutContent;
+    }): Promise<any>;
+    /**
+     * 会控指定与会者录制
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    designatedUsers(params: {
+        recordUsers: RecordUsers[];
+    }): Promise<any>;
+    /**
+     * 指定与会者成员添加
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    participantAdd(params: {
+        sourceId: string;
+        content: string;
+        sourceType: number;
+    }): Promise<any>;
+    /**
+     * 指定与会者成员清除
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    participantDelete(params: {
+        sourceId: string;
+        sourceType: number;
+    }): Promise<any>;
+    /**
+     * 会议模板列表
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    getTemplates(params: {
+        vmrId: string;
+    }): Promise<any>;
+    /**
+     * 根据id列表获取用户信息
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    getByIds(params: {
+        ids: string[];
+    }): Promise<any>;
+    /**
+     * 设置录制布局
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    recordLayout(params: RecordLayoutMap): Promise<any>;
+}
+
+export declare interface RecordingData {
+    isPracticeSession?: boolean;
+    recording: RecordingMap;
+    liveTime?: number;
+    status: Status_2;
+    resultInfo: {
+        bizCode?: string;
+    };
+    jetlag: number;
+}
+
+export declare interface RecordingMap {
+    status?: string;
+    layout: {
+        layout?: {
+            type: string;
+            name?: string;
+        };
+        mode?: string;
+    };
+    layoutOption: string;
+    recordUsers?: RecordUsers[];
+    requesting?: boolean;
+    transcriptEnabled: boolean;
+    watermarkEnabled: boolean;
+    layoutID?: string;
+    lastStartTime?: number;
+    duration?: number;
+    seq?: number;
+}
+
+export declare interface RecordLayoutMap {
+    layoutOption?: string;
+    mode?: string;
+    layout: {
+        layout?: {
+            type: string;
+        };
+        mode?: string;
+    };
+    layoutID?: string;
+}
+
+export declare interface RecordUsers {
+    subjectID: string;
+    userID?: number;
+}
+
+export declare function reset(ctx: Context): void;
+
+/**
+ * 请求响应体
+ */
+declare interface Response_2 {
+    /**
+     * 业务码，成功900200
+     */
+    bizCode: number;
+    /**
+     * 数据
+     */
+    data?: any;
+    /**
+     * 错误信息
+     */
+    error?: {
+        /**
+         * 错误码
+         */
+        errorCode: number;
+        /**
+         * 信息
+         */
+        msg: string;
+    };
+    /**
+     * 标识，-1失败，>-1成功
+     */
+    ret?: number;
+}
+export { Response_2 as Response }
+
+/**
+ * 退会信息
+ */
+export declare interface ResultInfo {
+    /**
+     * 业务码
+     */
+    bizCode?: number;
+    /**
+     * 原因码
+     */
+    reasonCode?: number;
+    /**
+     * 信息
+     */
+    message?: string;
+}
+
+/**
+ * 角色
+ */
+export declare enum ROLE {
+    /**
+     * 主持人（组织者）
+     */
+    HOST = "host",
+    /**
+     * 联席主持人（会议中被设置为主持人的）
+     */
+    COHOST = "coHost",
+    /**
+     * 与会者
+     */
+    ATTENDEE = "attendee",
+    /**
+     * 观众
+     */
+    AUDIENCE = "audience"
+}
+
+export declare class Setting extends Module<SettingData> {
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 会议设置
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    setting(params: any): Promise<any>;
+    /**
+     * 全体静音
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    muteAll(): Promise<any>;
+    /**
+     * 全体接触静音
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    unmuteAll(): Promise<any>;
+}
+
+export declare interface SettingData {
+    meetingNum: string;
+    meetingID: string;
+    lock: boolean;
+    allowRenameSelf: boolean;
+    showAvatar: boolean;
+    chatSetting: {
+        attendeePermission: 'all' | 'public' | 'host' | 'disabled';
+        audiencePermission: 'all' | 'public' | 'host' | 'disabled';
+    };
+    mediaSetting: {
+        audio: {
+            muteOnJoin: boolean;
+            speakingMode: 'free' | 'handUp';
+            allowUnmuteSelf: boolean;
+        };
+        video: {
+            muteOnJoin: boolean;
+            allowUnmuteSelf: boolean;
+        };
+        share: {
+            annotationPermission: 'all' | 'sharerHost';
+            sharePermission: 'allGrab' | 'hostGrab' | 'hostStart' | 'multi';
+            watermark: boolean;
+        };
+    };
+    lobbySetting: {
+        autoAdmitted: number;
+        enabled: boolean;
+    };
+    ivrSetting: {
+        chime: 'off' | 'self' | 'all' | 'selfAndHost';
+    };
+    qaSetting: {
+        allowAnonymousQuestion: boolean;
+        audienceViewPermission: 'onlyTop' | 'onlyAnswered' | 'all';
+        enabled: boolean;
+    };
+    voteSetting: {
+        enabled: boolean;
+    };
+    siteNameSetting: {
+        backgroundColor: number;
+        customStyleOn: boolean;
+        fontColor: number;
+        fontSize: number;
+        horizontalPosition: number;
+        on: boolean;
+        verticalPosition: number;
+    };
+    asrSetting: {
+        allowViewTranscriptHistory: boolean;
+    };
+    seq?: number;
+}
+
+export declare class SpotlightVideo extends Module<SpotlightVideoData> {
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 设置焦点
+     */
+    spotlight(params: {
+        userID: number;
+        action: 'add' | 'remove' | 'replace' | 'removeAll';
+    }): Promise<any>;
+}
+
+export declare interface SpotlightVideoData {
+    userIDs: number[];
+}
+
+/**
+ * 会议状态类型
+ */
+export declare enum STATE {
+    /**
+     * 未入会或退会
+     */
+    CLOSE = 0,
+    /**
+     * 已入会
+     */
+    JOINED = 1,
+    /**
+     * 一切就绪
+     */
+    READY = 2
+}
+
+declare interface Status {
+    platform: string;
+    status: string;
+}
+
+declare type Status_2 = 'starting' | 'started' | 'stopped' | 'paused';
+
+/**
+ * User 数据
+ */
+export declare interface User {
+    /**
+     * 会控用户ID
+     */
+    userID: number;
+    /**
+     * 用户账号
+     */
+    account?: string;
+    /**
+     * 终端类型
+     */
+    endpointType?: ENDPOINT_TYPE;
+    /**
+     * 用户名
+     */
+    displayName: string;
+    /**
+     * 用户名拼音
+     */
+    displayNamePinyin: string;
+    /**
+     * 音频能力
+     */
+    audio?: UserMedia;
+    /**
+     * 视频能力 观众无此能力
+     */
+    video?: UserMedia;
+    /**
+     * 辅流能力 观众无此能力
+     */
+    share?: UserMedia;
+    /**
+     * 协作能力 观众无此能力
+     */
+    whiteboard?: UserMedia;
+    /**
+     * 个人能力集
+     */
+    caps?: number;
+    /**
+     * 临时分配的权限
+     */
+    perm?: number;
+    /**
+     * 所属组织
+     */
+    groupIDs?: Array<string>;
+    /**
+     * 是否举手
+     */
+    isHandUp?: boolean;
+    /**
+     * 是否在大厅
+     */
+    isInLobby?: boolean;
+    /**
+     * 入会时间，单位毫秒
+     */
+    joinTime?: number;
+    /**
+     * 角色
+     */
+    role?: ROLE;
+    /**
+     * 用户ID
+     */
+    subjectID?: string;
+    /**
+     * 举手时间
+     */
+    handUpTime?: number;
+    /**
+     * 变更原因
+     */
+    resultInfo?: Record<string, any>;
+    /**
+     * 本地录制
+     */
+    localRecord?: {
+        status: RECORD_STATUS;
+    };
+}
+
+/**
+ * User 媒体状态
+ */
+export declare interface UserMedia {
+    /**
+     * 设备的开启状态，true设备可用/false设备不可用
+     */
+    deviceOn?: boolean;
+    /**
+     * 暂不使用
+     */
+    recvOn?: boolean;
+    /**
+     * 媒体开关状态，比如:false禁言/true解禁言
+     */
+    sendOn?: boolean;
+    /**
+     * 操作者 1(other) 表示被别人操作；0(self) 或没有该字段 表示自己操作
+     */
+    opBy?: number;
+}
+
+export declare class Users extends Module<UsersData> {
+    static setDisplayNamePinyinProp: (name: string) => string;
+    constructor(ctx: Context);
+    _topic(): string[] | "interactive";
+    _bindOn(): void;
+    /**
+     * 更新 - 补充用户信息：
+     * 名称拼音
+     * @param updateUser
+     * @param user
+     */
+    updateUserProps(updateUser: User, user: User): void;
+    /**
+     * 设置音频
+     * @param userID
+     * @param params
+     * @returns
+     */
+    setAudio(userID: number, params: {
+        sendOn: boolean;
+        cred?: string;
+    }): Promise<any>;
+    /**
+     * 设置视频
+     * @param userID
+     * @param params
+     * @returns
+     */
+    setVideo(userID: number, params: {
+        sendOn: boolean;
+        cred?: string;
+    }): Promise<any>;
+    /**
+     * 设置辅流
+     * @param userID
+     * @param params
+     * @returns
+     */
+    setShare(userID: number, params: {
+        sendOn: boolean;
+    }): Promise<any>;
+    /**
+     * 设置互动协作白板
+     * @param userID
+     * @param params
+     * @returns
+     */
+    setWhiteboard(userID: number, params: {
+        sendOn: boolean;
+    }): Promise<any>;
+    /**
+     * 举手
+     * @param userID
+     * @param params
+     * @returns
+     */
+    handUp(userID: number, params: {
+        handUp: boolean;
+    }): Promise<any>;
+    /**
+     * 修改用户角色
+     * @param userID
+     * @param params
+     * @returns
+     */
+    setRole(userID: number, params: {
+        role: ROLE;
+    }): Promise<any>;
+    /**
+     * 改名
+     * @param userID
+     * @param params
+     * @returns
+     */
+    rename(userID: number, params: {
+        displayName: string;
+    }): Promise<any>;
+    /**
+     * 移除用户
+     * @param userID
+     * @returns
+     */
+    remove(userID: number): Promise<any>;
+    /**
+     * 举手处理
+     * @param userID
+     * @param params
+     * @returns
+     */
+    replyHandUp(userID: number, params: {
+        permit: boolean;
+    }): Promise<any>;
+    /**
+     * 摄像头控制
+     */
+    fecc(userID: number, params: {
+        action: string;
+        actionPlayTimes: number;
+    }): Promise<any>;
+    /**
+     * 会议大厅状态切换 允许入会或者设为等待
+     * @param userID
+     * @param params
+     * @returns
+     */
+    lobbyState(userID: number, params: {
+        isInLobby: boolean;
+    }): Promise<any>;
+    /**
+     * 设置用户本地录播权限
+     * @param userID
+     * @param params
+     * @returns
+     */
+    allowLocalRecord(userID: number, params: {
+        allow: boolean;
+    }): Promise<any>;
+    /**
+     * 设置互动协作白板
+     * @param userID
+     * @param params
+     * @returns
+     */
+    whiteboard(userID: number, params: {
+        sendOn: boolean;
+    }): Promise<any>;
+    /**
+     * 通话统计
+     * @param userID
+     * @returns
+     */
+    callStats(userID: number): Promise<any>;
+    /**
+     * 举手全部拒绝
+     * @returns
+     */
+    replyAllHandUp(): Promise<any>;
+    /**
+     * 大厅全部准入
+     * @returns
+     */
+    admitAll(): Promise<any>;
+    /**
+     * 大厅全部移除
+     * @returns
+     */
+    refuseAll(): Promise<any>;
+}
+
+/**
+ * Users 数据
+ */
+export declare interface UsersData {
+    /**
+     * 互动方（参会者）成员列表
+     */
+    interactiveUsers: User[];
+    /**
+     * 等候室成员列表
+     */
+    lobbyUsers: User[];
+    /**
+     * 广播方（观众）成员列表
+     */
+    broadcastUsers: User[];
+    /**
+     * 虚拟教室终端 - 仅前端会控使用
+     */
+    advCtrlUsers: User[];
+}
+
+export declare class View extends Module<ViewData> {
+    constructor(ctx: Context);
+    _topic(): string[];
+    _bindOn(): void;
+    updateLayout(payload: ViewPayload, type: string): void;
+    /**
+     * 更新个人自定义布局
+     * @param payload
+     */
+    private updatePersonalLayouts;
+    /**
+     * 主持人布局设置
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    hostLayout(params: Layout): Promise<any>;
+    /**
+     * 与会者布局设置
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    attendeeLayout(params: Layout): Promise<any>;
+    /**
+     * 观众布局设置
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    audienceLayout(params: Layout): Promise<any>;
+    /**
+     * 设置个人布局
+     * @param params
+     * @returns
+     */
+    personalLayout(params: Layout & {
+        subscriber: PersonalLayoutSubscriber;
+    }): Promise<any>;
+    /**
+     * 取消个人布局
+     * @param params
+     * @returns
+     */
+    personalLayoutDelete(params: {
+        subscriber: PersonalLayoutSubscriber;
+    }): Promise<any>;
+    /**
+     * 设置虚拟教室布局
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    virtualClassLayout(params: {
+        blackList: string[];
+        count: number;
+        layout: LayoutContent;
+    }): Promise<any>;
+    /**
+     * 关闭虚拟教室布局
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    closeVirtualClass(): Promise<any>;
+    /**
+     * 获取虚拟课堂布局
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    getVirtualClassTemplate(params: {
+        vmrId: string;
+        type: number;
+    }): Promise<any>;
+    /**
+     * 添加虚拟课堂布局
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    addVirtualClassTemplate(params: AddVirtualClassParams): Promise<any>;
+    /**
+     * 编辑虚拟课堂布局
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    editVirtualClassTemplate(params: EditVirtualClassParams): Promise<any>;
+    /**
+     * 会议模板列表
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    getTemplates(params: {
+        vmrId: string;
+    }): Promise<any>;
+    /**
+     * 会议模板编辑
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    editTemplate(params: {
+        vmrId: string;
+        name: string;
+        id: string;
+        content: string;
+    }): Promise<any>;
+    /**
+     * 会议模板添加
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    addTemplate(params: {
+        vmrId: string;
+        name: string;
+        content: string;
+    }): Promise<any>;
+    /**
+     * 会议模板删除
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    deleteTemplate(params: {
+        vmrId: string;
+        id: string;
+    }): Promise<any>;
+    /**
+     * 会议模板获取默认模板参数
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    getDefaultTemplates(params: {
+        vmrId: string;
+        partyId: string;
+    }): Promise<any>;
+    /**
+     * 会议模板设置默认模板
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    changeDefaultTemplate(params: {
+        vmrId: string;
+        id: string;
+        isDefault: boolean;
+        perspective: number;
+    }): Promise<any>;
+    /**
+     * 会议模板个人默认布局绑定
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    perspectiveBind(params: {
+        vmrId: string;
+        bindList: {
+            templateId: string;
+            subjectIds: string[];
+        }[];
+    }): Promise<any>;
+}
+
+export declare interface ViewData {
+    hostLayout: Layout;
+    attendeeLayout: Layout;
+    audienceLayout: Layout;
+    personalLayouts: Record<number | string, PersonalLayout>;
+}
+
+declare interface ViewPayload {
+    body: any;
+    state: PollingPayloadState;
+    event: string;
+}
+
+declare interface VirtualClassParams {
+    enabled: boolean;
+    targetIds: string[];
+    blacklistIds: string[];
+    content: string;
+}
+
+export declare class Vote extends Module<VoteData> {
+    constructor(ctx: Context);
+    _topic(): string | string[];
+    _bindOn(): void;
+    /**
+     * 查询投票列表
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    getVotes(params: {
+        planID: string;
+        vmrID: string;
+        tk?: string;
+    }): Promise<any>;
+    /**
+     * 查询投票详情
+     * @param params
+     * @returns
+     */
+    getVote(params: VotePathParams & {
+        role: string;
+        state: string;
+    }): Promise<any>;
+    /**
+     * 查询用户投票选项
+     * @param params
+     * @returns
+     */
+    getMeVote(params: VotePathParams): Promise<any>;
+    /**
+     * 投票状态操作
+     * @param params
+     * @returns
+     */
+    voteStatus(pathParams: VotePathParams, params: {
+        action: string;
+        displayName?: string;
+        role?: string;
+        isAnonymous?: boolean;
+        allowAttendeeVote?: boolean;
+    }): Promise<any>;
+    /**
+     * 提交投票
+     * @param pathParams
+     * @param params
+     * @returns
+     */
+    voteSubmit(pathParams: VotePathParams, params: {
+        submitData: {
+            selectedQuestions: {
+                selectedOptionIDs: string[];
+                questionID: string;
+            }[];
+        };
+        userData: {
+            displayName: string;
+            account: string;
+            role: string;
+            subjectID: string;
+        };
+    }): Promise<any>;
+    /**
+     * 投票创建
+     * @param params
+     * @returns
+     */
+    voteAdd(params: VoteParams): Promise<any>;
+    /**
+     * 投票编辑
+     * @param params
+     * @returns
+     */
+    voteEdit(params: VoteParams): Promise<any>;
+    /**
+     * 投票删除
+     * @param params
+     * @returns
+     */
+    voteDelete(params: {
+        ids: string[];
+    }): Promise<any>;
+}
+
+declare interface VoteBody {
+    action: string;
+    status: number;
+    voteID: string;
+}
+
+export declare interface VoteData {
+    vote: Record<string, VoteBody>;
+}
+
+export declare interface VoteInfo {
+    allowAttendeeVote: boolean;
+    createTime: number;
+    endTime: number;
+    isAnonymous: boolean;
+    isSharing: boolean;
+    name: string;
+    startTime: number;
+    status: number;
+    totalVotedCount: number;
+    type: number;
+    version: number;
+    voteID: string;
+    questions: VoteQuestionInfo[];
+}
+
+export declare interface VoteParams {
+    name: string;
+    sourceId: string;
+    sourceType: number;
+    questions: VoteQuestionParams[];
+}
+
+declare interface VotePathParams {
+    voteID: string;
+    tk?: string;
+}
+
+export declare interface VoteQuestionInfo {
+    chooseAtLeast: number;
+    chooseAtMost: number;
+    index: number;
+    questionID: string;
+    required: boolean;
+    text: string;
+    type: number;
+    options: VoteQuestionOptionInfo[];
+    totalVotedCount: number;
+}
+
+export declare type VoteQuestionOptionInfo = {
+    index: number;
+    optionID: string;
+    text: string;
+    votedCount: number;
+};
+
+export declare interface VoteQuestionOptionParams {
+    sort: number;
+    type: number;
+    description: string;
+    id: string;
+}
+
+export declare interface VoteQuestionParams {
+    id: string;
+    sort: number;
+    showType: number;
+    required: boolean;
+    chooseAtLeast: number;
+    chooseAtMost: number;
+    description: string;
+    type: number;
+    options: VoteQuestionOptionParams[];
+}
+
+export declare class Words extends Module<WordsData> {
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 发送字幕
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    barrage(params: any): Promise<any>;
+    /**
+     * 删除字幕
+     * @params 设置参数
+     * @returns 返回的数据
+     */
+    deleteBarrage(): Promise<any>;
+}
+
+export declare interface WordsData {
+    wordsDisplayStatus: boolean;
+    barrageRecord: BarrageRecord[];
+    backgroundColor?: string;
+    content?: string;
+    contentType?: string;
+    duration?: number;
+    fontColor?: string;
+    fontSize?: number;
+    position?: string;
+    receiver?: {
+        host: boolean;
+        attendee: boolean;
+        audience: boolean;
+    };
+    type?: string;
+    timer?: NodeJS.Timeout | null;
+}
+
+/**
+ * meeting实例
+ */
+export declare interface YlinkSDKMeeting {
+    /**
+     * 全局配置
+     */
+    config: Pick<Context, 'config'>['config'];
+    /**
+     * 请求
+     */
+    request: Request_2;
+    /**
+     * 会议状态
+     */
+    state: STATE;
+    /**
+     * 全局事件监听
+     */
+    on: Emitter<Events>['on'];
+    /**
+     * 取消全局事件监听
+     */
+    off: Emitter<Events>['off'];
+    /**
+     * 加入会议
+     */
+    join: (params: JoinParams) => Promise<Response_2>;
+    /**
+     * 离开会议
+     */
+    leave: (params?: ResultInfo) => Promise<Response_2>;
+    /**
+     * 结束会议
+     */
+    end: () => Promise<Response_2>;
+    /**
+     * 模块 - 自身相关
+     */
+    me?: Me;
+    /**
+     * 模块 - 会议信息
+     */
+    info?: Info;
+    /**
+     * 模块 - 参会成员
+     */
+    users?: Users;
+    /**
+     * 模块 - 焦点视频
+     */
+    spotlightVideo?: SpotlightVideo;
+    /**
+     * 模块 - 邀请
+     */
+    invite?: Invite;
+    /**
+     * 模块 - 投票
+     */
+    vote?: Vote;
+    /**
+     * 模块 - 文字消息
+     */
+    words?: Words;
+    /**
+     * 聊天
+     */
+    chat?: Chat;
+    [props: string]: any;
+}
+
+export { }