@rongcloud/plugin-call 5.0.1-alpha.11 → 5.0.1-alpha.15

package/dist/index.js

@@ -1,7 +1,7 @@
 /*
- * RCCall - v5.0.1-alpha.11
- * CommitId - 65280fa5376a2d76cbf53552f98961770dc98869
- * Fri Sep 10 2021 17:49:04 GMT+0800 (China Standard Time)
+ * RCCall - v5.0.1-alpha.15
+ * CommitId - 822cbe0e445807b91c775e9bc034fba931189ece
+ * Mon Oct 18 2021 08:45:49 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 'use strict';
@@ -39,6 +39,21 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+/**
+ * 产生session的场景
+ */
+var ProduceTypes;
+(function (ProduceTypes) {
+    /**
+     * 主叫
+     */
+    ProduceTypes[ProduceTypes["CALLER"] = 1] = "CALLER";
+    /**
+     * 被叫
+     */
+    ProduceTypes[ProduceTypes["CALLEE"] = 2] = "CALLEE";
+})(ProduceTypes || (ProduceTypes = {}));
+
 class EventEmitter {
     constructor() {
         this.list = {};
@@ -236,6 +251,44 @@ const validateUserIds = (userIds) => {
     }
     return { result: true };
 };
+function isRCFrameRate(val) {
+    const arrs = ['FPS_10', 'FPS_15', 'FPS_24', 'FPS_30'];
+    return arrs.includes(val);
+}
+function isRCResolution(val) {
+    const arrs = ['W176_H132', 'W176_H144', 'W256_H144', 'W320_H180', 'W240_H240', 'W320_H240', 'W480_H360', 'W640_H360', 'W480_H480', 'W640_H480', 'W720_H480', 'W1280_H720', 'W1920_H1080'];
+    return arrs.includes(val);
+}
+const validateMediaStreamConstraints = (constraints) => {
+    if (constraints && constraints.audio && typeof constraints.audio.micphoneId !== 'undefined' && typeof constraints.audio.micphoneId !== 'string') {
+        return { result: false, msg: '\'constraints.audio.micphoneId\' must be of type \'string\'' };
+    }
+    if (constraints && constraints.audio && typeof constraints.audio.sampleRate !== 'undefined' && typeof constraints.audio.sampleRate !== 'number') {
+        return { result: false, msg: '\'constraints.audio.sampleRate\' must be of type \'number\'' };
+    }
+    if (constraints && constraints.video && typeof constraints.video.cameraId !== 'undefined' && typeof constraints.video.cameraId !== 'string') {
+        return { result: false, msg: '\'constraints.video.cameraId\' must be of type \'string\'' };
+    }
+    // if (constraints && constraints.video && typeof constraints.video.faceMode !== 'undefined' && constraints.video.cameraId !== 'user' && constraints.video.faceMode !== 'environment') {
+    //   return { result: false, msg: '\'constraints.video.cameraId\' must be  \'user\' or \'environment\'' }
+    // }
+    if (constraints && constraints.video && typeof constraints.video.frameRate !== 'undefined' && typeof constraints.video.frameRate !== 'string') {
+        return { result: false, msg: '\'constraints.video.frameRate\' must be of type \'string\'' };
+    }
+    if (constraints && constraints.video && typeof constraints.video.frameRate !== 'undefined' && !isRCFrameRate(constraints.video.frameRate)) {
+        return { result: false, msg: '\'frameRate\' value is out of range' };
+    }
+    if (constraints && constraints.video && typeof constraints.video.resolution !== 'undefined' && typeof constraints.video.resolution !== 'string') {
+        return { result: false, msg: '\'constraints.video.frameRate\' must be of type \'string\'' };
+    }
+    if (constraints && constraints.video && typeof constraints.video.resolution !== 'undefined' && !isRCResolution(constraints.video.resolution)) {
+        return { result: false, msg: '\'resolution\' value is out of range' };
+    }
+    if (constraints && constraints.video && (!constraints.video.frameRate || !constraints.video.resolution)) {
+        return { result: false, msg: '\'resolution\' and \'resolution\' is required' };
+    }
+    return { result: true };
+};
 
 class RCCallSession {
     constructor(
@@ -255,7 +308,7 @@ class RCCallSession {
         this._rtcClient = _rtcClient;
         this._options = _options;
         /**
-         * 用户传进来的 对session的监听
+         * 用户传进来的 对session的监听 (要在RCCallClient的_onInvite里判断，要求执行完onSession必须注册session的监听，所以这里是public)
          */
         this._listener = null;
         /**
@@ -502,10 +555,6 @@ class RCCallSession {
      */
     _publish() {
         return __awaiter(this, void 0, void 0, function* () {
-            // 主叫方发起call时，提前获得了本地资源的情况
-            if (!this._options.localTracks) {
-                return;
-            }
             const tracks = this._options.localTracks;
             const { code } = yield this._publishRetry(tracks, this._options.isAllowPublishRetry, this._RETRYCOUNT);
             // 若资源发布失败
@@ -514,8 +563,11 @@ class RCCallSession {
                 logger.info(`[RCCallSession _publist] Resource publishing failed: roomId -> ${this._stateMachine.getCallId()} RCRTCCode -> ${code}`);
                 return;
             }
-            // 向外抛出本地流, 通知业务层trackReady
-            this._notifyTrackReady(tracks);
+            // 如果是主动发起的呼叫，已提前抛出了资源, 被动呼叫，这里才需要抛出
+            if (this._options.produceType === ProduceTypes.CALLEE) {
+                // 向外抛出本地流, 通知业务层trackReady
+                this._notifyTrackReady(tracks);
+            }
         });
     }
     /**
@@ -596,7 +648,7 @@ class RCCallSession {
         return __awaiter(this, void 0, void 0, function* () {
             // 检测是否能够获得本地流
             if (mediaType === pluginCallEngine.RCCallMediaType.AUDIO) {
-                const { code, track } = yield this._rtcClient.createMicrophoneAudioTrack('RongCloudRTC', constraints && Object.assign({}, constraints.audio));
+                const { code, track } = yield this._rtcClient.createMicrophoneAudioTrack('RongCloudRTC', constraints && constraints.audio && Object.assign({}, constraints.audio));
                 if (code !== pluginRtc.RCRTCCode.SUCCESS) {
                     logger.error(`[RCCallSession _getLocalTrackCore] get Audio local tracks failed RCT code -> ${code}`);
                     return { code: pluginCallEngine.RCCallErrorCode.GET_LOCAL_AUDIO_TRACK_ERROR };
@@ -644,87 +696,44 @@ class RCCallSession {
         });
     }
     /**
-     * 通话中更换设备
+     * 通话中更换音频设备
      */
-    changeDevice(constraints) {
+    changeAudioDevice(audioConstraints) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (typeof constraints !== 'object') {
-                logger.error('[RCCallSession changeDevice] constraints Must be an object');
-                return;
-            }
-            if (!constraints.video && !constraints.audio) {
-                logger.error('[RCCallSession changeDevice] constraints Must be video or audio');
-                return;
-            }
-            // 新产生的track
-            let recentTracks = [];
-            const mediaType = this._stateMachine.getMediaType();
-            // 如果当前是音视频通话 并且有视频参数和音频参数
-            if (mediaType === pluginCallEngine.RCCallMediaType.AUDIO_VIDEO && constraints.video && constraints.audio) {
-                const { code, tracks } = yield this._rtcClient.createMicrophoneAndCameraTracks('RongCloudRTC', Object.assign({}, constraints));
-                if (code !== pluginRtc.RCRTCCode.SUCCESS) {
-                    logger.error(`[RCCallSession changeDevice] get local Audo and Video tracks failed RCT code -> ${code}`);
-                    return { code: pluginCallEngine.RCCallErrorCode.GET_LOCAL_AUDIO_AND_VIDEO_TRACK_ERROR };
-                }
-                // 把之前的track销毁
-                this._options.localTracks && this._destroyTracks(this._options.localTracks);
-                recentTracks = tracks;
-                this._options.localTracks = recentTracks;
-                // 如果当前是音视频通话 并且有视频参数
+            // 新设备的track
+            const recentTracks = [];
+            // 整理后的本地track
+            const localTracks = [];
+            const { code, track } = yield this._rtcClient.createMicrophoneAudioTrack('RongCloudRTC', audioConstraints);
+            if (code !== pluginRtc.RCRTCCode.SUCCESS) {
+                logger.error(`[RCCallSession changeDevice] get local Audio tracks failed RCTLib code -> ${code}`);
+                return { code: pluginCallEngine.RCCallErrorCode.GET_LOCAL_AUDIO_TRACK_ERROR };
             }
-            else if (mediaType === pluginCallEngine.RCCallMediaType.AUDIO_VIDEO && constraints.video) {
-                const { code, track } = yield this._rtcClient.createCameraVideoTrack('RongCloudRTC', Object.assign({}, constraints.video));
-                if (code !== pluginRtc.RCRTCCode.SUCCESS) {
-                    logger.error(`[RCCallSession changeDevice] get local video tracks failed RCT code -> ${code}`);
-                    return { code: pluginCallEngine.RCCallErrorCode.GET_LOCAL_VIDEO_TRACK_ERROR };
+            this._options.localTracks && this._options.localTracks.forEach((track) => {
+                if (track.isAudioTrack()) {
+                    // 之前的音频都销毁
+                    track.destroy();
                 }
-                const localTracks = [];
-                this._options.localTracks && this._options.localTracks.forEach((track) => {
-                    if (track.isVideoTrack()) {
-                        // 之前的视频都销毁
-                        track.destroy();
-                    }
-                    else {
-                        // 只留下之前的音频
-                        localTracks.push(track);
-                    }
-                });
-                recentTracks = [track];
-                // 加上本地新产生的视频
-                localTracks.push(track);
-                this._options.localTracks = localTracks;
-                // 如果当前是音视频通话 并且有音频参数 或 音频通话有音频参数
-            }
-            else if (constraints.audio) {
-                const { code, track } = yield this._rtcClient.createMicrophoneAudioTrack('RongCloudRTC', Object.assign({}, constraints.audio));
-                if (code !== pluginRtc.RCRTCCode.SUCCESS) {
-                    logger.error(`[RCCallSession changeDevice] get local Audio tracks failed RCT code -> ${code}`);
-                    return { code: pluginCallEngine.RCCallErrorCode.GET_LOCAL_AUDIO_TRACK_ERROR };
+                else {
+                    // 只把之前的视频留下
+                    localTracks.push(track);
                 }
-                logger.info(`[RCCallSession changeDevice] trackId->${track.getTrackId()} steamId->${track.getStreamId()}`);
-                const localTracks = [];
-                this._options.localTracks && this._options.localTracks.forEach((track) => {
-                    if (track.isAudioTrack()) {
-                        // 之前的音频都销毁
-                        track.destroy();
-                    }
-                    else {
-                        // 只把之前的视频留下
-                        localTracks.push(track);
-                    }
-                });
-                recentTracks = [track];
-                // 加上本地新产生的音频
-                localTracks.push(track);
-                this._options.localTracks = localTracks;
-            }
+            });
+            recentTracks.push(track);
+            // 加上本地新产生的音频
+            localTracks.push(track);
+            this._options.localTracks = localTracks;
             // 通知业务层trackReady
             this._notifyTrackReady(recentTracks);
             // 如果当前已加入房间，发布新流
             if (this._room) {
                 // 发布新流
-                this._publish();
+                const { code } = yield this._room.publish(recentTracks);
+                if (code !== pluginRtc.RCRTCCode.SUCCESS) {
+                    return { code: pluginCallEngine.RCCallErrorCode.AUDIO_PUBLISH_ERROR };
+                }
             }
+            return { code: pluginCallEngine.RCCallErrorCode.SUCCESS };
         });
     }
     /**
@@ -733,6 +742,11 @@ class RCCallSession {
      */
     invite(userIds) {
         return __awaiter(this, void 0, void 0, function* () {
+            const conversationType = this._stateMachine.getConversationType();
+            // 如果当前不是群组通话，直接返回错误码
+            if (conversationType !== engine.ConversationType.GROUP) {
+                return { code: pluginCallEngine.RCCallErrorCode.CONVERSATION_NOT_GROUP_ERROR };
+            }
             const conclusion = validateUserIds(userIds);
             if (!conclusion.result) {
                 throw new Error(`[RCCallSession invite] ${conclusion.msg}`);
@@ -746,10 +760,11 @@ class RCCallSession {
      */
     accept(constraints) {
         return __awaiter(this, void 0, void 0, function* () {
-            /**
-             * todo: 校验一下constraints
-             */
-            // 接听之前，先挂断当前之外的session
+            const conclusion = validateMediaStreamConstraints(constraints);
+            if (!conclusion.result) {
+                throw new Error(`[RCCallSession accept] ${conclusion.msg}`);
+            }
+            // 接听之前，先挂断当前之外的session，现阶段不允许用户先择接听session，事先会在状态机内部挂断，这里抛出去，会清理其它的seesion
             eventEmitter.emit('hungupOtherSession', { session: this });
             const mediaType = this._stateMachine.getMediaType();
             const { code: _code, tracks } = yield this._getLocalTrack(mediaType, constraints);
@@ -802,6 +817,21 @@ class RCCallSession {
         }
         return localVideoTracks;
     }
+    /**
+     * 获得本地音频
+     */
+    _getLocalAudioTracks() {
+        let localAudiotracks = [];
+        if (!this._room) {
+            return localAudiotracks;
+        }
+        if (this._options.localTracks) {
+            localAudiotracks = this._options.localTracks.filter((track) => {
+                return track.isAudioTrack();
+            });
+        }
+        return localAudiotracks;
+    }
     /**
      * 把通话的MediaType升级到音视频
      */
@@ -945,6 +975,30 @@ class RCCallSession {
             return { code: pluginCallEngine.RCCallErrorCode.SUCCESS };
         });
     }
+    /**
+     * 禁用音频track
+     */
+    disableAudioTrack() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const tracks = this._getLocalAudioTracks();
+            // 禁用音频
+            tracks.forEach((track) => {
+                track.mute();
+            });
+        });
+    }
+    /**
+     * 启用音频track
+     */
+    enableAudioTrack() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const tracks = this._getLocalAudioTracks();
+            // 启用音频
+            tracks.forEach((track) => {
+                track.unmute();
+            });
+        });
+    }
     /**
      * 销毁本地流
      */
@@ -1160,7 +1214,7 @@ class RCCallSession {
         return this._stateMachine.getCallId();
     }
     /**
-     *  获取房间当前会话 Id，当房间内已无成员时房间会回收，重新加入时 sessionId 将更新
+     *  获取房间当前会话 Id，当房间内已无成员时房间会回收，重新加入时 sessionId 将更新，(用户录制资源用的)
      */
     getRTCSessionId() {
         return this._room.getSessionId();
@@ -1257,7 +1311,7 @@ class RCCallClient {
             lang: pluginCallEngine.RCCallLanguage.ZH
         }, _options);
         // 初始化callEngine, 并监听onInvite
-        this._callEngine = new pluginCallEngine.RCCallEngine(this._context, logger, {
+        this._callEngine = new pluginCallEngine.RCCallEngine(this._context, _runtime, logger, {
             /**
              * 监听收到invite
              */
@@ -1324,7 +1378,9 @@ class RCCallClient {
              */
             joinType: this._options.joinType,
             // 允许降级获得流，获得音视频不成功 ，降级获得音频, 默认不允许
-            isAllowDemotionGetStream: this._options.isAllowDemotionGetStream
+            isAllowDemotionGetStream: this._options.isAllowDemotionGetStream,
+            // 标明是被叫产生的session
+            produceType: ProduceTypes.CALLEE
         });
         logger.info('[RCCallClient _onInvite] Received invite message, successfully created session');
         /**
@@ -1351,6 +1407,10 @@ class RCCallClient {
             throw new Error('[RCCallSession  _options.onSession] session Must Have Listener');
         }
     }
+    /**
+     * 监听离线消息报告
+     * @param record
+     */
     _onOfflineRecord(record) {
         try {
             // 执行用户API的监听
@@ -1419,7 +1479,9 @@ class RCCallClient {
                      */
                     joinType: this._options.joinType,
                     // 允许降级获得流，获得音视频不成功 ，降级获得音频, 默认不允许
-                    isAllowDemotionGetStream: this._options.isAllowDemotionGetStream
+                    isAllowDemotionGetStream: this._options.isAllowDemotionGetStream,
+                    // 标明是主叫产生的session
+                    produceType: ProduceTypes.CALLER
                 });
                 // session上注册监听事件
                 session.registerSessionListener(listener);
@@ -1488,7 +1550,9 @@ class RCCallClient {
                      */
                     joinType: this._options.joinType,
                     // 允许降级获得流，获得音视频不成功 ，降级获得音频, 默认不允许
-                    isAllowDemotionGetStream: this._options.isAllowDemotionGetStream
+                    isAllowDemotionGetStream: this._options.isAllowDemotionGetStream,
+                    // 标明是主叫产生的session
+                    produceType: ProduceTypes.CALLER
                 });
                 // session上注册监听事件
                 session.registerSessionListener(listener);
@@ -1511,11 +1575,11 @@ class RCCallClient {
     /**
      * 调RTC API 获得本地流
      */
-    __getLocalTrack(mediaType, constraints) {
+    _getLocalTrackCore(mediaType, constraints) {
         return __awaiter(this, void 0, void 0, function* () {
             // 检测是否能够获得本地流
             if (mediaType === pluginCallEngine.RCCallMediaType.AUDIO) {
-                const { code, track } = yield this._rtcClient.createMicrophoneAudioTrack('RongCloudRTC', constraints && Object.assign({}, constraints.audio));
+                const { code, track } = yield this._rtcClient.createMicrophoneAudioTrack('RongCloudRTC', constraints && constraints.audio && Object.assign({}, constraints.audio));
                 if (code !== pluginRtc.RCRTCCode.SUCCESS) {
                     logger.error(`[RCCallClient _getTrack] get Audio local tracks failed RCT code -> ${code}`);
                     return { code: pluginCallEngine.RCCallErrorCode.GET_LOCAL_AUDIO_TRACK_ERROR };
@@ -1538,10 +1602,10 @@ class RCCallClient {
         return __awaiter(this, void 0, void 0, function* () {
             // 如果是允许降级获得流，并且是获得音视频
             if (this._options.isAllowDemotionGetStream && mediaType === pluginCallEngine.RCCallMediaType.AUDIO_VIDEO) {
-                const { code, tracks } = yield this.__getLocalTrack(pluginCallEngine.RCCallMediaType.AUDIO_VIDEO, constraints);
+                const { code, tracks } = yield this._getLocalTrackCore(pluginCallEngine.RCCallMediaType.AUDIO_VIDEO, constraints);
                 // 如果音视频不能获得，就降组获得音频
                 if (code !== pluginCallEngine.RCCallErrorCode.SUCCESS) {
-                    const { code, tracks } = yield this.__getLocalTrack(pluginCallEngine.RCCallMediaType.AUDIO, constraints);
+                    const { code, tracks } = yield this._getLocalTrackCore(pluginCallEngine.RCCallMediaType.AUDIO, constraints);
                     if (code !== pluginCallEngine.RCCallErrorCode.SUCCESS) {
                         return { code };
                     }
@@ -1550,7 +1614,7 @@ class RCCallClient {
                 return { code, tracks: tracks };
             }
             else {
-                const { code: _code, tracks } = yield this.__getLocalTrack(mediaType, constraints);
+                const { code: _code, tracks } = yield this._getLocalTrackCore(mediaType, constraints);
                 if (_code !== pluginCallEngine.RCCallErrorCode.SUCCESS) {
                     return { code: _code };
                 }
@@ -1597,46 +1661,34 @@ const installer = {
         }
         logger.setLogLevel(options.logLevel);
         logger.setLogStdout(options.logStdout);
-        logger.warn(`RCCall Version: ${"5.0.1-alpha.11"}, Commit: ${"65280fa5376a2d76cbf53552f98961770dc98869"}`);
+        logger.warn(`RCCall Version: ${"5.0.1-alpha.15"}, Commit: ${"822cbe0e445807b91c775e9bc034fba931189ece"}`);
         return new RCCallClient(context, runtime, options);
     }
 };
 
 Object.defineProperty(exports, 'RCCallEndReason', {
     enumerable: true,
-    get: function () {
-        return pluginCallEngine.RCCallEndReason;
-    }
+    get: function () { return pluginCallEngine.RCCallEndReason; }
 });
 Object.defineProperty(exports, 'RCCallErrorCode', {
     enumerable: true,
-    get: function () {
-        return pluginCallEngine.RCCallErrorCode;
-    }
+    get: function () { return pluginCallEngine.RCCallErrorCode; }
 });
 Object.defineProperty(exports, 'RCCallLanguage', {
     enumerable: true,
-    get: function () {
-        return pluginCallEngine.RCCallLanguage;
-    }
+    get: function () { return pluginCallEngine.RCCallLanguage; }
 });
 Object.defineProperty(exports, 'RCCallMediaType', {
     enumerable: true,
-    get: function () {
-        return pluginCallEngine.RCCallMediaType;
-    }
+    get: function () { return pluginCallEngine.RCCallMediaType; }
 });
 Object.defineProperty(exports, 'RCCallSessionState', {
     enumerable: true,
-    get: function () {
-        return pluginCallEngine.RCCallSessionState;
-    }
+    get: function () { return pluginCallEngine.RCCallSessionState; }
 });
 Object.defineProperty(exports, 'RCCallUserState', {
     enumerable: true,
-    get: function () {
-        return pluginCallEngine.RCCallUserState;
-    }
+    get: function () { return pluginCallEngine.RCCallUserState; }
 });
 exports.RCCallClient = RCCallClient;
 exports.RCCallSession = RCCallSession;