@rongcloud/plugin-call-plus 2.1.8 → 2.2.0-enterprise-lz-alpha.1

package/index.d.ts

@@ -1,5 +1,5 @@
-import { RCConnectionStatus, EventEmitter, BasicLogger, RTCJoinType, EnableLogL, PluginContext, IRuntime, IReceivedMessage, IPluginGenerator } from '@rongcloud/engine';
-import { RCRTCClient, RCRemoteTrack, RCTrack, ISubscribeAttr, RCRTCCode, RCLocalAudioTrack, RCRemoteAudioTrack, RCFrameRate, RCResolution } from '@rongcloud/plugin-rtc';
+import { RCConnectionStatus, EventEmitter, BasicLogger, PluginContext, EnableLogL, IReceivedMessage, IPluginGenerator } from '@rongcloud/engine';
+import { RCRemoteTrack, RCTrack, ISubscribeAttr, RCRTCCode, RCLocalAudioTrack, RCRemoteAudioTrack, RCRTCClient, RCFrameRate, RCResolution } from '@rongcloud/plugin-rtc';
 export { RCFrameRate as RCCallPlusFrameRate, RCResolution as RCCallPlusResolution } from '@rongcloud/plugin-rtc';
 
 /**
@@ -413,7 +413,11 @@ declare enum RCCallPlusReason {
     /**
      * 远端用户的其他端已经在房间中，不允许 joinRoom 进行音视频通话
      */
