@rongcloud/plugin-call-plus 2.1.10-alpha.1 → 2.1.10

package/index.d.ts

@@ -1,5 +1,5 @@
 import { RCConnectionStatus, EventEmitter, BasicLogger, PluginContext, IRuntime, EnableLogL, IReceivedMessage, IPluginGenerator } from '@rongcloud/engine';
-import { RCRemoteTrack, RCTrack, ISubscribeAttr, RCRTCCode, RCLocalAudioTrack, RCRemoteAudioTrack, RCRTCClient, RCFrameRate, RCResolution } from '@rongcloud/plugin-rtc';
+import { RCRemoteTrack, RCTrack, ISubscribeAttr, RCRTCCode, RCLocalAudioTrack, RCRemoteAudioTrack, RCRTCClient, RCRTCRoom, RCLocalTrack, IPublishAttrs, IPubSuccessRes, RCFrameRate, RCResolution } from '@rongcloud/plugin-rtc';
 export { RCFrameRate as RCCallPlusFrameRate, RCResolution as RCCallPlusResolution } from '@rongcloud/plugin-rtc';
 
 /**
@@ -1195,14 +1195,6 @@ interface ISessionUser {
      * 成员系统状态
      */
     systemState: RCCallPlusReason;
-    /**
-     * 摄像头是否可用
-     */
-    cameraEnable: boolean;
-    /**
-     * 麦克风是否可用
-     */
-    microphoneEnable: boolean;
     /**
      * 来源组 ID 类型
      */
