@rongcloud/plugin-call 5.0.5-alpha.1 → 5.0.8

package/dist/index.d.ts

@@ -1,13 +1,13 @@
 /*
- * RCCall - v5.0.5-alpha.1
- * CommitId - 92132946bea607c42e2d1fe5fe641bed05997834
- * Mon Dec 06 2021 16:29:43 GMT+0800 (China Standard Time)
+ * RCCall - v5.0.8
+ * CommitId - bc1d39aa3bab4f6c75022fd71d5cca325668e2c1
+ * Tue Jun 21 2022 17:42:09 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { ConversationType, RTCJoinType, LogLevel, PluginContext, IRuntime, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
-import { RCCallStateMachine, RCCallErrorCode, RCCallMediaType, IUserData, RCCallUserState, RCCallSessionState, IEndSummary, IOfflineRecord, RCCallLanguage, RCCallEndReason, IInvitedUsers } from '@rongcloud/plugin-call-engine';
+import { RCCallStateMachine, RCCallErrorCode, IInviteOptions, 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, RCRTCRoom, RCTrack, RCRTCCode, IRCRTCStateReport, RCRTCPingResult, RCLocalTrack, ICameraVideoProfile } from '@rongcloud/plugin-rtc';
+import { RCRTCClient, IMicphoneAudioProfile, RCTrack, RCRTCCode, IRCRTCStateReport, RCRTCPingResult, RCLocalTrack, ICameraVideoProfile } from '@rongcloud/plugin-rtc';
 
 /**
  * 产生session的场景
@@ -115,8 +115,11 @@ declare class RCCallSession {
     /**
      * 群呼叫中继续邀请
      * @param userIds 被邀请用户 ID 列表
+     * @param options.extra 消息的扩展信息
+     * @param options.pushTitle 通知的标题
+     * @param options.pushContent 通知内容
      */
-    invite(userIds: string[]): Promise<{
+    invite(userIds: string[], options?: IInviteOptions): Promise<{
         code: RCCallErrorCode;
     }>;
     /**
@@ -205,7 +208,7 @@ declare class RCCallSession {
     /**
      *  获取房间当前会话 Id，当房间内已无成员时房间会回收，重新加入时 sessionId 将更新，(用户录制资源用的)
      */
-    getRTCSessionId(): string;
+    getRTCSessionId(): string | null;
     /**
      *  目标 ID，单呼对方人员 Id, 群呼群组 Id
      */
@@ -238,10 +241,6 @@ declare class RCCallSession {
      * 获得mediaType
      */
     getMediaType(): RCCallMediaType;
-    /**
-     * 获取 RTC Room 实例
-     */
-    getRTCRoomInstance(): RCRTCRoom | null;
 }
 
 interface ISender {
@@ -284,7 +283,7 @@ interface IRCCallInitOptions {
     /**
      * 收到邀请后，产生新的session
      */
-    onSession: (session: RCCallSession) => void;
+    onSession: (session: RCCallSession, extra?: string) => void;
     /**
      * session已关闭
      */
@@ -382,14 +381,6 @@ interface ISessionListener {
      * @since version 5.1.5
      */
     onICEConnectionStateChange?: (state: RTCIceConnectionState, session: RCCallSession) => void;
-    /**
-     * 接收到房间信令时回调
-     */
-    onMessageReceive?: (name: string, content: any, senderUserId: string, messageUId: string, session: RCCallSession) => void;
-    /**
-     * 监听房间属性变更通知
-     */
-    onRoomAttributeChange?: (name: string, content: string, session: RCCallSession) => void;
 }
 /**
  * 创建session的options
@@ -448,6 +439,18 @@ interface IRCCallParams {
         video?: ICameraVideoProfile;
         audio: IMicphoneAudioProfile;
     };
+    /**
+     * 消息的扩展信息
+     */
+    extra?: string;
+    /**
+    * 对方显示通知的标题
+    */
+    pushTitle?: string;
+    /**
+     * 对方显示的通知内容
+     */
+    pushContent?: string;
 }
 interface IMediaStreamConstraints {
     video?: ICameraVideoProfile;
@@ -464,8 +467,26 @@ interface IRCCallInGroupParams {
      * session上要注册的监听事件
      */
     listener: ISessionListener;
+    /**
+     * 组织 Id，可选
+     */
     channelId?: string;
+    /**
+     * 用于获取己方媒体资源的参数
+     */
     constraints?: IMediaStreamConstraints;
+    /**
+     * 消息的扩展信息
+     */
+    extra?: string;
+    /**
+     * 对方显示通知的标题
+     */
+    pushTitle?: string;
+    /**
+      * 对方显示的通知内容
+      */
+    pushContent?: string;
 }
 interface IDeviceChangeParams {
     audio?: IMicphoneAudioProfile;
@@ -519,8 +540,11 @@ declare class RCCallClient {
      * @param params.listener (session上的监听) 必填
      * @param params.constraints 获取音频或音视频资源时的参数 可选
      * @param params.channelId 组织 Id 可选
+     * @param params.extra 消息扩展信息
+     * @param params.pushTitle 通知的标题
+     * @param params.pushContent 通知的内容
      */
-    call({ targetId, mediaType, listener, constraints, channelId }: IRCCallParams): Promise<{
+    call({ targetId, mediaType, listener, constraints, channelId, extra, pushTitle, pushContent }: IRCCallParams): Promise<{
         code: RCCallErrorCode;
         session?: RCCallSession;
     }>;
@@ -530,10 +554,13 @@ declare class RCCallClient {
      * @param params.userIds 被呼叫的群内成员 Id 必填
      * @param params.mediaType 音频呼叫 or 音视频呼叫 必填
      * @param params.listener (session上的监听) 必填
-     * @param params.channelId 组织 Id 可选
      * @param params.constraints 获取音频或音视频资源时的参数 可选
+     * @param params.channelId 组织 Id 可选
+     * @param params.extra 消息扩展信息 可选
+     * @param params.pushTitle 通知的标题
+     * @param params.pushContent 通知的内容
      */
-    callInGroup({ targetId, userIds, mediaType, listener, constraints, channelId }: IRCCallInGroupParams): Promise<{
+    callInGroup({ targetId, userIds, mediaType, listener, constraints, channelId, extra, pushTitle, pushContent }: IRCCallInGroupParams): Promise<{
         code: RCCallErrorCode;
         session?: RCCallSession;
     }>;
@@ -547,10 +574,9 @@ declare class RCCallClient {
      */
     private _removeSession;
     /**
-     * 获取加入通话（已加入 RTC 房间）的用户信息
-     * @param userId 用户 ID
+     * 获取己方其他端加入通话（已加入 RTC 房间）的用户信息
      */
-    getJoinedUserInfo(userId: string): Promise<{
+    getJoinedRoomInfo(): Promise<{
         code: RCCallErrorCode;
         data?: IRTCJoinedInfo[];
     }>;