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

package/dist/types/ctrl.d.ts

@@ -1,1026 +0,0 @@
-import { ENDPOINT_TYPE, ROLE } from './enums';
-import { UserState, Inbox, ResultInfo, CustomLayout, BasicLayout, Barrage } from './data';
-/**
- * SFU会控返回响应值
- */
-export interface Result<T = any> extends Response {
-    bizCode?: number;
-    ret: number;
-    data: T;
-    error?: {
-        errorCode: number;
-        fieldErrors: null;
-        msg: string;
-    };
-}
-export interface audioStats {
-    /**
-     * 编解码器
-     */
-    codec: string;
-    /**
-     * bps 带宽
-     */
-    bandwidth: number;
-    /**
-     * ms 环回延时
-     */
-    rtt: number;
-    /**
-     * ms 抖动
-     */
-    jitter: number;
-    /**
-     * % 丢包率
-     */
-    lossrate: number;
-    /**
-     * 个 丢包数
-     */
-    packetlost: number;
-}
-export interface videoStats {
-    /**
-     * bps 带宽
-     */
-    bandwidth: number;
-    /**
-     * ms 环回延时
-     */
-    rtt: number;
-    /**
-     * ms 抖动
-     */
-    jitter: number;
-    /**
-     * 分辨率宽
-     */
-    width: number;
-    /**
-     * 分辨率高
-     */
-    height: number;
-    /**
-     * 帧率
-     */
-    fr: number;
-    /**
-     * % 丢包率
-     */
-    lossrate: number;
-    /**
-     * 个 丢包数
-     */
-    packetlost: number;
-}
-/**
- * 会控功能
- */
-export interface Ctrl {
-    /**
-     * 取消请求，目前只针对polling和keepalive有效
-     * @since 1.0.0
-     */
-    cancelToken: (reason: string) => void;
-    developerToken: (params: {
-        version: string;
-        Authorization: string;
-        timestamp: string;
-        nonce: string;
-    }) => Promise<Result>;
-    /**
-     * 获取当前会议通告推送的收件箱信息
-     * @since 1.0.0
-     * @ignore
-     */
-    inbox: (params: {
-        basic: {
-            /**
-             * 租户Id,目前为100
-             */
-            tenantId: number;
-            /**
-             * 终端标识,由客户端保证唯一
-             */
-            clientId: string;
-            /**
-             * 每次会议的唯一标识
-             */
-            meetingId: string;
-        };
-        /**
-         * 终端订阅的topic对应的收件箱标识。
-         */
-        inboxes: Array<string>;
-    }) => Promise<Result>;
-    /**
-     * 消息轮询
-     * @since 1.0.0
-     * @ignore
-     */
-    polling: (params: {
-        basic: {
-            /**
-             * 租户Id,目前为100
-             */
-            tenantId: number;
-            /**
-             * 终端标识,由客户端保证唯一
-             */
-            clientId: string;
-            /**
-             * 每次会议的唯一标识
-             */
-            meetingId: string;
-        };
-        /**
-         * 收件箱对象的信息列表
-         */
-        inboxes: Array<Inbox>;
-    }) => Promise<Result>;
-    /**
-     * ## 获取入会秘钥
-     * @since 1.0.0
-     * @ignore
-     */
-    credential: (params: {
-        /**
-         * 会议号（如果不带url，则必选）
-         */
-        meetingNum?: string;
-        /**
-         * 会议密码
-         */
-        pwd?: string;
-        /**
-         * 入会链接，兼容3x的链接（如果不带meetingNum则必选）
-         */
-        url?: string;
-        /**
-         * 手机区号
-         */
-        mobileCode?: string;
-        /**
-         * 观众注册手机号
-         */
-        mobile?: string;
-        /**
-         * 观众注册邮箱
-         */
-        regEmail?: string;
-        /**
-         * 云账号邮箱
-         */
-        accEmail?: string;
-        /**
-         * 观众 tk
-         */
-        tk?: string;
-        /**
-         * 入会名称
-         */
-        displayName?: string;
-    }) => Promise<Result>;
-    /**
-     * ## 加入会议
-     * @since 1.0.0
-     * @ignore
-     */
-    join: (params: {
-        /**
-         * 会议号
-         */
-        meetingNum: string;
-        /**
-         * credential接口获取到的入会秘钥
-         */
-        credential: string;
-        /**
-         * 显示名
-         */
-        displayName: string;
-        /**
-         * 终端类型
-         */
-        endpointType: ENDPOINT_TYPE;
-        /**
-         * 邀请入会的事务ID, 邀请入会必选
-         */
-        inviteTransID?: string;
-        /**
-         * 组织架构id列表
-         */
-        groupIDs?: Array<string>;
-        /**
-         * 云账号
-         */
-        account?: string;
-        /**
-         * 终端设备类型UA
-         */
-        userAgent?: string;
-        /**
-         * 账号的GroupName名称
-         */
-        groupName?: string;
-        /**
-         * 终端设备ID
-         */
-        clientID?: string;
-        /**
-         * 网关主机uuid
-         */
-        gwID?: string;
-        /**
-         * 终端IP地址
-         */
-        clientIP?: string;
-        /**
-         * 分辨率信息，高清端口参数
-         */
-        mediaContentReq?: {
-            /**
-             * 视频参数设置
-             */
-            video?: {
-                /**
-                 * 分辨率宽
-                 */
-                width: number;
-                /**
-                 * 分辨率高
-                 */
-                height: number;
-                /**
-                 * 帧率
-                 */
-                fr: number;
-            };
-            /**
-             * 仅音频
-             */
-            audioOnly: boolean;
-        };
-    }) => Promise<Result>;
-    /**
-     * 上报用户媒体信息
-     * @since 1.0.0
-     * @ignore
-     */
-    updateUserState: (params: UserState) => Promise<Result>;
-    /**
-     * 订阅通告
-     * @since 1.0.0
-     * @ignore
-     */
-    subscribe: (params: {
-        /**
-         * 要订阅的的topic和inbox接口的inboxes一致
-         */
-        topics: Array<string>;
-    }) => Promise<Result>;
-    /**
-     * 邀请 trying
-     * @since 1.0.0
-     */
-    trying: (params: {
-        /**
-         * 账户token
-         */
-        token: string;
-        /**
-         * 终端类型
-         */
-        endpointType: ENDPOINT_TYPE;
-        /**
-         * 会议号
-         */
-        meetingNum: string;
-        /**
-         * credential接口获取到的入会秘钥
-         */
-        credential: string;
-        /**
-         * 邀请事务id
-         */
-        inviteTransID: string;
-        /**
-         * 0 默认，终端通知服务器已收到邀请通知，多次调用都能成功(目前不用调)
-         * 1 独占模式，用于一呼多只能一方入会的场景，多次trying只有第一次能成功，比如邀请IP或直播录播2 兼容3x使用，仅用于邀请v3x亿联终端，多次trying都成功且返回meetingID等数据
-         */
-        inviteMode?: number;
-    }) => Promise<Result>;
-    /**
-     * 邀请拒接
-     * @since 1.0.0
-     */
-    rejectCall: (params: {
-        /**
-         * 账户token
-         */
-        token: string;
-        /**
-         * 终端类型
-         */
-        endpointType: ENDPOINT_TYPE;
-        /**
-         * 会议号
-         */
-        meetingNum: string;
-        /**
-         * credential接口获取到的入会秘钥
-         */
-        credential: string;
-        /**
-         * 退会的信息
-         */
-        resultInfo?: ResultInfo;
-        /**
-         * 邀请事务id
-         */
-        inviteTransID: string;
-        /**
-         * YTMS设备id，也是会议邀请推送的ID
-         */
-        clientID?: string;
-    }) => Promise<Result>;
-    /**
-     * 离开会议
-     * @since 1.0.0
-     */
-    leave: (params: {
-        resultInfo: ResultInfo;
-    }) => Promise<Result>;
-    /**
-     * 上报通话统计
-     */
-    callStatsReport: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        stats: {
-            audio: audioStats;
-            video: videoStats;
-            share: videoStats;
-        };
-        deviceInfo: string;
-        protocol: string;
-    }) => Promise<Result>;
-    /**
-     * 闭音
-     * @since 1.0.0
-     */
-    pauseAudio: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-    }) => Promise<Result>;
-    /**
-     * 开音
-     * @since 1.0.0
-     */
-    resumeAudio: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-    }) => Promise<Result>;
-    /**
-     * 大厅切换
-     * @since 1.0.0
-     */
-    lobbyState: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 当isInLobby=true, 用户从会议中被移到会议大厅同时互动方切换为大厅用户。
-         * 当isInLobby=false, 用户从会议大厅被移到会议中，大厅用户切换为互动方。
-         */
-        isInLobby: boolean;
-    }) => Promise<Result>;
-    /**
-     * 改名
-     * @since 1.0.0
-     */
-    displayName: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 新用户名
-         */
-        displayName: string;
-    }) => Promise<Result>;
-    /**
-     * 获取通话统计
-     * @since 1.0.0
-     */
-    callStats: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-    }) => Promise<Result>;
-    /**
-     * 获取用户信息，若某个用户的seq发生跳变或者终端想获取单个用户的最新信息
-     * @since 1.0.0
-     */
-    user: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-    }) => Promise<Result>;
-    /**
-     * 禁屏
-     * @since 1.0.0
-     */
-    blockVideo: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-    }) => Promise<Result>;
-    /**
-     * 取消禁屏
-     * @since 1.0.0
-     */
-    unblockVideo: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-    }) => Promise<Result>;
-    /**
-     * 举手
-     * @since 1.0.0
-     */
-    handUp: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 是否举手，可选true举手，false手放下
-         */
-        handUp: boolean;
-    }) => Promise<Result>;
-    /**
-     * 响应举手
-     * @since 1.0.0
-     */
-    replyHandUp: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 当permit=true，主持人同意用户发言，若是与会者，同意举手就是允许发言；
-         * 若是观众同意举手，会切换广播方的状态为互动方并允许发言，但角色还是观众。
-         * permit=false，主持人不同意发言，手放下
-         */
-        permit: boolean;
-    }) => Promise<Result>;
-    /**
-     * 用户保活
-     * @since 1.0.0
-     * @ignore
-     */
-    keepalive: (params: {
-        /**
-         * 入会用户ID
-         */
-        userID: number;
-    }) => Promise<Result>;
-    /**
-     * 设置音频
-     * @since 1.0.0
-     */
-    audio: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 音频状态
-         */
-        sendOn: boolean;
-        /**
-         * 认证信息，当远端请求开启时下发的cred
-         */
-        cred?: string;
-    }) => Promise<Result>;
-    /**
-     * 设置视频
-     * @since 1.0.0
-     */
-    video: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 视频状态
-         */
-        sendOn: boolean;
-        /**
-         * 认证信息，当远端请求开启时下发的cred
-         */
-        cred?: string;
-    }) => Promise<Result>;
-    /**
-     * 设置辅流
-     * @since 1.0.0
-     */
-    share: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 辅流状态
-         */
-        sendOn: boolean;
-        /**
-         * 认证信息，当远端请求开启时下发的cred
-         */
-        cred?: string;
-        /**
-         * 是否需服务器提供辅流协助
-         */
-        serverCoop?: boolean;
-        /**
-         * 共享类型，可选参数：1-application(窗口)、2-desktop(屏幕)、3-whiteboard(白板)
-         */
-        type?: number;
-        /**
-         * 辅流分享模式，默认为高清辅流模式。可选：0-高清辅流模式，1-流畅度优先模式
-         */
-        mode?: number;
-    }) => Promise<Result>;
-    /**
-     * 修改角色
-     * @since 1.0.0
-     */
-    role: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 用户角色
-         */
-        role: ROLE | string;
-    }) => Promise<Result>;
-    /**
-     * 移出会议
-     * @since 1.0.0
-     */
-    remove: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 移出原因
-         */
-        resultInfo?: ResultInfo;
-    }) => Promise<Result>;
-    /**
-     * DTMF
-     * @since 1.0.0
-     */
-    dtmf: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 0~9，*，#
-         */
-        dtmf: string;
-    }) => Promise<Result>;
-    /**
-     * FECC
-     * @since 1.0.0
-     */
-    fecc: (params: {
-        /**
-         * 用户ID
-         */
-        userID: number;
-        /**
-         * 行为动作，取值可选：panLeft(摄像头左移)、panRight(摄像头右移)、tiltDown(摄像头下移)、tiltUp(摄像头上移)、zoomOut(缩小)、zoomIn(放大)、focusOut(分散)、focusIn(聚焦)
-         */
-        action: string;
-        /**
-         * 动作执行次数
-         */
-        actionPlayTimes: number;
-    }) => Promise<Result>;
-    /**
-     * 设置主持人布局
-     * @since 1.0.0
-     */
-    hostLayout: (params: {
-        /**
-         * 布局模式，可选参数：basic、custom
-         * 当mode=basic时，终端入会默认显示服务器推送的布局类型，但允许主持人、与会者本地切换为其它布局，研讨会观众无法切换
-         * 当mode=custom时，终端都固定显示，无法本地切换布局
-         */
-        mode: string;
-        /**
-         * 布局结构体；当mode=basic时无需带；当mode=custom，采用customLayout结构体
-         */
-        layout?: CustomLayout | BasicLayout;
-        /**
-         * 自定义布局是否同时应用于与会者
-         */
-        applyToAttendee?: boolean;
-    }) => Promise<Result>;
-    /**
-     * 设置与会者布局
-     * @since 1.0.0
-     */
-    attendeeLayout: (params: {
-        /**
-         * 布局模式，可选参数：basic、custom
-         * 当mode=basic时，终端入会默认显示服务器推送的布局类型，但允许主持人、与会者本地切换为其它布局，研讨会观众无法切换
-         * 当mode=custom时，终端都固定显示，无法本地切换布局
-         */
-        mode: string;
-        /**
-         * 布局结构体；当mode=basic时无需带；当mode=custom，采用customLayout结构体
-         */
-        layout?: CustomLayout | BasicLayout;
-    }) => Promise<Result>;
-    /**
-     * 设置观众布局
-     * @since 1.0.0
-     */
-    audienceLayout: (params: {
-        /**
-         * 布局模式，可选参数：basic、custom
-         * 当mode=basic时，终端入会默认显示服务器推送的布局类型，但允许主持人、与会者本地切换为其它布局，研讨会观众无法切换
-         * 当mode=custom时，终端都固定显示，无法本地切换布局
-         */
-        mode: string;
-        /**
-         * 布局结构体；当mode=basic时无需带；当mode=custom，采用customLayout结构体
-         */
-        layout?: CustomLayout | BasicLayout;
-    }) => Promise<Result>;
-    /**
-     * 应用个人布局
-     * @since 1.0.0
-     */
-    personalLayout: (params: {
-        /**
-         * 布局模式，为custom
-         */
-        mode: string;
-        /**
-         * 布局结构体，采用customLayout
-         */
-        layout: CustomLayout;
-        /**
-         * 个人布局订阅者信息
-         */
-        subscriber: {
-            userID?: number;
-            subjectID?: string;
-        };
-    }) => Promise<Result>;
-    /**
-     * 取消个人布局
-     * @since 1.0.0
-     */
-    personalLayoutDelete: (params: {
-        /**
-         * 个人布局订阅者参数
-         */
-        subscriber: {
-            userID?: number;
-            subjectID?: string;
-        };
-    }) => Promise<Result>;
-    /**
-     * 设置虚拟教室
-     * @since 1.0.0
-     */
-    virtualClassLayout: (params: {
-        /**
-         * 布局结构体，采用customLayout
-         */
-        layout: CustomLayout;
-        /**
-         * 布局个数，也是大屏终端屏幕个数
-         */
-        count: number;
-        /**
-         * 黑名单subjectID列表
-         */
-        blackList: string[];
-    }) => Promise<Result>;
-    /**
-     * 关闭虚拟教室
-     * @since 1.0.0
-     */
-    virtualClassClose: () => Promise<Result>;
-    /**
-     * 设置焦点视频
-     * @since 1.0.0
-     */
-    spotlight: (params: {
-        /**
-         * 操作类型 add/remove/replace/removeAll
-         */
-        action: string;
-        /**
-         * 被操作的用户，action不是removeAll则必选
-         */
-        userID?: number;
-    }) => Promise<Result>;
-    /**
-     * 大厅全部拒绝
-     * @since 1.0.0
-     */
-    lobbyRefuseAll: () => Promise<Result>;
-    /**
-     * 大厅全部准入
-     * @since 1.0.0
-     */
-    lobbyAdmitAll: () => Promise<Result>;
-    /**
-     * 发送弹幕
-     * @since 1.0.0
-     */
-    barrage: (params: Barrage) => Promise<Result>;
-    /**
-     * 关闭弹幕
-     * @since 1.0.0
-     */
-    deleteBarrage: () => Promise<Result>;
-    /**
-     * 获取操作记录
-     * @since 1.0.0
-     */
-    operationRecord: (params: {
-        /**
-         * 分页查询参数
-         */
-        skip: number;
-        /**
-         * 查询的数量
-         */
-        limit: number;
-        /**
-         * 排序的规则
-         */
-        orderbys?: {
-            /**
-             * 排序的字段
-             */
-            field: string;
-            /**
-             * 排序的类型，1:升序，-1:降序
-             */
-            order: number;
-        };
-        /**
-         * 搜索的key
-         */
-        searchKey?: string;
-        /**
-         * 查询role角色操作
-         */
-        role?: string;
-        /**
-         * 查询对应模块操作
-         */
-        opModule?: string;
-        /**
-         * 操作的结果，true:成功，false:失败
-         */
-        opResult?: boolean;
-    }) => Promise<Result>;
-    /**
-     * 获取分享信息
-     * @since 1.0.0
-     */
-    shareInfo: (params: {
-        /**
-         * 会议号码
-         */
-        meetingNum: string;
-        /**
-         * 需要预约成员信息带true
-         */
-        participant?: boolean;
-    }) => Promise<Result>;
-    /**
-     * 结束会议
-     * @since 1.0.0
-     */
-    end: () => Promise<Result>;
-    /**
-     * 结束准备模式
-     * @since 1.0.0
-     */
-    practiceSession: () => Promise<Result>;
-    /**
-     * 全部手放下
-     * @since 1.0.0
-     */
-    replyAllHandUp: () => Promise<Result>;
-    /**
-     * 全体解禁言
-     * @since 1.0.0
-     */
-    unmuteAll: () => Promise<Result>;
-    /**
-     * 全体禁言
-     * @since 1.0.0
-     */
-    muteAll: () => Promise<Result>;
-    /**
-     * 通知上报音频转储
-     * @since 1.0.0
-     */
-    audioDump: () => Promise<Result>;
-    mailTemplate: (params: {
-        /**
-         * 语言
-         */
-        language: string;
-    }) => Promise<Result>;
-    /**
-     * 问答
-     * @since 1.0.0
-     */
-    /**
-     * 发送聊天信息
-     */
-    msg: (params: {
-        /**
-         * 终端生成消息唯一id，可用随机数
-         */
-        msgID: string;
-        /**
-         * 消息的类型：text/plain。(后续根据产品需求可拓展支持text/enriched)
-         */
-        contentType: string;
-        /**
-         * 消息内容
-         */
-        content: string;
-        /**
-         * 消息类型，可选：0(群聊)、1(私聊)、2(发给大厅)
-         */
-        msgType?: number;
-        /**
-         * 接收者的信息
-         */
-        receiver?: {
-            userID: number;
-        };
-        /**
-         * 时间戳，服务器填
-         */
-        timestamp?: number;
-        /**
-         * 发送者的信息，服务器填
-         */
-        sender?: {
-            userID?: number;
-            displayName?: string;
-        };
-    }) => Promise<Result>;
-    /**
-     * 查询聊天历史信息
-     */
-    historyMsg: (params: {
-        /**
-         * 最大只返回100条，limit>100 或 limit<1时，limit都取100
-         */
-        limit: number;
-    }) => Promise<Result>;
-    /**
-     * 远程桌面
-     */
-    remoteDesktop: (params: {
-        /**
-         * 指令信息（包含request，close，refuse和connect）
-         */
-        action: string;
-        /**
-         * 被操作的用户
-         */
-        userID: number;
-    }) => Promise<Result>;
-    /**
-     * 通过会议号结束会议
-     */
-    endMeeting: (params: {
-        /**
-         * 会议号
-         */
-        meetingNum: string;
-    }) => Promise<Result>;
-    /**
-     * 获取会议静态
-     */
-    meetings: (params: {
-        /**
-         * 会议号
-         */
-        meetingNum: string;
-        /**
-         * 调取credential接口获取的临时秘钥
-         */
-        credential: string;
-        /**
-         * 需要预约成员信息带true
-         */
-        participant?: boolean;
-        /**
-         * 需要AVC配置信息带true
-         */
-        avcConfig?: boolean;
-    }) => Promise<Result>;
-    /**
-     * 获取请求baseURL
-     * @since 1.0.0
-     * @ignore
-     */
-    get baseURL(): string;
-    /**
-     * 设置请求baseURL
-     * @since 1.0.0
-     * @ignore
-     */
-    setBaseURL(url: string): void;
-    /**
-     * 获取 SDK token
-     */
-    get accessToken(): string;
-    /**
-     * 设置 SDK token
-     * @param token
-     */
-    setAccessToken(token: string): void;
-    /**
-     * 获取 SDK 版本
-     */
-    get version(): string;
-    /**
-     * 设置 SDK 版本
-     * @param version
-     */
-    setVersion(version: string): void;
-    /**
-     * 获取会话ID，标识一次入会的所有请求响应
-     * @since 1.0.0
-     */
-    get sessionID(): string;
-    /**
-     * 设置会话ID，标识一次入会的所有请求响应
-     * @since 1.0.0
-     * @param id 生成格式建议：YTMSclientID_MMddhhmmss_会议号_用户账号或enpointType
-     */
-    setSessionID(id: string): void;
-    /**
-     * 获取会议ID
-     * @since 1.0.0
-     */
-    get meetingID(): string;
-    /**
-     * 设置会议ID
-     * @since 1.0.0
-     * @param id 正常为join后返回的meetingID
-     */
-    setMeetingID(id: string): void;
-    /**
-     * 获取会议归属地
-     */
-    get location(): string;
-    /**
-     * 设置会议归属地，后续请求带header
-     * @param val credential时返回
-     */
-    setLocation(val: string): void;
-    /**
-     * 获取会控token
-     */
-    get ctrlID(): string;
-    /**
-     * 设置会控Token
-     * @param id 会控ctrlID，join后返回
-     */
-    setCtrlID(id: string): void;
-}