@@ -1634,7 +1626,6 @@ declare class RCCallInnerSession extends EventEmitter {
      */
     getInviteeTimerId(): number;
     getAllTimerIds(): number[];
-    setUserDeviceEnable(userId: string, mediaType: RCCallPlusMediaType, enable: boolean, traceId: string): void;
     /**
      * 更新人员列表, 并返回更新的人员列表
      * 根据人员状态去添加、删除、更新
@@ -2141,6 +2132,246 @@ declare class AbnormalCall {
     getAbnormalCallIds(userId: string): Promise<string[] | null>;
 }
 
+declare class RTCModule extends EventEmitter {
+    private readonly _context;
+    private readonly _runtime;
+    private readonly _initOpts;
+    private readonly _logger;
+    private readonly _callEngine;
+    private readonly _reportAppEventModule;
+    static __INNER_RTC_PROCESS_FAILED__: string;
+    static __INNER_RTC_PEERCONNECTION_ABNORMAL_CLOSE__: string;
+    static __INNER_ON_SELF_JOINED__: string;
+    static __INNER_ON_OTHER_JOINED__: string;
+    static __INNER_RECEIVE_FIRST_FRAME__: string;
+    static __INNER_ON_KICKOFF__: string;
+    /**
+     * RCRTC 实例
+     */
+    _rtcClient: RCRTCClient;
+    /**
+     * 己方的音视频 tracks
+     */
+    private _localTracks;
+    /**
+     * RCRTCRoom 实例
+     */
+    _room: RCRTCRoom | null;
+    private _callId;
+    private _callMediaType;
+    private _videoConfig;
+    private _audioConfig;
+    private _isPubTiny;
+    private _audioOutputDeviceId;
+    /**
+     * 视频配置是否变更
+     */
+    private _videoConfigIsChange;
+    /**
+     * 音频配置是否变更
+     */
+    private _audioConfigIsChange;
+    /**
+     * 存储设置的人员和视图
+     */
+    private _userViewMap;
+    private _callPlusStatusReportListener;
+    private _remoteAudioEnable;
+    constructor(_context: PluginContext, _runtime: IRuntime, _initOpts: ICallPlusInitOpts, _logger: BasicLogger, _callEngine: RCCallEngine, _reportAppEventModule: RCCallPlusReportModule);
+    setCallPlusStatusReportListener(listener: IStatusReportListener): void;
+    /**
+     * 取摄像头资源
+     * 内存中有时，返回内存中的视轨
+     */
+    getCameraVideoTrack(traceId: string): Promise<{
+        code: number;
+        track?: RCLocalTrack;
+    }>;
+    /**
+     * 取麦克风资源
+     * 内存中有时，返回内存中的音轨
+     */
+    getMicrophoneAudioTrack(traceId: string): Promise<{
+        code: number;
+        track?: RCLocalTrack;
+    }>;
+    /**
+     * 根据通话类型创建音、视频资源
+     * @param mediaType 音频或音视频
+     */
+    createCallMediaTracks(mediaType: RCCallPlusMediaType, traceId: string): Promise<{
+        code: number;
+    }>;
+    setVideoConfig(videoConfig: IVideoConfig): void;
+    setAudioConfig(audioConfig: IAudioConfig): void;
+    setAudioOutputDeviceId(deviceId: string): Promise<{
+        code: number;
+    }>;
+    destroyAllTracks(traceId: string): void;
+    setAllRemoteAudioEnable(enable: boolean, traceId: string): {
+        code: 80001;
+    } | {
+        code: 0;
+    };
+    destroyTrack(track: RCLocalTrack): Promise<void>;
+    /**
+     * session 连接
+     */
+    sessionConnected(callId: string, traceId: string): Promise<void>;
+    sessionClose(callId: string, traceId: string): Promise<void>;
+    /**
+     * 禁用视频 track
+     */
+    disableVideoTrack(): Promise<{
+        code: number | RCRTCCode;
+        track?: RCLocalTrack;
+    }>;
+    /**
+     * 启用视频track
+     * 1. 启用前应用层需先创建视频 track
+     */
+    enableVideoTrack(traceId: string): Promise<{
+        code: number | RCRTCCode;
+    }>;
+    /**
+     * 通话中切换视频设备
+     */
+    changeVideoDevice(traceId: string): Promise<{
+        code: number;
+        track?: RCLocalTrack;
+    }>;
+    /**
+     * 通话中更换音频设备
+     */
+    changeAudioDevice(traceId: string): Promise<{
+        code: number;
+    }>;
+    /**
+     * 禁用音频 track
+     */
+    disableAudioTrack(): Promise<{
+        code: number | RCRTCCode;
+        track?: RCLocalTrack;
+    }>;
+    /**
+     * 媒体类型升、降
+     */
+    changeMediaType(mediaType: RCCallPlusMediaType, traceId: string): Promise<void>;
+    /**
+     * 升级 音频 -> 音视频
+     * 1. 业务层需要先通过 createLocalTracks 创建本地视频 track
+     * 2. SDK 只处理发布视频 track
+     */
+    private _upgradeMediaType;
+    /**
+     * 降级处理
+     */
+    private _downgradeMediaType;
+    /**
+     * 加入 RTC 房间
+     */
+    joinRTCRoom(callId: string, traceId: string): Promise<{
+        code: number;
+        room?: RCRTCRoom;
+        tracks?: RCRemoteTrack[];
+    }>;
+    /**
+     * RTC 订阅
+     */
+    subscribeTracks(tracks: (ISubscribeAttr)[], traceId: string): Promise<{
+        code: number;
+    }>;
+    /**
+     * RTC 取消订阅
+     */
+    unsubscribeTracks(tracks: RCRemoteTrack[], traceId: string): Promise<{
+        code: number;
+    }>;
+    private _releaseStoredData;
+    getRemoteTracks(): {
+        [userId: string]: RCRemoteTrack[];
+    };
+    getRemoteTrack(userId: string, mediaType: RCCallPlusMediaType): RCRemoteTrack | undefined;
+    getRTCSessionId(): string | null;
+    /** ======私有方法============================================================================================= */
+    /**
+     * RTC 事件监听注册
+     */
+    private _regRTCListeners;
+    private _onLocalTrackReady;
+    private _onRemoteTrackReady;
+    private _onKickOff;
+    /**
+     * RTC Peer 异常关闭
+     * 移动端未处理此回调，定义 sysStatus 为 CONNECTION_ERR
+     */
+    private _onRTCPeerConnectionCloseByException;
+    private _onSelfJoined;
+    private _onRemoteTrackPublish;
+    private _onTrackUnpublish;
+    private _onAudioMuteChange;
+    private _onVideoMuteChagne;
+    private _onRTCStateReport;
+    /**
+   * RTC 接收最终失败后需要调用 hangup 挂断的情况
+   */
+    private _onRTCMethodFail;
+    private _onOtherMemJoined;
+    /**
+     * 创建本地音频 track, 创建成功后保存本地并回调通知
+     */
+    private _createAudioTrack;
+    /**
+     * 创建本地视频 track, 创建成功后保存本地并回调通知
+     */
+    private _createVideoTrack;
+    /**
+     * 获得本地缓存视频 track
+     */
+    getLocalVideoTrack(): RCLocalTrack | undefined;
+    /**
+     * 获得本地缓存音频 track
+     */
+    getLocalAudioTrack(): RCLocalTrack | undefined;
+    /**
+     * 发布本地资源的逻辑
+     */
+    publish(tracks: (RCLocalTrack | IPublishAttrs)[], traceId: string): Promise<{
+        code: number;
+    }>;
+    publishVideoTrack(): Promise<IPubSuccessRes>;
+    setVideoView(list: {
+        userId: string;
+        videoElement: HTMLVideoElement;
+        isTiny?: boolean;
+    }[], traceId: string): void;
+    /**
+     * 删除视图时，取消订阅资源
+     */
+    removeVideoView(userIds: string[], traceId: string): void;
+    /**
+     * 获取存储的人员和 video 元素数据
+     */
+    getUserViewMap(): {
+        [userId: string]: {
+            videoView: HTMLVideoElement;
+            isTiny: boolean;
+        };
+    };
+    /**
+     * 播放媒体资源
+     */
+    playMedia(userId: string, mediaType: RCCallPlusMediaType, videoView: HTMLVideoElement, traceId: string): Promise<{
+        code: 80104;
+    } | {
+        code: 80102;
+    } | {
+        code: RCRTCCode.PB_ERROR | RCRTCCode.SIGNAL_DISCONNECTED | RCRTCCode.PARAMS_ERROR | RCRTCCode.REPERT_JOIN_ROOM | RCRTCCode.NOT_IN_ROOM | RCRTCCode.SERVICE_INVALID | RCRTCCode.RTC_TOKEN_INVALID | RCRTCCode.SIGNAL_ERROR | RCRTCCode.CREATE_OFFER_FAILED | RCRTCCode.REQUEST_FAILED | RCRTCCode.MCU_SERVER_NOT_FOUND | RCRTCCode.BROADCAST_SUB_LIST_NOT_EMPTY | RCRTCCode.ROOM_HAS_BEEN_DESTROYED | RCRTCCode.NOT_OPEN_VIDEO_AUDIO_SERVER | RCRTCCode.GET_USER_MEDIA_FAILED | RCRTCCode.GET_DISPLAY_MEDIA_FAILED | RCRTCCode.BROWSER_PERMISSION_DENIED | RCRTCCode.CREATE_CUSTOM_TRACK_FAILED | RCRTCCode.INVALID_TAGS | RCRTCCode.INVALID_USER_ID | RCRTCCode.CREATE_FILE_TRACK_FAILED | RCRTCCode.INVALID_FILE_INSTANCE | RCRTCCode.SET_REMOTE_DESCRIPTION_FAILED | RCRTCCode.BROWSER_NOT_SUPPORT | RCRTCCode.TRACK_NOT_READY | RCRTCCode.VIDEO_TRACK_MISS_MEDIA_ELEMENT | RCRTCCode.TRACK_PLAY_ERROR | RCRTCCode.SIGNAL_AUDIENCE_JOIN_ROOM_FAILED | RCRTCCode.SIGNAL_ROOM_CHANGE_IDENTITY_FAILED | RCRTCCode.PACKAGE_ENVIRONMENT_ERROR | RCRTCCode.PUBLISH_TRACK_LIMIT_EXCEEDED | RCRTCCode.CDN_RESOURCE_IS_EMPTY | RCRTCCode.SIGNAL_JOIN_RTC_ROOM_REFUSED | RCRTCCode.NO_PERMISSION_TO_USE_REQUESTED_DEVICE | RCRTCCode.THE_FUNCTION_IS_DISABLED_IN_PKROOM | RCRTCCode.SOME_TRACKS_PUBLISH_FAILED | RCRTCCode.MAC_IN_ELECTRON_NOT_SUPPORT_SCREEN_SHARE_WITH_AUDIO | RCRTCCode.JWT_TIME_OUT | RCRTCCode.SYSTEM_PERMISSION_DENIED | RCRTCCode.PUBLISH_TRACKS_IS_INVALID | RCRTCCode.TRACK_READYSTATE_IS_ENDED | RCRTCCode.APPLY_3A_NOISE_WORKLET_BEFORE_PUBLISH | RCRTCCode.LOAD_3A_MODULE_FAILED;
+    } | {
+        code: 0;
+    }>;
+}
+
 declare class RCCallEngine extends EventEmitter {
     private readonly _context;
     private readonly _runtime;
@@ -2186,6 +2417,10 @@ declare class RCCallEngine extends EventEmitter {
      * client callId
      */
     private _clientCallId;
+    /**
+     * session 需使用 rtc 模块取设备状态
+     */
+    private _rtcModule;
     /**
      * 构造器
      */
@@ -2311,8 +2546,7 @@ declare class RCCallEngine extends EventEmitter {
      * 通知人员状态
      * CallClient 也需要更新人员状态，定义为公共函数
      */
-    updateUsersState(callId: string, users: ISessionUser[], traceId: string): void;
-    setUserDeviceEnable(userId: string, mediaType: RCCallPlusMediaType, enable: boolean, traceId: string): void;
+    updateUsersState(callId: string, users: ISessionUser[], traceId: string): ISessionUser[];
     /**
      * 获取通话开始时间
      */
@@ -2353,6 +2587,7 @@ declare class RCCallEngine extends EventEmitter {
     endCurrentUserAbnormalCalls(allDevice: boolean): Promise<{
         code: number;
     }>;
+    setRTCModule(rtcModule: RTCModule): void;
     /** ======私有方法============================================================================================= */
     /**
      * IM 状态变更处理
@@ -2438,7 +2673,7 @@ declare class RCCallEngine extends EventEmitter {
      * A2 多端在接听和直接加入 call 时，上报 onPhoneEnd 状态，消除 B 端展示的 onPhone 状态
      */
     private _clearMobileOnPhone;
-    private _onUserStateChange;
+    reportRemoteUserStateChange(callId: string, users: ISessionUser[], traceId: string): void;
     private _onOtherMemberInvite;
     private _onRequestChangeMediaType;
     private _receiveMediaTypeChangeResult;
@@ -2452,10 +2687,12 @@ declare class RCCallPlusSession {
     private readonly _session;
     private readonly _callEngine;
     private readonly _logger;
+    private readonly _rtcModule;
+    private readonly _context;
     private _startTime;
     private _duration;
     private _callId;
-    constructor(_session: RCCallInnerSession, _callEngine: RCCallEngine, _logger: BasicLogger);
+    constructor(_session: RCCallInnerSession, _callEngine: RCCallEngine, _logger: BasicLogger, _rtcModule: RTCModule, _context: PluginContext);
     /**
      * 获取 CallId
      */
@@ -3224,10 +3461,6 @@ declare class RCCallPlusClient {
      * 被踢出房间时，需结束通话
      */
     private _kickoffHandle;
-    /**
-     * 远端资源音视频状态变化，需更新 session 中人员的设备状态
-     */
-    private _receiveDeviceEnableChangeHandle;
     /**
      * 通话挂断时，需清空内存，离开房间
      */