-    REMOTE_OTHER_CLIENT_IN_RTC = 1214
+    REMOTE_OTHER_CLIENT_IN_RTC = 1214,
+    /**
+     * 加密通话失败，如获取秘钥失败等
+     */
+    ENCRYPT_FAILED = 1216
 }
 
 /**
@@ -471,6 +475,10 @@ interface IBaseSingalCon {
  * 开始呼叫信令内容
  */
 interface IStartCallCon {
+    /**
+     * 客户端生成，传给服务
+     */
+    callId?: string;
     /**
      * 用户生成 callId
      */
@@ -491,6 +499,10 @@ interface IStartCallCon {
      * 是否密聊
      */
     secretChat: SecretCallType;
+    /**
+     * 密钥
+     */
+    secretChatKey: string;
     /**
      * 当前用户的来源组 ID 类型
      */
@@ -515,11 +527,16 @@ interface IStartCallCon {
      * 附加信息，服务器透传
      */
     extra?: string;
+    innerExtra?: string;
 }
 /**
  * 单呼信令内容
  */
 interface IStartSingleCon {
+    /**
+     * 客户端生成，传递给服务
+     */
+    callId?: string;
     /**
      * 用户生成 callId
      */
@@ -565,11 +582,16 @@ interface IStartSingleCon {
      * 服务端接收的推送扩展
      */
     pushExt?: string;
+    innerExtra?: string;
 }
 /**
  * 群呼信令内容
  */
 interface IStartGroupCon {
+    /**
+     * 客户端生成，传递给服务
+     */
+    callId?: string;
     /**
      * 用户生成 callId
      */
@@ -606,6 +628,16 @@ interface IStartGroupCon {
      * 服务端接收的推送扩展
      */
     pushExt?: string;
+    innerExtra?: string;
+    /**
+     * 是否密聊(0: 否；1: 是)
+     * PC 目前无密聊，写死 0
+     */
+    secretChat: SecretCallType;
+    /**
+     * 单聊加密 key
+     */
+    secretChatKey?: string;
 }
 /**
  * 开始呼叫 Server 返回
@@ -642,6 +674,7 @@ interface IInviteCallCon extends IBaseSingalCon {
      * 服务端接收的推送扩展
      */
     pushExt?: string;
+    innerExtra?: string;
 }
 /**
  * 邀请好友加入信令结果
@@ -720,7 +753,7 @@ interface IPubInviteCon extends IBaseSingalCon {
     /**
      * 媒体类型
      */
-    mediaType: RCCallPlusMediaType;
+    mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO;
     /**
      * 是否密聊
      */
@@ -741,6 +774,14 @@ interface IPubInviteCon extends IBaseSingalCon {
      * 附加信息
      */
     extra?: string;
+    /**
+     * 可存储的扩展信息，由发起人发起时定义
+     */
+    innerExtra?: string;
+    /**
+     * 通话加密密钥
+     */
+    secretChatKey?: string;
 }
 /**
  * 通话响铃信令内容
@@ -969,6 +1010,7 @@ interface ISyncCallLogRes extends IBaseSingalCon {
      * 同步数据
      */
     syncTime: number;
+    innerExtra?: string;
 }
 interface ISyncCallLogResList {
     hasMore: 0 | 1;
@@ -1010,7 +1052,7 @@ interface ISignalTransporterListener {
     /**
      * 收到通话状态变更
      */
-    onStatusDown(data: IStatusDownCont, traceId: string, sessionId?: string): void;
+    onStatusDown(data: IStatusDownCont, byServer: boolean, traceId: string): void;
     /**
      * 其他端通话状态变更
      */
@@ -1042,7 +1084,7 @@ interface IGetUserCallStateListRes {
     callStateList: {
         callId: string;
         callType: RCCallPlusType;
-        mediaType: RCCallPlusMediaType;
+        mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO;
         /**
          * 呼叫发起者 ID
          */
@@ -1076,6 +1118,8 @@ interface IGetUserCallStateListRes {
          */
         targetId: string;
         startTime: number;
+        innerExtra?: string;
+        secretChat: SecretCallType;
     }[];
 }
 interface IClearCallLogRes {
@@ -1096,7 +1140,7 @@ interface IGetCallSessionServerRes extends IBaseSingalCon {
     /**
      * 媒体类型
      */
-    mediaType: RCCallPlusMediaType;
+    mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO;
     /**
      * 通话状态
      */
@@ -1125,6 +1169,9 @@ interface IGetCallSessionServerRes extends IBaseSingalCon {
      * 同步时间戳
      */
     syncTime: number;
+    innerExtra?: string;
+    secretChat: SecretCallType;
+    secretChatKey?: string;
 }
 interface IGetCallTimeInfoRes extends IBaseSingalCon {
     /**
@@ -1277,6 +1324,14 @@ interface IRCCallPlusCallRecord {
      * 创建时间
      */
     createTimestamp: number;
+    /**
+     * 同步数据
+     */
+    syncData?: string;
+    /**
+     * 是否为加密通话
+     */
+    isSecret: boolean;
 }
 interface IUserInfo {
     /**
@@ -1300,7 +1355,15 @@ interface IUserInfo {
      */
     orgId?: string;
 }
-interface IStartCallOpts extends ICallId {
+interface IStartCallOpts {
+    /**
+     * 通话唯一 ID
+     */
+    callId?: string;
+    /**
+     * 客户端 callId
+     */
+    clientCallId: string;
     /**
      * 被邀请人信息
      */
@@ -1312,7 +1375,7 @@ interface IStartCallOpts extends ICallId {
     /**
      * 通话媒体类型
      */
-    mediaType: RCCallPlusMediaType;
+    mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO;
     /**
      * 当前用户来源组 ID 类型
      */
@@ -1334,6 +1397,12 @@ interface IStartCallOpts extends ICallId {
      * 附加信息，服务器透传
      */
     extra?: string;
+    /**
+     * 内部透传信息，服务器会记录该数据
+     */
+    innerExtra?: string;
+    secretChat: SecretCallType;
+    secretChatKey?: string;
 }
 interface IStartCallResult {
     /**
@@ -1473,7 +1542,7 @@ interface IGetCallSessionRes extends ICallId {
     /**
      * 媒体类型
      */
-    mediaType: RCCallPlusMediaType;
+    mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO;
     /**
      * 通话状态
      */
@@ -1494,6 +1563,12 @@ interface IGetCallSessionRes extends ICallId {
      * 同步时间戳
      */
     syncTime: number;
+    innerExtra?: string;
+    secretChat: SecretCallType;
+    /**
+     * 通话加密密钥
+     */
+    secretChatKey?: string;
 }
 
 declare enum CallTimerEventType {
@@ -1538,8 +1613,17 @@ declare class RCCallInnerSession extends EventEmitter {
      */
     private _callUsers;
     private readonly _logger;
+    private readonly _isSecret;
     /**
-     * 请求更新的 mediaType
+     * 同步数据
+     */
+    private _syncData;
+    /**
+     * 通话加密密钥
+     */
+    private _secretKey;
+    /**
+     * 暂存请求更新的 mediaType，无请求时为 null
      */
     private _reqMediaType;
     /**
@@ -1580,7 +1664,7 @@ declare class RCCallInnerSession extends EventEmitter {
     /**
      * 通话媒体类型
      */
-    _mediaType: RCCallPlusMediaType, 
+    _mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO, 
     /**
      * session 呼叫发起者
      */
@@ -1592,7 +1676,15 @@ declare class RCCallInnerSession extends EventEmitter {
     /**
      * 当前 session 人员信息列表
      */
-    _callUsers: ISessionUser[], _logger: BasicLogger);
+    _callUsers: ISessionUser[], _logger: BasicLogger, _isSecret: boolean, 
+    /**
+     * 同步数据
+     */
+    _syncData?: string, 
+    /**
+     * 通话加密密钥
+     */
+    _secretKey?: string);
     /**
      * 获取 CallID
      */
@@ -1608,7 +1700,7 @@ declare class RCCallInnerSession extends EventEmitter {
     /**
      * 获取媒体类型
      */
-    getMediaType(): RCCallPlusMediaType;
+    getMediaType(): RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO;
     /**
      * 获取 session 发起者
      */
@@ -1624,7 +1716,7 @@ declare class RCCallInnerSession extends EventEmitter {
     /**
      * 请求更新的 mediaType
      */
-    getReqMediaType(): RCCallPlusMediaType | null;
+    getReqMediaType(): RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO | null;
     /**
      * inviterTimerId
      */
@@ -1654,11 +1746,11 @@ declare class RCCallInnerSession extends EventEmitter {
     /**
      * 更新媒体类型（升降级）
      */
-    updateMediaType(mediaType: RCCallPlusMediaType): void;
+    updateMediaType(mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO): void;
     /**
      * 更新请求的媒体类型（升降级）
      */
-    updateReqMediaType(mediaType: RCCallPlusMediaType | null): void;
+    updateReqMediaType(mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO | null): void;
     /**
      * 更新 invter timer id
      */
@@ -1672,26 +1764,9 @@ declare class RCCallInnerSession extends EventEmitter {
      */
     setIsLocalClientHangup(isLocalClientHangup: boolean): void;
     getIsLocalClientHangup(): boolean;
-}
-
-interface IRCCallInitOptions {
-    /**
-     * RTC 实例
-     */
-    rtcClient: RCRTCClient;
-    /**
-     * RTC 房间加入类型
-     */
-    joinType?: RTCJoinType;
-    /**
-     * 控制台日志输出等级
-     */
-    outputLogLevel?: EnableLogL;
-    /**
-     * 修改默认的 log 输出函数
-     * @deprecated
-     */
-    logStdout?: (logLevel: EnableLogL, content: string) => void;
+    getSyncData(): string | undefined;
+    isSecret(): boolean;
+    getSecretKey(): string;
 }
 
 declare enum CallServerAction {
@@ -1985,8 +2060,6 @@ declare class RCCallPlusReportModule {
 
 declare class SignalTransporter extends EventEmitter {
     private readonly _context;
-    private readonly _runtime;
-    private readonly _initOpts;
     private readonly _timeCorrectioner;
     private readonly _logger;
     private readonly _reportAppEventModule;
@@ -2002,7 +2075,7 @@ declare class SignalTransporter extends EventEmitter {
     /**
      * constructor
      */
-    constructor(_context: PluginContext, _runtime: IRuntime, _initOpts: IRCCallInitOptions, _timeCorrectioner: TimeCorrectioner, _logger: BasicLogger, _reportAppEventModule: RCCallPlusReportModule);
+    constructor(_context: PluginContext, _timeCorrectioner: TimeCorrectioner, _logger: BasicLogger, _reportAppEventModule: RCCallPlusReportModule);
     private _onMessage;
     getSessionId(): string;
     getDeviceId(): string;
@@ -2134,7 +2207,7 @@ declare class SignalTransporter extends EventEmitter {
     /**
      * 补偿数据处理
      */
-    private _onConpensationData;
+    private _onCompensationData;
 }
 
 /**
@@ -2144,9 +2217,8 @@ declare class SignalTransporter extends EventEmitter {
  */
 declare class AbnormalCall {
     private readonly _logger;
-    private _localStore;
     private static _STORAGE_KEY;
-    constructor(runtime: IRuntime, _logger: BasicLogger);
+    constructor(_logger: BasicLogger);
     /**
      * 添加异常 callId
      */
@@ -2163,8 +2235,6 @@ declare class AbnormalCall {
 
 declare class RCCallEngine extends EventEmitter {
     private readonly _context;
-    private readonly _runtime;
-    private readonly _initOpts;
     private readonly _logger;
     private readonly _reportAppEventModule;
     static __INNER_SESSION_CLOSE__: string;
@@ -2209,7 +2279,7 @@ declare class RCCallEngine extends EventEmitter {
     /**
      * 构造器
      */
-    constructor(_context: PluginContext, _runtime: IRuntime, _initOpts: IRCCallInitOptions, _logger: BasicLogger, _reportAppEventModule: RCCallPlusReportModule);
+    constructor(_context: PluginContext, _logger: BasicLogger, _reportAppEventModule: RCCallPlusReportModule);
     /**
      * 发起呼叫
      */
@@ -2491,7 +2561,7 @@ declare class RCCallPlusSession {
     /**
      * 获取通话媒体类型
      */
-    getMediaType(): RCCallPlusMediaType;
+    getMediaType(): RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO;
     /**
      * 获取通话人员列表
      */
@@ -2523,6 +2593,20 @@ declare class RCCallPlusSession {
         code: number;
         duration?: number;
     }>;
+    /**
+     * 获取通话中的缓存数据，数据由通话发起人在发起通话时定义
+     * @returns
+     */
+    getSyncData(): string | undefined;
+    /**
+     * 通话是否已加密
+     * @returns
+     */
+    isSecret(): boolean;
+    /**
+     * 获取通话加密密钥
+     */
+    getSecretKey(): string;
 }
 
 /**
@@ -2660,12 +2744,75 @@ interface IRCCallPlusSummaryMessageContent {
      * 通话挂断原因
      */
     hangupReason: RCCallPlusReason;
+    /**
+     * 是否为加密通话
+     */
+    isSecret: boolean;
+    /**
+     * 通话发起人定义的同步信息
+     */
+    syncData?: string;
+    /**
+     * 是否是本人挂断
+     */
+    isSelfHangup: boolean;
 }
 /**
  * 通话记录的消息结构定义
  */
 interface IRCCallPlusReceivedSummaryMessage extends IReceivedMessage {
 }
+/**
+ * 发起呼叫参数
+ */
+interface IRCCallPlusStartParams {
+    /**
+     * callId，量子生成相同密钥时使用
+     */
+    callId?: string;
+    /**
+     * 被叫方通话用户列表
+     */
+    userIds: string[];
+    /**
+     * 通话类型，默认为 `RCCallPlusType.SINGLE`
+     * * `RCCallPlusType.SINGLE` - 发起单人呼叫
+     * * `RCCallPlusType.MULTI` - 发起多人呼叫
+     */
+    type?: RCCallPlusType;
+    /**
+     * 通话媒体类型，默认为 `RCCallPlusMediaType.AUDIO_VIDEO` 音视频通话
+     * * `RCCallPlusMediaType.AUDIO` - 音频通话
+     * * `RCCallPlusMediaType.AUDIO_VIDEO` - 音视频通话
+     */
+    mediaType: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO;
+    /**
+     * 推送配置，用于定义移动端接收呼叫时的推送行为
+     */
+    pushConfig?: IRCCallPlusPushConfig;
+    /**
+     * 透传信息，该信息将通过 `onReceivedCall` 回调时透传给被叫方
+     */
+    extra?: string;
+    /**
+     * 定义通话同步数据，该数据与 `extra` 不同点，在于数据会被服务器存储，同时可通过 `session.getSyncData()` 获取；
+     * 数据不可超出 1024 Bytes
+     */
+    syncData?: string;
+    /**
+     * 加密配置
+     */
+    encryption?: {
+        /**
+         * 是否加密，默认不加密
+         */
+        isSecret: boolean;
+        /**
+         * 密钥
+         */
+        secretKey: string;
+    };
+}
 /**
  * callPlus 对外事件定义
  */
@@ -2920,6 +3067,15 @@ interface IStatusReportListener {
     onReceivePacketLoss(data: {
         [userId: string]: RCCallPlusPacketLossStats;
     }): void;
+    /**
+     * 上报远端视频信息，每秒回调一次
+     * @param info.width 视频宽度
+     * @param info.height 视频高度
+     */
+    onReceiveRemoteVideoInfo?(info: {
+        width: number;
+        height: number;
+    }): void;
 }
 /**
  * 人员及人员状态
@@ -3171,11 +3327,8 @@ declare class RCCallPlusAndroidPushConfigBuilder {
     setimageUrlHonor(imageUrlHonor: string): this;
     /**
      * 构建 IAndroidPushConfig
-  <<<<<<< HEAD
-  =======
      * @returns IAndroidPushConfig 安卓推送配置数据
      * 返回值需传入 startCall、invite、hangup 方法的 pushConfig.androidConfig 中
-  >>>>>>> develop
      */
     build(): IAndroidPushConfig;
 }
@@ -3183,7 +3336,6 @@ declare class RCCallPlusAndroidPushConfigBuilder {
 declare class RCCallPlusClient {
     private readonly _context;
     private readonly _logger;
-    private readonly _runtime;
     private readonly _initOpts;
     /**
      * 摄像头采集配置
@@ -3215,7 +3367,7 @@ declare class RCCallPlusClient {
      * 上报应用层事件模块
      */
     _reportAppEventModule: RCCallPlusReportModule;
-    constructor(_context: PluginContext, _logger: BasicLogger, _runtime: IRuntime, _initOpts: ICallPlusInitOpts);
+    constructor(_context: PluginContext, _logger: BasicLogger, _initOpts: ICallPlusInitOpts);
     /**
      * 加房间、发布、订阅失败时需结束通话，并上报原因
      */
@@ -3292,9 +3444,12 @@ declare class RCCallPlusClient {
      * 播放某个人的视频前，请确保已经调用 `setVideoView` 方法为其设置视频视图
      * @param userId 指定要查看某个人的媒体资源
      * @param mediaType 指定播放音频还是视频
+     * @param volume 有效值为 0-100
      * @returns 返回是否播放成功
      */
-    playMedia(userId: string, mediaType: RCCallPlusMediaType): Promise<{
+    playMedia(userId: string, mediaType: RCCallPlusMediaType, options?: {
+        volume?: number;
+    }): Promise<{
         code: number;
     }>;
     /**
@@ -3339,14 +3494,23 @@ declare class RCCallPlusClient {
     }>;
     /**
      * 发起呼叫
+     * @deprecated 接口已废弃，请使用 `startCallWithParams` 接口替代
      * @param userIds 被叫人员 userId 列表，单人呼叫仅需在数组中放置对方一人的 userId
-     * @param type 单人呼叫 or 多人呼叫
+     * @param callType 单人呼叫 or 多人呼叫
      * @param mediaType 通话媒体类型: 音频 or 音视频
      * @param pushConfig 移动端推送信息
      * @param extra 附加信息，会透传给被呼叫方
      * @returns callId 呼叫成功后，产生的会话 id
      */
-    startCall(userIds: string[], callType?: RCCallPlusType, mediaType?: RCCallPlusMediaType, pushConfig?: IRCCallPlusPushConfig, extra?: string): Promise<{
+    startCall(userIds: string[], callType?: RCCallPlusType, mediaType?: RCCallPlusMediaType.AUDIO | RCCallPlusMediaType.AUDIO_VIDEO, pushConfig?: IRCCallPlusPushConfig, extra?: string): Promise<{
+        code: number;
+        callId?: string;
+    }>;
+    /**
+     * 发起呼叫
+     * @param params - {@inheritDoc IRCCallPlusStartParams}
+     */
+    startCallWithParams(params: IRCCallPlusStartParams): Promise<{
         code: number;
         callId?: string;
     }>;
@@ -3377,17 +3541,16 @@ declare class RCCallPlusClient {
     accept(callId: string, pushConfig?: IRCCallPlusPushConfig): Promise<{
         code: number;
     }>;
-    private __innerHangup;
+    private _innerHangup;
     /**
      * 挂断通话
-     * @param callId 为可选参数，不传时，挂断正在进行的主 session，传入时可指定挂断主通话或暂未建立连接的通话
-     * @param pushConfig 移动端推送信息
-     * 暂未建立连接的通话：指已在通话中时，收到呼叫但暂未接听的通话
+     * @param callId 可选参数；当存在多个通话时，可通过该参数指定要挂断的通话；不传时 SDK 将挂断当前进行中的通话；
      * @param pushConfig 移动端推送信息
      */
-    hangup(callId?: string, pushConfig?: IRCCallPlusPushConfig): Promise<{
+    hangup(callId?: string, pushConfig?: IRCCallPlusPushConfig, reason?: RCCallPlusReason): Promise<{
         code: number;
     }>;
+    private _hangup;
     /**
      * 通话中发起媒体类型变更请求
      * @param mediaType 媒体类型
@@ -3528,8 +3691,14 @@ declare class RCCallPlusClient {
     switchMicrophone(microphoneId: string): Promise<{
         code: number;
     }>;
+    /**
+     * 客户端生成 callId，量子特定，用于生成同样的密钥
+     * 呼叫时传给服务，通话 callId 为此 callId
+     * @param userId 用户 id
+     */
+    generateCallId(userId: string): string;
 }
 
 declare const installer: IPluginGenerator<RCCallPlusClient, ICallPlusInitOpts>;
 
-export { IAndroidPushConfig, IAudioConfig, IAudioConfigBuilder, ICallOpts, ICallPlusEventListener, ICallPlusInitOpts, IRCCallPlusCallRecord, IRCCallPlusGetCallRecordRes, IRCCallPlusPushConfig, IRCCallPlusReceivedSummaryMessage, IRCCallPlusSummaryMessageContent, IServerPushExt, IStatusReportListener, IVideoConfig, IVideoConfigBuilder, IiOSPushConfig, RCAudioConfigBuilder, RCCallPlusAndroidPushConfigBuilder, RCCallPlusCallState, RCCallPlusCallUser, RCCallPlusClient, RCCallPlusCode, RCCallPlusMediaType, RCCallPlusMediaTypeChangeResult, RCCallPlusPacketLossStats, RCCallPlusReason, RCCallPlusSession, RCCallPlusSessionUserState, RCCallPlusType, RCVideoConfigBuilder, installer };
+export { IAndroidPushConfig, IAudioConfig, IAudioConfigBuilder, ICallOpts, ICallPlusEventListener, ICallPlusInitOpts, IRCCallPlusCallRecord, IRCCallPlusGetCallRecordRes, IRCCallPlusPushConfig, IRCCallPlusReceivedSummaryMessage, IRCCallPlusStartParams, IRCCallPlusSummaryMessageContent, IServerPushExt, IStatusReportListener, IVideoConfig, IVideoConfigBuilder, IiOSPushConfig, RCAudioConfigBuilder, RCCallPlusAndroidPushConfigBuilder, RCCallPlusCallState, RCCallPlusCallUser, RCCallPlusClient, RCCallPlusCode, RCCallPlusMediaType, RCCallPlusMediaTypeChangeResult, RCCallPlusPacketLossStats, RCCallPlusReason, RCCallPlusSession, RCCallPlusSessionUserState, RCCallPlusType, RCVideoConfigBuilder, installer };