@ylink-sdk/meeting 0.8.0-beta.2 → 0.8.0-beta.21

package/dist/meeting.d.ts

@@ -3,7 +3,6 @@
 import { Canceler } from '@ylink-sdk/shared/src';
 import { Emitter } from '@ylink-sdk/shared/src';
 import { EventType } from '@ylink-sdk/shared/src';
-import { EventType as EventType_2 } from '@ylink-sdk/shared';
 import { ICancelToken } from '@ylink-sdk/shared/src';
 import { Request as Request_2 } from '@ylink-sdk/shared/src';
 import { RequestError } from '@ylink-sdk/shared/src';
@@ -116,12 +115,42 @@ export declare interface audioStats {
     packetlost: number;
 }
 
-declare interface BarrageRecord {
+export declare interface BarrageRecord {
+    index: number;
     id: string;
     content: string;
     time: number;
     durationType: string;
     duration: number;
+    timestamp: number;
+}
+
+export declare interface BarrageWord {
+    index: number;
+    backgroundColor?: string;
+    content?: string;
+    contentType?: string;
+    duration?: number;
+    fontColor?: string;
+    fontSize?: number;
+    position?: string;
+    durationType?: string;
+    receiver?: {
+        host: boolean;
+        attendee: boolean;
+        audience: boolean;
+        designated: boolean;
+    };
+    designatedUsers?: DesignatedUsers[];
+    type?: string;
+    timestamp?: string;
+    timer?: NodeJS.Timeout | null;
+    timerMap?: Record<number, NodeJS.Timeout | null>;
+}
+
+declare interface BroadcastLayout {
+    mode: string;
+    layout: unknown;
 }
 
 /**
@@ -145,6 +174,9 @@ export declare interface CallRecordUser {
         subjectID?: string;
         deviceID?: string;
     };
+    secretLevel?: number;
+    smDeviceSecretLevel?: number;
+    smDeviceName?: string;
 }
 
 export declare class Chat extends Module<ChatData, Events_16> {
@@ -342,6 +374,10 @@ export declare interface Context {
              * 鉴权
              */
             credential: string;
+            /**
+             * 会议多活区域归属地
+             */
+            multiActiveRegion: string;
         };
     };
     /**
@@ -428,7 +464,7 @@ export declare interface DefaultLiveStreamingConfig {
     defaultAddrRandom: boolean;
 }
 
-declare interface DesignatedUsers {
+export declare interface DesignatedUsers {
     subjectID: string;
     userID: number;
 }
@@ -512,7 +548,11 @@ export declare enum ENDPOINT_TYPE {
     /**
      * 网真设备
      */
