@rongcloud/plugin-call 5.0.1-alpha.9 → 5.0.4

package/dist/index.d.ts

@@ -1,23 +1,33 @@
 /*
- * RCCall - v5.0.1-alpha.9
- * CommitId - 89e1678351aa8815f7911660cf705f26482f48ff
- * Thu Sep 02 2021 13:55:28 GMT+0800 (China Standard Time)
+ * RCCall - v5.0.4
+ * CommitId - 821c103f7abc8a24e22ce0e488dd5228818f9f13
+ * Fri Nov 26 2021 10:07:33 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { ConversationType, RTCJoinType, LogLevel, PluginContext, IRuntime, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
-import { RCCallStateMachine, RCCallMediaType, RCCallErrorCode, IUserData, RCCallUserState, RCCallSessionState, IEndSummary, RCCallLanguage, RCCallEndReason, IInvitedUsers } from '@rongcloud/plugin-call-engine';
-export { IEndSummary, IInvitedUsers, ISenderInfo, RCCallEndReason, RCCallErrorCode, RCCallLanguage, RCCallMediaType, RCCallSessionState, RCCallUserState } from '@rongcloud/plugin-call-engine';
-import { RCRTCClient, RCTrack, RCRTCCode, IRCRTCStateReport, RCRTCPingResult, RCLocalTrack, ICameraVideoProfile, IMicphoneAudioProfile } from '@rongcloud/plugin-rtc';
+import { RCCallStateMachine, RCCallErrorCode, RCCallMediaType, IUserData, RCCallUserState, RCCallSessionState, IEndSummary, IOfflineRecord, RCCallLanguage, RCCallEndReason, IInvitedUsers } from '@rongcloud/plugin-call-engine';
+export { IEndSummary, IInvitedUsers, IOfflineRecord, ISenderInfo, RCCallEndReason, RCCallErrorCode, RCCallLanguage, RCCallMediaType, RCCallSessionState, RCCallUserState } from '@rongcloud/plugin-call-engine';
+import { RCRTCClient, IMicphoneAudioProfile, RCTrack, RCRTCCode, IRCRTCStateReport, RCRTCPingResult, RCLocalTrack, ICameraVideoProfile } from '@rongcloud/plugin-rtc';
+
+/**
+ * 产生session的场景
+ */
+declare enum ProduceTypes {
+    /**
+     * 主叫
+     */
+    CALLER = 1,
+    /**
+     * 被叫
+     */
+    CALLEE = 2
+}
 
 declare class RCCallSession {
     /**
      * 状态机实例
      */
     private _stateMachine;
-    /**
-     * 默认音视频
-     */
-    private _mediaType;
     /**
      * rtc实例
      */
@@ -31,7 +41,7 @@ declare class RCCallSession {
      */
     private _room;
     /**
-     * 用户传进来的 对session的监听
+     * 用户传进来的 对session的监听 (要在RCCallClient的_onInvite里判断，要求执行完onSession必须注册session的监听，所以这里是public)
      */
     _listener: ISessionListener | null;
     /**
@@ -43,10 +53,6 @@ declare class RCCallSession {
      * 状态机实例
      */
     _stateMachine: RCCallStateMachine, 
-    /**
-     * 默认音视频
-     */
-    _mediaType: RCCallMediaType, 
     /**
      * rtc实例
      */
@@ -87,11 +93,7 @@ declare class RCCallSession {
      */
     private _leaveRoom;
     /**
-     * 退出房间
-     */
-    private __rtcLeaveRoom;
-    /**
-     * 出现异常后要处理的逻辑
+     * 出现异常后要处理的逻辑,
      * @param endReason 原因
      */
     private _exceptionClose;
@@ -102,14 +104,14 @@ declare class RCCallSession {
     /**
      * 调RTC API 获得本地流
      */
-    private __getLocalTrack;
+    private _getLocalTrackCore;
     private _getLocalTrack;
     /**
-     * 通话中更换设备
+     * 通话中更换音频设备
      */
-    changeDevice(constraints: IDeviceChangeParams): Promise<{
+    changeAudioDevice(audioConstraints?: IMicphoneAudioProfile): Promise<{
         code: RCCallErrorCode;
-    } | undefined>;
+    }>;
     /**
      * 群呼叫中继续邀请
      * @param userIds 被邀请用户 ID 列表
@@ -139,11 +141,11 @@ declare class RCCallSession {
     /**
      * 获得本地视频
      */
-    private _getLocalVideoTrack;
+    private _getLocalVideoTracks;
     /**
-     * 获得本地视频
+     * 获得本地音频
      */
-    private _getLocalVideoTracks;
+    private _getLocalAudioTracks;
     /**
      * 把通话的MediaType升级到音视频
      */
@@ -172,6 +174,18 @@ declare class RCCallSession {
     enableVideoTrack(): Promise<{
         code: RCCallErrorCode;
     }>;
+    /**
+     * 禁用音频track
+     */
+    disableAudioTrack(): Promise<void>;
+    /**
+     * 启用音频track
+     */
+    enableAudioTrack(): Promise<void>;
+    /**
+     * 销毁本地流
+     */
+    private _destroyTracks;
     /**
      * 向外抛出本地流
      */
@@ -188,6 +202,10 @@ declare class RCCallSession {
      *  通话唯一标识
      */
     getSessionId(): string;
+    /**
+     *  获取房间当前会话 Id，当房间内已无成员时房间会回收，重新加入时 sessionId 将更新，(用户录制资源用的)
+     */
+    getRTCSessionId(): string;
     /**
      *  目标 ID，单呼对方人员 Id, 群呼群组 Id
      */
@@ -267,6 +285,7 @@ interface IRCCallInitOptions {
      * session已关闭
      */
     onSessionClose: (session: RCCallSession, summary?: IEndSummary) => void;
+    onOfflineRecord?: (record: IOfflineRecord) => void;
     /**
      * 是否允许接听新呼叫，当前正在通话，如果收到新的邀请，是直接挂断，还是允许选择, 默认值false,直接挂断新的session
      *
@@ -388,6 +407,10 @@ interface IRCCallSessionOptions {
      * 允许降级获得流，获得音视频不成功 ，降级获得音频
      */
     isAllowDemotionGetStream?: boolean;
+    /**
+     * 产生session的场景，是主叫产生 或 被叫产生
+     */
+    produceType?: ProduceTypes;
 }
 /**
  * RCCallClient call方法的传参
@@ -416,7 +439,7 @@ interface IRCCallParams {
 }
 interface IMediaStreamConstraints {
     video?: ICameraVideoProfile;
-    audio: IMicphoneAudioProfile;
+    audio?: IMicphoneAudioProfile;
 }
 /**
  * RCCallClient callInGroup方法的传参
@@ -461,6 +484,11 @@ declare class RCCallClient {
      * 监听onInvite
      */
     private _onInvite;
+    /**
+     * 监听离线消息报告
+     * @param record
+     */
+    _onOfflineRecord(record: IOfflineRecord): void;
     /**
      * 注册用户信息。注册后，在发起邀请或挂断等操作时，会将该信息一并发送给对端
      * @param info.name        用户名称
@@ -500,17 +528,16 @@ declare class RCCallClient {
     /**
      * 调RTC API 获得本地流
      */
-    private __getLocalTrack;
+    private _getLocalTrackCore;
     private _getLocalTrack;
     /**
      * 从sessionList删除某个session
      */
     private _removeSession;
     /**
-     * 获取加入通话（已加入 RTC 房间）的用户信息
-     * @param userId 用户 ID
+     * 获取己方其他端加入通话（已加入 RTC 房间）的用户信息
      */
-    getJoinedUserInfo(userId: string): Promise<{
+    getJoinedRoomInfo(): Promise<{
         code: RCCallErrorCode;
         data?: IRTCJoinedInfo[];
     }>;