@ylink-sdk/meeting 0.2.0-beta.8 → 0.2.1

package/dist/meeting.d.ts

@@ -12,6 +12,33 @@ declare type AddVirtualClassParams = VirtualClassParams & {
     type: number;
 };
 
+export declare interface audioStats {
+    /**
+     * 编解码器
+     */
+    codec: string;
+    /**
+     * bps 带宽
+     */
+    bandwidth: number;
+    /**
+     * ms 环回延时
+     */
+    rtt: number;
+    /**
+     * ms 抖动
+     */
+    jitter: number;
+    /**
+     * % 丢包率
+     */
+    lossrate: number;
+    /**
+     * 个 丢包数
+     */
+    packetlost: number;
+}
+
 declare interface BarrageRecord {
     content: string;
     time: number;
@@ -99,6 +126,10 @@ declare interface Config {
      * ```
      */
     modules: any[];
+    /**
+     * 当前设备ID
+     */
+    clientID?: string;
     /**
      * 消息推送采用子线程模式，避免推送过快，抢占请求资源
      * @example
@@ -244,6 +275,10 @@ export declare interface Context {
              * 是否运行中
              */
             running: boolean;
+            /**
+             * 重试次数
+             */
+            attempts: number;
             /**
              * 定时器
              */
@@ -257,6 +292,10 @@ export declare interface Context {
              * 是否运行中
              */
             running: boolean;
+            /**
+             * 重试次数
+             */
+            attempts: number;
             /**
              * 定时器
              */
@@ -328,7 +367,11 @@ export declare enum ENDPOINT_TYPE {
     /**
      * PSTN电话
      */
-    PSTN = "pstn"
+    PSTN = "pstn",
+    /**
+     * 多流终端 - 从流
+     */
+    MULTI_STREAM = "multiStream"
 }
 
 /**
@@ -363,6 +406,12 @@ declare type Events = {
     [MeEvent.UPDATE]: any;
     [MeEvent.ROLECHANGE]: ROLE;
     [MeEvent.LOBBYCHANGE]: boolean;
+    pollError: {
+        message: string;
+    };
+    keepaliveError: {
+        message: string;
+    };
     me: any;
     setUserVideo: any;
     setUserAudio: any;
@@ -388,6 +437,13 @@ declare type Events = {
     chatMsg: any;
     transcriptMsg: any;
     qa: any;
+    queryCallStats: {
+        body: {
+            interval: number;
+            count: number;
+        };
+    };
+    interpretation: any;
 };
 
 declare type Events_10 = {
@@ -417,12 +473,16 @@ declare type Events_12 = {
     transcriptMsg: Transcription;
 };
 
-declare type Events_13 = Record<EventType, unknown>;
+declare type Events_13 = {
+    interpretationChange: InterpretationData;
+};
 
-declare type Events_14 = Record<EventType, any>;
+declare type Events_14 = Record<EventType, unknown>;
 
 declare type Events_15 = Record<EventType, any>;
 
+declare type Events_16 = Record<EventType, any>;
+
 declare type Events_2 = {
     [MeEvent.INIT]: MeData;
     [MeEvent.UPDATE]: any;
@@ -630,10 +690,47 @@ export declare interface InfoData {
     practiceSession?: boolean;
     audienceHideNonVideoEnabled?: boolean;
     webinarSurveyLink?: string;
+    interpretationEnabled?: boolean;
     participantCount: {
         hostAttendee: number;
         audience: number;
     };
+    multiStreamEnabled?: boolean;
+}
+
+export declare class Interpretation extends Module<InterpretationData, Events_13> {
+    constructor(ctx: Context);
+    _topic(): string;
+    _bindOn(): void;
+    /**
+     * 开启或更新传译
+     * @param params
+     * @returns
+     */
+    interpretationStart(params: {
+        interpreters: InterpretationData['interpreters'];
+    }): Promise<any>;
+    /**
+     * 结束同声传译
+     * @returns
+     */
+    interpretationEnd(): Promise<any>;
+}
+
+export declare type InterpretationData = {
+    status: 'started' | 'stopped';
+    interpreters: {
+        userID?: number;
+        subjectID?: string;
+        displayName: string;
+        firstLanguage: Language;
+        secondLanguage: Language;
+    }[];
+};
+
+export declare interface InterpretationPayload {
+    body: InterpretationData;
+    state: PollingPayloadState;
 }
 
 export declare class Invite extends Module<InviteData, Events_6> {
@@ -731,6 +828,11 @@ export declare interface JoinParams {
     tk?: string;
 }
 
+export declare interface Language {
+    name: string;
+    id: number;
+}
+
 export declare interface Layout {
     mode: LayoutMode;
     layout: LayoutContent;
@@ -774,7 +876,7 @@ export declare interface Live {
     userID?: string;
 }
 
-export declare class LiveStream extends Module<LiveStreamData, Events_13> {
+export declare class LiveStream extends Module<LiveStreamData, Events_14> {
     constructor(ctx: Context);
     _topic(): string;
     _bindOn(): void;
@@ -858,6 +960,7 @@ export declare interface MeData {
         audio: MediaState;
         video: MediaState;
     };
+    account?: string;
     mediaContent?: {
         accessMCs: Array<string>;
         addrType: number;
@@ -884,20 +987,22 @@ export declare interface MeData {
 
 /**
  * 媒体
+ * TODO
  */
 export declare interface MediaState {
+    /**
+     * 媒体开关状态
+     */
+    sendOn: boolean;
     /**
      * 设备的开启状态，true设备可用/false设备不可用
      */
     deviceOn?: boolean;
     /**
-     * 暂不使用
+     * 暂停音频
      */
     recvOn?: boolean;
-    /**
-     * 媒体开关状态
-     */
-    sendOn: boolean;
+    blocked?: boolean;
 }
 
 export declare enum MeEvent {
@@ -1130,7 +1235,7 @@ export declare interface QuestionAnswer {
     timestamp: number;
 }
 
-declare type ReactiveReturn = {
+export declare type ReactiveReturn = {
     /**
      * 取消响应式关联
      */
@@ -1151,7 +1256,7 @@ export declare enum RECORD_STATUS {
     STOPPED = "stopped"
 }
 
-export declare class Recording extends Module<RecordingData, Events_14> {
+export declare class Recording extends Module<RecordingData, Events_15> {
     constructor(ctx: Context);
     _topic(): string;
     _bindOn(): void;
@@ -1237,7 +1342,7 @@ export declare interface RecordingData {
     resultInfo: {
         bizCode?: string;
     };
-    jetlag: number;
+    stime: number;
 }
 
 export declare interface RecordingMap {
@@ -1275,6 +1380,8 @@ export declare interface RecordLayoutMap {
 export declare interface RecordUsers {
     subjectID: string;
     userID?: number;
+    isMultiStreamRecordUser?: boolean;
+    multiStreamPictureCount?: number;
 }
 
 export declare function reset(ctx: Context): void;
@@ -1359,7 +1466,7 @@ export declare interface SetMedia {
     };
 }
 
-export declare class Setting extends Module<SettingData, Events_15> {
+export declare class Setting extends Module<SettingData, Events_16> {
     constructor(ctx: Context);
     _topic(): string;
     _bindOn(): void;
@@ -1532,7 +1639,7 @@ export declare interface User {
     /**
      * 终端类型
      */
-    endpointType?: ENDPOINT_TYPE;
+    endpointType: ENDPOINT_TYPE;
     /**
      * 用户名
      */
@@ -1603,6 +1710,17 @@ export declare interface User {
     localRecord?: {
         status: RECORD_STATUS;
     };
+    /**
+     * 传译员
+     */
+    interpret?: {
+        isInterpreter: boolean;
+        activeLanguage: string;
+    };
+    /**
+     * 多流终端中主流UserID
+     */
+    parentUserID?: number;
 }
 
 /**
@@ -1625,6 +1743,9 @@ export declare interface UserMedia {
      * 操作者 1(other) 表示被别人操作；0(self) 或没有该字段 表示自己操作
      */
     opBy?: number;
+    serverCoop?: boolean;
+    sourceID?: number;
+    blocked: boolean;
 }
 
 export declare class Users extends Module<UsersData, Events_4> {
@@ -1632,6 +1753,11 @@ export declare class Users extends Module<UsersData, Events_4> {
     constructor(ctx: Context);
     _topic(): string[] | "interactive";
     _bindOn(): void;
+    /**
+     * 关联外部响应式数据
+     * @param obj
+     */
+    reactive(obj: Record<any, any>): UsersData & ReactiveReturn;
     cleanup(): void;
     /**
      * 更新 - 补充用户信息：
@@ -1760,6 +1886,24 @@ export declare class Users extends Module<UsersData, Events_4> {
      * @returns
      */
     callStats(userID: number): Promise<any>;
+    /**
+     * 上报通话统计
+     * @param userID
+     * @returns
+     */
+    callStatsReport(params: {
+        /**
+         * 用户ID
+         */
+        userID: number;
+        stats: {
+            audio: audioStats;
+            video: videoStats;
+            share: videoStats;
+        };
+        deviceInfo: string;
+        protocol: string;
+    }): Promise<any>;
     /**
      * 举手全部拒绝
      * @returns
@@ -1775,6 +1919,40 @@ export declare class Users extends Module<UsersData, Events_4> {
      * @returns
      */
     refuseAll(): Promise<any>;
+    /**
+     * 获取设备发送布局及视频源信息
+     * @param userID
+     * @returns
+     */
+    getSendLayout(userID: number): Promise<any>;
+    /**
+     * 设置设备发送布局
+     * @param userID
+     * @param params
+     * @returns
+     */
+    setSendLayout(userID: number, params: {
+        sendLayout: {
+            type: string;
+            pictures: {
+                index: number;
+                videoSources: {
+                    deviceID: string;
+                }[];
+            }[];
+        };
+        applyToPeopleVideo: boolean;
+        applyToContentVideo: boolean;
+    }): Promise<any>;
+    /**
+     * 更新用户发送布局状态
+     * @param userID
+     * @param params
+     * @returns
+     */
+    setSendLayoutEnabled(userID: number, params: {
+        enabled: boolean;
+    }): Promise<any>;
 }
 
 /**
@@ -1799,6 +1977,41 @@ export declare interface UsersData {
     advCtrlUsers: User[];
 }
 
+export declare interface videoStats {
+    /**
+     * bps 带宽
+     */
+    bandwidth: number;
+    /**
+     * ms 环回延时
+     */
+    rtt: number;
+    /**
+     * ms 抖动
+     */
+    jitter: number;
+    /**
+     * 分辨率宽
+     */
+    width: number;
+    /**
+     * 分辨率高
+     */
+    height: number;
+    /**
+     * 帧率
+     */
+    fr: number;
+    /**
+     * % 丢包率
+     */
+    lossrate: number;
+    /**
+     * 个 丢包数
+     */
+    packetlost: number;
+}
+
 export declare class View extends Module<ViewData, Events_10> {
     constructor(ctx: Context);
     _topic(): string[];
@@ -2257,6 +2470,10 @@ export declare interface YlinkSDKMeeting {
      * 语音转写
      */
     transcript?: Transcript;
+    /**
+     * 同声传译
+     */
+    interpretation?: Interpretation;
     [props: string]: any;
 }