-    TELE_PRESENCE = "telePresence"
+    TELE_PRESENCE = "telePresence",
+    /**
+     * RTSP终端(rtsp接入)
+     */
+    RTSP_Access = "rtspAccess"
 }
 
 /**
@@ -604,14 +644,19 @@ declare type Events = {
     presetLayout: any;
     liveStreaming: any;
     remoteDesktop: any;
+    rtspAccess: any;
+    topMC: any;
 };
 
 declare type Events_10 = {
     callRecordUsersChange: CallRecordUser[];
 };
 
-declare type Events_11 = Record<EventType_2, any> & {
+declare type Events_11 = Record<EventType, any> & {
     liveStreamsChange: Live[];
+    liveStreamsDelete: Live[];
+    liveStreamsAdd: Live[];
+    liveStreamsUpdate: Live[];
 };
 
 declare type Events_12 = Record<EventType, any> & {
@@ -632,6 +677,7 @@ declare type Events_14 = {
 
 declare type Events_15 = {
     barrageRecordChange: BarrageRecord[];
+    barrageWordChange: WordsData;
 };
 
 declare type Events_16 = {
@@ -688,6 +734,10 @@ declare type Events_2 = {
     [MeEvent.BARRAGECHANGE]: MeData['barrage'] | null;
     [MeEvent.PERSONALLAYOUTCHANGE]: MeData['personalLayout'];
     [MeEvent.PERMCHANGE]: number;
+    [MeEvent.TOPMCCHANGE]: {
+        topMC: string;
+        topMCSeq: number;
+    };
     [MeEvent.LEAVE]: any;
 };
 
@@ -716,6 +766,18 @@ declare type Events_23 = {
     remoteDesktopChange: RemoteDesktopBody;
 };
 
+declare type Events_24 = {
+    accessListChange: RTSPAccess[];
+    defaultResolutionChange: string;
+    defaultLayoutChange: {
+        mode?: string;
+        type?: string;
+        layout?: LayoutContent;
+        layoutType?: string;
+    };
+    rtspAccessChange: RTSPData;
+};
+
 declare type Events_3 = Record<EventType, any>;
 
 declare type Events_4 = Record<EventType, any>;
@@ -949,6 +1011,26 @@ export declare class Info extends Module<InfoData, Events_3> {
         subjectIDs: string[];
         meetingNum: string;
     }): Promise<any>;
+    /**
+     * 发送会议邀请邮件
+     * @param params
+     * @returns
+     */
+    sendInvitationMail(params: {
+        meetingNum: string;
+        language: string;
+        subject: string;
+        receivers: string[];
+    }): Promise<any>;
+    /**
+     * 会议邀请邮件(UC)
+     * @param params
+     * @returns
+     */
+    getMailTemplate(meetingNum: string, params: {
+        language: string;
+        withFormat: boolean;
+    }): Promise<any>;
 }
 
 export declare interface InfoData {
@@ -959,7 +1041,7 @@ export declare interface InfoData {
     consentToRecord: boolean;
     createType: 'vmr' | 'scheduled' | 'meetNow';
     eid: string;
-    meetingType: 'meeting' | 'webinar';
+    meetingType: 'meeting' | 'webinar' | 'audio';
     organizer: {
         displayName: string;
         subjectID: string;
@@ -975,8 +1057,12 @@ export declare interface InfoData {
     recordUserEnabled: boolean;
     premiseRecordEnabled?: boolean;
     liveStreamingPlatformList?: number[];
+    digitalWatermarkEnabled: boolean;
+    noUserMeetingKeepMinute: number;
+    noUserMeetingKeepEnabled: boolean;
     planID?: string;
     vmrID?: string;
+    allowRecord?: boolean;
     allowLocalRecord?: boolean;
     youtubeLiveStreamDisabled?: boolean;
     allowLiveStream?: boolean;
@@ -999,6 +1085,7 @@ export declare interface InfoData {
     isRecurrence?: boolean;
     thirdPartyLiveEnabled?: boolean;
     allowRTSP?: boolean;
+    allowRTSPAccess?: boolean;
     maxBandwidth?: string;
     allowAudioRecord?: boolean;
     hostKeyEnabled?: boolean;
@@ -1006,6 +1093,8 @@ export declare interface InfoData {
     interactCooperationEnabled?: boolean;
     sessionID?: number;
     premiseBackupRecordEnabled?: boolean;
+    secretLevel?: number;
+    allowShare?: boolean;
 }
 
 export declare class Interpretation extends Module<InterpretationData, Events_20> {
@@ -1181,6 +1270,7 @@ export declare interface Layout {
     layout: LayoutContent;
     seq?: number;
     applyToAttendee?: boolean;
+    autoSave?: boolean;
 }
 
 export declare interface LayoutContent {
@@ -1191,6 +1281,11 @@ export declare interface LayoutContent {
     hideNonVideo?: boolean;
     name?: string;
     pollCount?: number;
+    pollDesignated?: {
+        userID: number;
+        subjectID: string;
+        pollSeconds: number;
+    }[];
     pollSeconds?: number;
     pictures?: Picture[];
     count?: number;
@@ -1223,10 +1318,11 @@ export declare interface Live {
         mode?: string;
         type?: string;
         layout?: LayoutContent;
+        layoutType?: string;
     };
     liveCaptionEnabled?: boolean;
     platform?: string;
-    status: string;
+    status?: string;
     watchURL?: string;
     requesting?: boolean;
     resultInfo?: ResultInfo;
@@ -1236,11 +1332,11 @@ export declare interface Live {
     isChange?: boolean;
     isTemplateSubmit?: boolean;
     template?: LayoutContent;
-    data?: LiveData;
+    data: LiveData;
     thirdPartyLiveData?: ThirdPartyLiveData[];
 }
 
-declare interface LiveData {
+export declare interface LiveData {
     index: number;
     title: string;
     liveUrl: string;
@@ -1476,6 +1572,7 @@ export declare interface MeData {
         crypto: string;
         meetingParam: string;
         topMC: string;
+        topMCSeq: number;
     };
     audio?: MeMedia;
     video?: MeMedia;
@@ -1604,6 +1701,10 @@ export declare enum MeEvent {
      * 临时分配的权限变更
      */
     PERMCHANGE = "permChange",
+    /**
+     * TopMC 变更
+     */
+    TOPMCCHANGE = "mediaTopMCChange",
     /**
      * 离开会议
      */
@@ -1704,6 +1805,7 @@ export declare interface PresetLayout {
     isApplyToHost?: boolean;
     isApplyToAttendee?: boolean;
     isApplyToAudience?: boolean;
+    isApplyToRecord?: boolean;
 }
 
 export declare interface PresetLayoutUpdate {
@@ -1933,6 +2035,7 @@ export declare interface RecordingData {
 
 export declare interface RecordingMap {
     status?: RecordingStatus;
+    followAttendee?: boolean;
     layout: {
         layout?: LayoutContent;
         mode?: string;
@@ -2162,6 +2265,73 @@ export declare interface RollcallVideo {
     index: number;
 }
 
+export declare class RTSP extends Module<RTSPData, Events_24> {
+    constructor(ctx: Context);
+    _topic(): string[];
+    _bindOn(): void;
+    cleanup(): void;
+    /**
+     * 创建RTSP接入
+     * @returns
+     */
+    createRTSPAccess(params: {
+        resolution: string;
+        mode: string;
+        layout: {
+            type: string;
+        } | LayoutContent;
+    }): Promise<any>;
+    /**
+     * 修改RTSP接入
+     * @returns
+     */
+    setRTSPAccess(params: {
+        index: number;
+        resolution: string;
+        mode: string;
+        layout: {
+            type: string;
+        } | LayoutContent;
+    }): Promise<any>;
+    /**
+     * 删除RTSP接入
+     * @returns
+     */
+    deleteRTSPAccess(params: {
+        index: number;
+    }): Promise<any>;
+}
+
+export declare interface RTSPAccess {
+    index: number;
+    urls: string[];
+    resolution: string;
+    layout: {
+        mode?: string;
+        type?: string;
+        layout?: LayoutContent;
+        layoutType?: string;
+    };
+}
+
+export declare type RTSPBody = RTSPData;
+
+export declare type RTSPData = {
+    accessList: RTSPAccess[];
+    defaultResolution: string;
+    defaultLayout: {
+        mode?: string;
+        type?: string;
+        layout?: LayoutContent;
+        layoutType?: string;
+    };
+};
+
+export declare interface RTSPPayload {
+    body: RTSPBody;
+    state: PollingPayloadState;
+}
+
 export declare interface SetMedia {
     cred: string;
     sendOn: boolean;
@@ -2208,14 +2378,17 @@ export declare interface SettingData {
     onlyAuthUserCanJoin: boolean;
     onlyAuthUserCanJoinLock: boolean;
     allowRenameSelfLock: boolean;
+    allowRemoteControlLock: boolean;
     allowRemoteControl: boolean;
     chatSetting: {
         attendeePermission: 'all' | 'public' | 'host' | 'disabled';
         audiencePermission: 'all' | 'public' | 'host' | 'disabled';
         allowAudienceViewHistory: boolean;
+        enabled: boolean;
     };
     avcSetting: {
         showSiteIcon: boolean;
+        showSiteIconLock: boolean;
         showSelfEnabled: boolean;
         speakerShowSelf: boolean;
     };
@@ -2358,12 +2531,13 @@ export declare class SpotlightVideo extends Module<SpotlightVideoData, Events_7>
      */
     spotlight(params: {
         userID: number;
-        action: 'add' | 'remove' | 'replace' | 'removeAll';
+        action: 'add' | 'remove' | 'replace' | 'removeAll' | 'broadcast';
     }): Promise<any>;
 }
 
 export declare interface SpotlightVideoData {
     userIDs: number[];
+    broadcast: BroadcastLayout | null;
 }
 
 /**
@@ -2586,6 +2760,22 @@ export declare interface User {
      * 所属组织名称
      */
     groupName?: Array<string>;
+    /**
+     * 邀请方式类型
+     */
+    inviteType?: string;
+    /**
+     * 【涉密版本独有】用户会议密级
+     */
+    secretLevel?: number;
+    /**
+     * 【涉密版本独有】参会设备最高参会密级
+     */
+    smDeviceSecretLevel?: number;
+    /**
+     * 【涉密版本独有】参会设备名称
+     */
+    smDeviceName?: string;
 }
 
 export declare interface UserInfo {
@@ -3460,29 +3650,16 @@ export declare class Words extends Module<WordsData, Events_15> {
      * @params 设置参数
      * @returns 返回的数据
      */
-    deleteBarrage(): Promise<any>;
+    deleteBarrage(params?: {
+        indexes: number[];
+    }): Promise<any>;
 }
 
-export declare interface WordsData {
+export declare type WordsData = {
     wordsDisplayStatus: boolean;
-    designatedUsers: DesignatedUsers[];
     barrageRecord: BarrageRecord[];
-    backgroundColor?: string;
-    content?: string;
-    contentType?: string;
-    duration?: number;
-    fontColor?: string;
-    fontSize?: number;
-    position?: string;
-    receiver?: {
-        host: boolean;
-        attendee: boolean;
-        audience: boolean;
-        designated: boolean;
-    };
-    type?: string;
-    timer?: NodeJS.Timeout | null;
-}
+    list: BarrageWord[];
+} & BarrageWord;
 
 /**
  * meeting实例
@@ -3610,6 +3787,10 @@ export declare interface YlinkSDKMeeting {
      * 远程控制
      */
     remoteDesktop?: RemoteDesktop;
+    /**
+     * RTSP 接入
+     */
+    rtsp?: RTSP;
     [props: string]: any;
 }