@rongcloud/engine 4.4.7 → 4.4.8-enterprise.2

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.4.7
- * CommitId - c8f27ba0690dc60de359e1467090faadf5b2248d
- * Thu Aug 26 2021 16:54:43 GMT+0800 (China Standard Time)
+ * RCEngine - v4.4.8-enterprise.2
+ * CommitId - bbd1ce6836028953773821c2b3b9ab8199bc732f
+ * Thu Dec 30 2021 17:52:45 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -337,6 +337,11 @@ interface IChrmKVEntry {
     type?: number;
     isDeleted?: boolean;
 }
+interface IChrmKVPullData {
+    kvEntries: IChrmKVEntry[];
+    isFullUpdate?: boolean;
+    syncTime?: number;
+}
 interface IServerConversationStatus {
     conversationType: number;
     targetId: string;
@@ -1409,6 +1414,7 @@ declare class DataCodec {
      * 全量 URI
      */
     encodeUserSetRTCData(message: any, valueInfo: string, objectName: string, mcuValInfo: string): any;
+    encodeUserSetRTCCDNUris(objectName: string, CDNUris: string): any;
     /**
      * 用户属性获取
     */
@@ -1749,6 +1755,10 @@ declare class WebSocketChannel extends ADataChannel {
      * @param apiVersion - apiVersion 需符合 `/\d+(\.\d+){2}/` 规则
      */
     connect(appkey: string, token: string, hosts: string[], protocol: 'http' | 'https', apiVersion: string): Promise<ErrorCode>;
+    /**
+     * 发起连接请求
+     */
+    private _connect;
     /**
      * 当前累计心跳超时次数
      */
@@ -1793,6 +1803,7 @@ declare class CometChannel extends ADataChannel {
      */
     _startPullSignal(protocol: 'http' | 'https'): Promise<void>;
     connect(appkey: string, token: string, hosts: string[], protocol: 'http' | 'https', apiVersion: string): Promise<ErrorCode>;
+    private _connect;
     private _idCount;
     private _generateMessageId;
     sendCometData(writer: BaseWriter, timeout?: number): Promise<void>;
@@ -2194,6 +2205,10 @@ interface IRTCRoomInfo {
 interface IJoinRTCRoomData extends IRTCUsers {
     token: string;
     sessionId: string;
+    roomInfo: {
+        key: string;
+        value: string;
+    }[];
 }
 
 /**
@@ -3325,6 +3340,10 @@ declare class APIContext {
      * 清除会话消息未读数
      */
     clearUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+    /**
+     * 清除全部会话消息未读数
+     */
+    clearAllUnreadCount(): Promise<ErrorCode>;
     /**
      * 获取指定会话消息未读数
      */
@@ -3654,6 +3673,7 @@ declare class APIContext {
         name: string;
         content: string;
     }, valueInfo: string, objectName: string, mcuValInfo?: string): Promise<ErrorCode>;
+    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
     getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): Promise<IAsyncRes<KVString>>;
     removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
         name: string;
@@ -3678,6 +3698,10 @@ declare class APIContext {
      * 直播身份切换
      */
     rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
+    /**
+     * 拉取 RTC 全量 KV
+     */
+    pullRTCRoomEntry(roomId: string, timestamp: number): Promise<IAsyncRes<IChrmKVPullData>>;
 }
 
 declare class RTCPluginContext extends PluginContext {
@@ -3732,6 +3756,22 @@ declare class RTCPluginContext extends PluginContext {
      * mcu 合流发布内容，是一个 JSON 字符串，解析类型为 {mediaType: number, msid: string, uri: string}[]
      */
     mcuValInfo?: string): Promise<ErrorCode>;
+    /**
+     * 设置 cdn_uris 扩散
+     * @param objectName 全量 URI 消息名，即 `RCRTC:TotalContentResources`
+     * @param CDNUris cdn_uris 扩散字段
+     * {
+        "broadcast":0,
+        "fps":25,
+        "h":640,
+        "pull_safe":true,
+        "push_mode":1,
+        "url":"https://rtc-media-api-service-ucbj2-01.rongcloud.net/api/rtc/cdn/player",
+        "w":360,
+        "enableInnerCDN":true
+      }[]
+     */
+    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
     getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
     removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
         name: string;
@@ -3756,6 +3796,10 @@ declare class RTCPluginContext extends PluginContext {
      * 直播身份切换
      */
     rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
+    /**
+     * 拉取 RTC 全量 KV
+     */
+    pullRTCRoomEntry(roomId: string, timestamp: number): IPromiseResult<IChrmKVPullData>;
 }
 
 declare abstract class ANavi {
@@ -4252,6 +4296,7 @@ interface IEngine {
     getRTCToken(roomId: string, mode: number, broadcastType?: number): IPromiseResult<IRtcTokenData>;
     setRTCState(roomId: string, reportId: string): Promise<ErrorCode>;
     getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
+    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
 }
 
 interface IExpansionMsgContent {
@@ -4451,6 +4496,10 @@ declare abstract class AEngine implements IEngine {
      * 清除指定会话未读数
      */
     abstract clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    /**
+     * 清除全部会话未读数
+     */
+    abstract clearAllUnreadCount(): Promise<ErrorCode>;
     /**
      * 获取第一个未读消息
      */
@@ -4802,6 +4851,8 @@ declare abstract class AEngine implements IEngine {
     }>>;
     abstract quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
     abstract rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
+    abstract setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
+    abstract pullRTCRoomEntry(roomId: string, timestamp: number): Promise<IAsyncRes<IChrmKVPullData>>;
 }
 
 declare class AppStorage {