@rongcloud/plugin-call-plus 2.1.0 → 2.1.2-alpha.1

package/README.md

@@ -0,0 +1,3 @@
+# RongClould Call Plus
+
+* [官方开发者文档](https://doc.rongcloud.cn/callplus/Web/2.X/prepare)

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import { RCConnectionStatus, EventEmitter, BasicLogger, RTCJoinType, EnableLogL, PluginContext, IRuntime, IPluginGenerator } from '@rongcloud/engine';
-import { EnableLogL as EnableLogL$1 } from '@rongcloud/imlib-next';
+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';
 export { RCFrameRate as RCCallPlusFrameRate, RCResolution as RCCallPlusResolution } from '@rongcloud/plugin-rtc';
 
@@ -752,6 +751,10 @@ interface IRingingCallCon extends IBaseSingalCon {
  * 通话接听信令内容
  */
 interface IAcceptCallCon extends IBaseSingalCon {
+    /**
+     * 服务端接收的推送扩展
+     */
+    pushExt?: string;
 }
 /**
  * 直接加入通话信令内容
@@ -1379,6 +1382,10 @@ interface IInviteRes extends ICallId {
     busylineUsers?: IBusylineUser[];
 }
 interface IAcceptOpts extends ICallId {
+    /**
+     * 推送扩展
+     */
+    pushConfig?: IRCCallPlusPushConfig;
 }
 interface IHangupForBusyOpts extends ICallId {
     /**
@@ -1904,12 +1911,85 @@ declare class TimeCorrectioner {
     private _loopCorrectClientTime;
 }
 
+declare enum RCCallPlusMediaTypeChangeResult {
+    /**
+     * 请求方取消媒体类型变更
+     */
+    CANCEL_CHANGE_MEDIA_TYPE = 0,
+    /**
+     * 应答方拒绝媒体类型切换
+     */
+    REFUSE_CHANGE_MEDIA_TYPE = 1,
+    /**
+     * 服务仲裁允许媒体类型切换
+     */
+    SERVER_ALLOW_MEDIA_TYPE = 2,
+    /**
+     * 媒体类型切换超时
+     */
+    CHANGE_MEDIA_TYPE_TIMEOUT = 3
+}
+
+declare class RCCallPlusReportModule {
+    private readonly _logger;
+    private _listener;
+    constructor(_logger: BasicLogger);
+    /**
+     * 状态机事件注册
+     */
+    registerEventListener(listener: ICallPlusEventListener): void;
+    /**
+    * 回调应用层事件
+    * @param eventName
+    * @param attrs
+    * @returns
+    */
+    private _callAppListener;
+    onReceivedCall(session: RCCallPlusSession, traceId: string, extra?: string): void;
+    onRemoteUserInvited(inviteeUserList: string[], inviterUserId: string, callId: string): void;
+    onCallConnected(session: RCCallPlusSession): void;
+    onCallTypeChanged(callType: RCCallPlusType, callId: string, traceId: string): void;
+    /**
+     * 增量上报远端人员状态变化
+     */
+    onRemoteUserStateChanged(data: {
+        callId: string;
+        userId: string;
+        userState: RCCallPlusSessionUserState;
+        reason?: RCCallPlusReason;
+    }, traceId: string): void;
+    onCallEnded(session: RCCallPlusSession, reason: RCCallPlusReason, traceId: string): void;
+    onRemoteCameraStateChanged(callId: string, track: RCRemoteTrack): void;
+    onRemoteMicrophoneStateChanged(callId: string, track: RCRemoteTrack): void;
+    onReceivedCallRecord(record: IRCCallPlusCallRecord, traceId: string): void;
+    onReceivedChangeMediaTypeRequest(userId: string, transactionId: string, mediaType: RCCallPlusMediaType, traceId: string): void;
+    onReceivedChangeMediaTypeResult(info: {
+        userId: string;
+        transactionId: string;
+        mediaType: RCCallPlusMediaType;
+        code: RCCallPlusMediaTypeChangeResult;
+    }, traceId: string): void;
+    onReceivedCallStartTime(info: {
+        callId: string;
+        callStartTime: number;
+    }, traceId: string): void;
+    onReceivedCallFirstFrameTime(callId: string, callFirstFrameTime: number, traceId: string): void;
+    onUserMediaAvailable(tracks: RCTrack[], traceId?: string): void;
+    onFetchRemoteMediaError(tracks: ISubscribeAttr[], code: RCRTCCode): void;
+    onUserAudioLevelChanged(audioLevelReportList: {
+        track: RCLocalAudioTrack | RCRemoteAudioTrack;
+        audioLevel: number;
+    }[]): void;
+    onReceivedCallPlusSummaryMessage(message: IRCCallPlusReceivedSummaryMessage): void;
+}
+
 declare class SignalTransporter extends EventEmitter {
     private readonly _context;
     private readonly _runtime;
     private readonly _initOpts;
     private readonly _timeCorrectioner;
     private readonly _logger;
+    private readonly _reportAppEventModule;
     /**
      * 监听对象
      */
@@ -1922,7 +2002,8 @@ declare class SignalTransporter extends EventEmitter {
     /**
      * constructor
      */
-    constructor(_context: PluginContext, _runtime: IRuntime, _initOpts: IRCCallInitOptions, _timeCorrectioner: TimeCorrectioner, _logger: BasicLogger);
+    constructor(_context: PluginContext, _runtime: IRuntime, _initOpts: IRCCallInitOptions, _timeCorrectioner: TimeCorrectioner, _logger: BasicLogger, _reportAppEventModule: RCCallPlusReportModule);
+    private _onMessage;
     getSessionId(): string;
     registerListener(listener: ISignalTransporterListener): void;
     startCall(msg: IStartCallCon, traceId: string): Promise<{
@@ -2088,77 +2169,6 @@ declare class AbnormalCall {
     private _getByIndexDB;
 }
 
-declare enum RCCallPlusMediaTypeChangeResult {
-    /**
-     * 请求方取消媒体类型变更
-     */
-    CANCEL_CHANGE_MEDIA_TYPE = 0,
-    /**
-     * 应答方拒绝媒体类型切换
-     */
-    REFUSE_CHANGE_MEDIA_TYPE = 1,
-    /**
-     * 服务仲裁允许媒体类型切换
-     */
-    SERVER_ALLOW_MEDIA_TYPE = 2,
-    /**
-     * 媒体类型切换超时
-     */
-    CHANGE_MEDIA_TYPE_TIMEOUT = 3
-}
-
-declare class RCCallPlusReportModule {
-    private readonly _logger;
-    private _listener;
-    constructor(_logger: BasicLogger);
-    /**
-     * 状态机事件注册
-     */
-    registerEventListener(listener: ICallPlusEventListener): void;
-    /**
-    * 回调应用层事件
-    * @param eventName
-    * @param attrs
-    * @returns
-    */
-    private _callAppListener;
-    onReceivedCall(session: RCCallPlusSession, traceId: string, extra?: string): void;
-    onRemoteUserInvited(inviteeUserList: string[], inviterUserId: string, callId: string): void;
-    onCallConnected(session: RCCallPlusSession): void;
-    onCallTypeChanged(callType: RCCallPlusType, callId: string, traceId: string): void;
-    /**
-     * 增量上报远端人员状态变化
-     */
-    onRemoteUserStateChanged(data: {
-        callId: string;
-        userId: string;
-        userState: RCCallPlusSessionUserState;
-        reason?: RCCallPlusReason;
-    }, traceId: string): void;
-    onCallEnded(session: RCCallPlusSession, reason: RCCallPlusReason, traceId: string): void;
-    onRemoteCameraStateChanged(callId: string, track: RCRemoteTrack): void;
-    onRemoteMicrophoneStateChanged(callId: string, track: RCRemoteTrack): void;
-    onReceivedCallRecord(record: IRCCallPlusCallRecord, traceId: string): void;
-    onReceivedChangeMediaTypeRequest(userId: string, transactionId: string, mediaType: RCCallPlusMediaType, traceId: string): void;
-    onReceivedChangeMediaTypeResult(info: {
-        userId: string;
-        transactionId: string;
-        mediaType: RCCallPlusMediaType;
-        code: RCCallPlusMediaTypeChangeResult;
-    }, traceId: string): void;
-    onReceivedCallStartTime(info: {
-        callId: string;
-        callStartTime: number;
-    }, traceId: string): void;
-    onReceivedCallFirstFrameTime(callId: string, callFirstFrameTime: number, traceId: string): void;
-    onUserMediaAvailable(tracks: RCTrack[], traceId?: string): void;
-    onFetchRemoteMediaError(tracks: ISubscribeAttr[], code: RCRTCCode): void;
-    onUserAudioLevelChanged(audioLevelReportList: {
-        track: RCLocalAudioTrack | RCRemoteAudioTrack;
-        audioLevel: number;
-    }[]): void;
-}
-
 declare class RCCallEngine extends EventEmitter {
     private readonly _context;
     private readonly _runtime;
@@ -2440,6 +2450,10 @@ declare class RCCallEngine extends EventEmitter {
      * 通话结束
      */
     private _onSessionClose;
+    /**
+     * 上报在线通话结束的 summary 消息
+     */
+    private _reportCallPlusSummaryMessage;
     /**
      * 根据 callId 移除 session
      */
@@ -2614,12 +2628,54 @@ interface ICallPlusInitOpts {
     /**
      * 定义 callplus SDK 内部的日志输出等级，默认值 LogL.WARN
      */
-    logOutputLevel?: EnableLogL$1;
+    logOutputLevel?: EnableLogL;
     /**
      * 是否发布小流
      */
     isPubTiny?: boolean;
 }
+/**
+ * 通话记录的消息 content 字段
+ */
+interface IRCCallPlusSummaryMessageContent {
+    /**
+     * 唯一通话标识
+     */
+    callId: string;
+    /**
+     * 通话发起者 userId
+     */
+    callerUserId: string;
+    /**
+     * 通话对方 targetId
+     */
+    targetId: string;
+    /**
+     * 媒体类型：0 音频、1 音视频
+     */
+    mediaType: RCCallPlusMediaType;
+    /**
+     * 收到首帧时间
+     */
+    firstFrameTime: number;
+    /**
+     * 通话开始时间
+     */
+    callStartTime: number;
+    /**
+     * 通话结束时间
+     */
+    callEndTime: number;
+    /**
+     * 通话挂断原因
+     */
+    hangupReason: RCCallPlusReason;
+}
+/**
+ * 通话记录的消息结构定义
+ */
+interface IRCCallPlusReceivedSummaryMessage extends IReceivedMessage {
+}
 /**
  * callPlus 对外事件定义
  */
@@ -2667,6 +2723,7 @@ interface ICallPlusEventListener {
      * @param userId 状态变更人员 id
      * @param state 人员变更后状态
      * @param reason 变更原因
+     * @param extra 透传远端人员接听、挂断时携带的附加信息
      */
     onRemoteUserStateChanged?(callId: string, userId: string, state: RCCallPlusSessionUserState, reason?: RCCallPlusReason): void;
     /**
@@ -2741,6 +2798,15 @@ interface ICallPlusEventListener {
      * @param audioLevel 音量值（0-100）
      */
     onUserAudioLevelChanged?(userId: string, audioLevel: number): void;
+    /**
+     * 收到通话结束的消息记录，可用于在 IM 聊天界面插入通话结束消息
+     * 仅单聊可收到
+     * 触发时机:
+     * 1.单聊在线通话结束后
+     * 2.离线时收到单聊呼叫，通话结束后，重新连接 IM 在线时
+     * @param message 通话记录的消息体
+     */
+    onReceivedCallPlusSummaryMessage?(message: IRCCallPlusReceivedSummaryMessage): void;
 }
 /**
  * 通话前视频配置
@@ -2927,6 +2993,7 @@ interface IAndroidPushConfig {
      * Large icon 可以出现在大图版和多字版消息中，显示在右边。
      * 国内版仅 MIUI12 以上版本支持，以下版本均不支持；国际版支持。
      * 图片要求：大小 120 * 120px，格式为 png 或者 jpg 格式。
+     * @deprecated 由于小米官方已停止支持该能力，该字段已失效
      */
     miLargeIconUrl?: string;
     /**
@@ -3060,6 +3127,7 @@ declare class RCCallPlusAndroidPushConfigBuilder {
     setChannelIdMi(channelIdMi: string): this;
     /**
      * 设置小米 Large icon 链接
+     * @deprecated 由于小米官方已停止支持该能力，该方法已失效
      */
     setMiLargeIconUrl(miLargeIconUrl: string): this;
     /**
@@ -3113,8 +3181,11 @@ declare class RCCallPlusAndroidPushConfigBuilder {
     setimageUrlHonor(imageUrlHonor: string): this;
     /**
      * 构建 IAndroidPushConfig
+  <<<<<<< HEAD
+  =======
      * @returns IAndroidPushConfig 安卓推送配置数据
      * 返回值需传入 startCall、invite、hangup 方法的 pushConfig.androidConfig 中
+  >>>>>>> develop
      */
     build(): IAndroidPushConfig;
 }
@@ -3304,14 +3375,16 @@ declare class RCCallPlusClient {
     /**
      * 接听通话
      * @param callId 通话 id
+     * @param pushConfig 移动端推送信息
      */
-    accept(callId: string): Promise<{
+    accept(callId: string, pushConfig?: IRCCallPlusPushConfig): Promise<{
         code: number;
     }>;
     private __innerHangup;
     /**
      * 挂断通话
      * @param callId 为可选参数，不传时，挂断正在进行的主 session，传入时可指定挂断主通话或暂未建立连接的通话
+     * @param pushConfig 移动端推送信息
      * 暂未建立连接的通话：指已在通话中时，收到呼叫但暂未接听的通话
      * @param pushConfig 移动端推送信息
      */
@@ -3402,7 +3475,7 @@ declare class RCCallPlusClient {
     /**
      * 切换摄像头
      * 切换成功后 `ICallPlusEventListener` 监听器的 `onUserMediaAvailable` 中会收到新切换的摄像头资源可播放，此时调用 `callPlusClient.playMedia()` 可显示新摄像头的画面
-     * @param cameraId 浏览器中取得的摄像头设备 id，可调 plugin-rtc 的 getCameras 方法取得
+     * @param cameraId 浏览器中取得的摄像头设备 id，可调 getCameras 方法取得
      * @description 通话前和通话中都可调用
      */
     switchCamera(cameraId: string): Promise<{
@@ -3446,8 +3519,18 @@ declare class RCCallPlusClient {
      * 获取麦克风列表
      */
     getMicrophones(): Promise<MediaDeviceInfo[]>;
+    getRTCSessionId(): string | null;
+    /**
+     * 切换麦克风
+     * 切换成功后 `ICallPlusEventListener` 监听器的 `onUserMediaAvailable` 中会收到新切换的麦克风资源可播放，此时调用 `callPlusClient.playMedia()` 可播放新麦克风的声音
+     * @param microphoneId 浏览器中取得的麦克风设备 id，可调 getMicrophones 方法取得
+     * @description 通话前和通话中都可调用
+     */
+    switchMicrophone(microphoneId: string): Promise<{
+        code: number;
+    }>;
 }
 
 declare const installer: IPluginGenerator<RCCallPlusClient, ICallPlusInitOpts>;
 
-export { IAndroidPushConfig, IAudioConfig, IAudioConfigBuilder, ICallOpts, ICallPlusEventListener, ICallPlusInitOpts, IRCCallPlusCallRecord, IRCCallPlusGetCallRecordRes, IRCCallPlusPushConfig, 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, IRCCallPlusSummaryMessageContent, IServerPushExt, IStatusReportListener, IVideoConfig, IVideoConfigBuilder, IiOSPushConfig, RCAudioConfigBuilder, RCCallPlusAndroidPushConfigBuilder, RCCallPlusCallState, RCCallPlusCallUser, RCCallPlusClient, RCCallPlusCode, RCCallPlusMediaType, RCCallPlusMediaTypeChangeResult, RCCallPlusPacketLossStats, RCCallPlusReason, RCCallPlusSession, RCCallPlusSessionUserState, RCCallPlusType, RCVideoConfigBuilder, installer };