fcr-core 3.4.0

package/lib/room-control/stream-control/index.js

@@ -0,0 +1,341 @@
+"use strict";
+
+require("core-js/modules/es.symbol.description.js");
+require("core-js/modules/es.error.cause.js");
+require("core-js/modules/esnext.async-iterator.filter.js");
+require("core-js/modules/esnext.function.metadata.js");
+require("core-js/modules/esnext.iterator.filter.js");
+require("core-js/modules/esnext.symbol.metadata.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrStreamControlImpl = void 0;
+require("core-js/modules/es.array.push.js");
+require("core-js/modules/esnext.async-iterator.for-each.js");
+require("core-js/modules/esnext.async-iterator.map.js");
+require("core-js/modules/esnext.async-iterator.some.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.for-each.js");
+require("core-js/modules/esnext.iterator.map.js");
+require("core-js/modules/esnext.iterator.some.js");
+require("core-js/modules/esnext.map.delete-all.js");
+require("core-js/modules/esnext.map.emplace.js");
+require("core-js/modules/esnext.map.every.js");
+require("core-js/modules/esnext.map.filter.js");
+require("core-js/modules/esnext.map.find.js");
+require("core-js/modules/esnext.map.find-key.js");
+require("core-js/modules/esnext.map.includes.js");
+require("core-js/modules/esnext.map.key-of.js");
+require("core-js/modules/esnext.map.map-keys.js");
+require("core-js/modules/esnext.map.map-values.js");
+require("core-js/modules/esnext.map.merge.js");
+require("core-js/modules/esnext.map.reduce.js");
+require("core-js/modules/esnext.map.some.js");
+require("core-js/modules/esnext.map.update.js");
+require("core-js/modules/web.dom-collections.iterator.js");
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _imports = require("../../imports");
+var _type = require("../../type");
+var _ = require("../..");
+var _user = require("../../utilities/user");
+var _error = require("../../utilities/error");
+var _FcrStreamControlImpl;
+let _initProto;
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _applyDecs(e, t, r, n, o, a) { function i(e, t, r) { return function (n, o) { return r && r(n), e[t].call(n, o); }; } function c(e, t) { for (var r = 0; r < e.length; r++) e[r].call(t); return t; } function s(e, t, r, n) { if ("function" != typeof e && (n || void 0 !== e)) throw new TypeError(t + " must " + (r || "be") + " a function" + (n ? "" : " or undefined")); return e; } function applyDec(e, t, r, n, o, a, c, u, l, f, p, d, h) { function m(e) { if (!h(e)) throw new TypeError("Attempted to access private element on non-instance"); } var y, v = t[0], g = t[3], b = !u; if (!b) { r || Array.isArray(v) || (v = [v]); var w = {}, S = [], A = 3 === o ? "get" : 4 === o || d ? "set" : "value"; f ? (p || d ? w = { get: _setFunctionName(function () { return g(this); }, n, "get"), set: function (e) { t[4](this, e); } } : w[A] = g, p || _setFunctionName(w[A], n, 2 === o ? "" : A)) : p || (w = Object.getOwnPropertyDescriptor(e, n)); } for (var P = e, j = v.length - 1; j >= 0; j -= r ? 2 : 1) { var D = v[j], E = r ? v[j - 1] : void 0, I = {}, O = { kind: ["field", "accessor", "method", "getter", "setter", "class"][o], name: n, metadata: a, addInitializer: function (e, t) { if (e.v) throw Error("attempted to call addInitializer after decoration was finished"); s(t, "An initializer", "be", !0), c.push(t); }.bind(null, I) }; try { if (b) (y = s(D.call(E, P, O), "class decorators", "return")) && (P = y);else { var k, F; O.static = l, O.private = f, f ? 2 === o ? k = function (e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function (e) { return e[n]; }, (o < 2 || 4 === o) && (F = function (e, t) { e[n] = t; })); var N = O.access = { has: f ? h.bind() : function (e) { return n in e; } }; if (k && (N.get = k), F && (N.set = F), P = D.call(E, d ? { get: w.get, set: w.set } : w[A], O), d) { if ("object" == typeof P && P) (y = s(P.get, "accessor.get")) && (w.get = y), (y = s(P.set, "accessor.set")) && (w.set = y), (y = s(P.init, "accessor.init")) && S.push(y);else if (void 0 !== P) throw new TypeError("accessor decorators must return an object with get, set, or init properties or void 0"); } else s(P, (p ? "field" : "method") + " decorators", "return") && (p ? S.push(P) : w[A] = P); } } finally { I.v = !0; } } return (p || d) && u.push(function (e, t) { for (var r = S.length - 1; r >= 0; r--) t = S[r].call(e, t); return t; }), p || b || (f ? d ? u.push(i(w, "get"), i(w, "set")) : u.push(2 === o ? w[A] : i.call.bind(w[A])) : Object.defineProperty(e, n, w)), P; } function u(e, t) { return Object.defineProperty(e, Symbol.metadata || Symbol.for("Symbol.metadata"), { configurable: !0, enumerable: !0, value: t }); } if (arguments.length >= 6) var l = a[Symbol.metadata || Symbol.for("Symbol.metadata")]; var f = Object.create(null == l ? null : l), p = function (e, t, r, n) { var o, a, i = [], s = function (t) { return _checkInRHS(t) === e; }, u = new Map(); function l(e) { e && i.push(c.bind(null, e)); } for (var f = 0; f < t.length; f++) { var p = t[f]; if (Array.isArray(p)) { var d = p[1], h = p[2], m = p.length > 3, y = 16 & d, v = !!(8 & d), g = 0 == (d &= 7), b = h + "/" + v; if (!g && !m) { var w = u.get(b); if (!0 === w || 3 === w && 4 !== d || 4 === w && 3 !== d) throw Error("Attempted to decorate a public method/accessor that has the same name as a previously decorated public method/accessor. This is not currently supported by the decorators plugin. Property name was: " + h); u.set(b, !(d > 2) || d); } applyDec(v ? e : e.prototype, p, y, m ? "#" + h : _toPropertyKey(h), d, n, v ? a = a || [] : o = o || [], i, v, m, g, 1 === d, v && m ? s : r); } } return l(o), l(a), i; }(e, t, o, f); return r.length || u(e, f), { e: p, get c() { var t = []; return r.length && [u(applyDec(e, [r], n, e.name, 5, f, t), f), c.bind(null, t, e)]; } }; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _setFunctionName(e, t, n) { "symbol" == typeof t && (t = (t = t.description) ? "[" + t + "]" : ""); try { Object.defineProperty(e, "name", { configurable: !0, value: n ? n + " " + t : t }); } catch (e) {} return e; }
+function _checkInRHS(e) { if (Object(e) !== e) throw TypeError("right-hand side of 'in' should be an object, got " + (null !== e ? typeof e : "null")); return e; }
+/**
+ * @internal
+ */
+class FcrStreamControlImpl {
+  constructor(_engine, _scene, _api) {
+    //@internal
+    (0, _defineProperty2.default)(this, "logger", (_initProto(this), (0, _imports.getLogger)()));
+    //@internal
+    (0, _defineProperty2.default)(this, "_observable", new _imports.AgoraObservable());
+    //@internal
+    (0, _defineProperty2.default)(this, "_streamMapByStreamId", {});
+    //@internal
+    (0, _defineProperty2.default)(this, "_streamMapByUserId", {});
+    //@internal
+    (0, _defineProperty2.default)(this, "_streamList", []);
+    //@internal
+    (0, _defineProperty2.default)(this, "_remoteStreamRenderMap", new Map());
+    //@internal
+    (0, _defineProperty2.default)(this, "_sceneObserver", {
+      onStreamsAdded: (sceneId, events) => {
+        const fcrStreamEvents = events.map(this._convertStreamEvent);
+        fcrStreamEvents.forEach(event => {
+          const stream = event.modifiedStream;
+          const exists = stream.streamId in this._streamMapByStreamId;
+          if (exists) {
+            this.logger.warn("[FcrStreamControl] stream added when the stream already exists, streamId: ".concat(stream.streamId));
+          } else {
+            this._streamList.push(stream);
+            this._streamMapByStreamId[stream.streamId] = stream;
+            this._putUserStream(stream.owner.userId, stream);
+          }
+        });
+        this._observable.notifyObservers('onStreamsAdded', sceneId, fcrStreamEvents);
+      },
+      onStreamsRemoved: (sceneId, events) => {
+        const fcrStreamEvents = events.map(this._convertStreamEvent);
+        fcrStreamEvents.forEach(event => {
+          const stream = event.modifiedStream;
+          const exists = stream.streamId in this._streamMapByStreamId;
+          if (!exists) {
+            this.logger.warn("[FcrStreamControl] stream removed when the stream does not exist, streamId: ".concat(stream.streamId));
+          } else {
+            const index = this._streamList.findIndex(s => stream.streamId === s.streamId);
+            if (index !== -1) {
+              this._streamList.splice(index, 1);
+            }
+            delete this._streamMapByStreamId[stream.streamId];
+            this._deleteUserStream(stream.owner.userId, stream);
+          }
+        });
+        this._observable.notifyObservers('onStreamsRemoved', sceneId, fcrStreamEvents);
+      },
+      onStreamsUpdated: (sceneId, events) => {
+        const fcrStreamEvents = events.map(this._convertStreamEvent);
+        fcrStreamEvents.forEach(event => {
+          const stream = event.modifiedStream;
+          const exists = stream.streamId in this._streamMapByStreamId;
+          if (!exists) {
+            this.logger.warn("[FcrStreamControl] stream updated when the stream does not exist, streamId: ".concat(stream.streamId));
+          } else {
+            const index = this._streamList.findIndex(s => stream.streamId === s.streamId);
+            if (index !== -1) {
+              this._streamList.splice(index, 1, stream);
+            }
+            this._streamMapByStreamId[stream.streamId] = stream;
+            this._setUserStream(stream.owner.userId, stream);
+          }
+        });
+        this._observable.notifyObservers('onStreamsUpdated', sceneId, fcrStreamEvents);
+      },
+      onLocalVideoStatsUpdated: (sceneId, streamId, stats) => {
+        this._observable.notifyObservers('onLocalVideoStatsUpdated', sceneId, streamId, stats);
+      },
+      onLocalAudioStatsUpdated: (sceneId, streamId, stats) => {
+        this._observable.notifyObservers('onLocalAudioStatsUpdated', sceneId, streamId, stats);
+      },
+      onRemoteVideoStatsUpdated: (sceneId, streamId, stats) => {
+        this._observable.notifyObservers('onRemoteVideoStatsUpdated', sceneId, streamId, stats);
+      },
+      onRemoteAudioStatsUpdated: (sceneId, streamId, stats) => {
+        this._observable.notifyObservers('onRemoteAudioStatsUpdated', sceneId, streamId, stats);
+      },
+      onFirstRemoteVideoFrameRendered: (sceneId, streamId) => {
+        this._observable.notifyObservers('onFirstRemoteVideoFrameRendered', sceneId, streamId);
+      }
+    });
+    //@internal
+    (0, _defineProperty2.default)(this, "_addSceneStreamPlayerObserver", {
+      onRemoteAudioStreamVolumeUpdated: (streamId, volume) => this._observable.notifyObservers('onStreamVolumeIndicationUpdated', this._scene.sceneId, streamId, volume)
+    });
+    (0, _defineProperty2.default)(this, "_convertStreamInfo", info => {
+      return {
+        streamId: info.streamId,
+        streamName: info.streamName,
+        owner: (0, _user.convertRteUserToFcrUser)(info.owner),
+        streamType: info.streamType,
+        videoSourceType: info.videoSourceType,
+        audioSourceType: info.audioSourceType,
+        videoSourceState: info.videoSourceState,
+        audioSourceState: info.audioSourceState,
+        videoSourceId: info.videoSourceId,
+        audioSourceId: info.audioSourceId,
+        connectorType: info.connectorType
+      };
+    });
+    (0, _defineProperty2.default)(this, "_convertStreamEvent", event => {
+      return {
+        modifiedStream: this._convertStreamInfo(event.modifiedStream),
+        operatorUser: event.operatorUser ? (0, _user.convertRteUserToFcrUser)(event.operatorUser) : undefined,
+        cause: event.cause
+      };
+    });
+    (0, _defineProperty2.default)(this, "_putUserStream", (userId, stream) => {
+      if (!this._streamMapByUserId[userId]) {
+        this._streamMapByUserId[userId] = [];
+      }
+      this._streamMapByUserId[userId].push(stream);
+    });
+    (0, _defineProperty2.default)(this, "_setUserStream", (userId, stream) => {
+      const streams = this._streamMapByUserId[userId];
+      if (streams) {
+        const index = streams.findIndex(s => s.streamId === stream.streamId);
+        if (index !== -1) {
+          streams.splice(index, 1, stream);
+        }
+      }
+    });
+    (0, _defineProperty2.default)(this, "_deleteUserStream", (userId, stream) => {
+      const userStreams = this._streamMapByUserId[userId];
+      if (userStreams) {
+        const index = userStreams.findIndex(s => s.streamId === stream.streamId);
+        if (index !== -1) {
+          userStreams.splice(index, 1);
+        }
+        if (userStreams.length === 0) {
+          delete this._streamMapByUserId[userId];
+        }
+      }
+    });
+    this._engine = _engine;
+    this._scene = _scene;
+    this._api = _api;
+    this._scene.addObserver(this._sceneObserver);
+    this._scene.streamPlayer.addObserver(this._addSceneStreamPlayerObserver);
+    const streamList = this._scene.getStreamList();
+    streamList.forEach(stream => {
+      const user = stream.owner;
+      const streamInfo = this._convertStreamInfo(stream);
+      this._streamList.push(streamInfo);
+      this._streamMapByStreamId[stream.streamId] = streamInfo;
+      this._putUserStream(user.userId, streamInfo);
+    });
+  }
+  getStreams() {
+    return this._streamMapByUserId;
+  }
+  getStreamList() {
+    return this._streamList;
+  }
+  getStreamsByUserId(userId) {
+    return this._scene.getStreamsByUserId(userId).map(this._convertStreamInfo);
+  }
+  getStreamByStreamId(streamId) {
+    const streamInfo = this._scene.getStreamByStreamId(streamId);
+    if (streamInfo) {
+      return this._convertStreamInfo(streamInfo);
+    }
+  }
+  addLocalStreams(streams) {
+    return this._scene.localUser.addLocalStreams(streams);
+  }
+  bindLocalStreams(streams) {
+    return this._scene.localUser.bindLocalStreams(streams);
+  }
+  updatePublishPrivilegeOfStreams() {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    if (args.length === 1) {
+      return this._scene.localUser.updatePublishPrivilegeOfStreams(args[0]);
+    } else if (args.length === 2) {
+      const [privilege, scope] = args;
+      const targetRteRoles = scope.targetRoleType.map(role => _type.FcrUserRoleToStringMap[role]);
+      return this._scene.localUser.updatePublishPrivilegeOfStreams(privilege, {
+        targetRoleType: targetRteRoles,
+        targetRoleTypeIsInclude: scope.targetRoleTypeIsInclude
+      });
+    }
+  }
+  removeStreams(streams) {
+    return this._scene.localUser.removeStreams(streams);
+  }
+  setVideoEncoderConfig(streamId, config, streamType) {
+    return this._scene.localUser.setVideoEncoderConfig(config, streamType, streamId);
+  }
+  startRenderRemoteVideoStream(streamId, type, config, element) {
+    this._remoteStreamRenderMap.set(element, streamId);
+    this._scene.streamPlayer.subscribeRemoteVideoStream(streamId, type);
+    this._scene.streamPlayer.startRenderRemoteVideoStream(streamId, type, config.renderMode, config.isMirror, element);
+  }
+  stopRenderRemoteVideoStream(streamId, element) {
+    this._remoteStreamRenderMap.delete(element);
+    this._scene.streamPlayer.stopRenderRemoteVideoStream(streamId, element);
+    const hasRender = Array.from(this._remoteStreamRenderMap.values()).some(id => id === streamId);
+    if (!hasRender) {
+      this._scene.streamPlayer.unsubscribeRemoteVideoStream(streamId);
+    }
+  }
+  startPlayRemoteAudioStream(streamId) {
+    this._scene.streamPlayer.startPlayRemoteAudioStream(streamId);
+  }
+  stopPlayRemoteAudioStream(streamId) {
+    this._scene.streamPlayer.stopPlayRemoteAudioStream(streamId);
+  }
+  takeSnapshot(streamId, filePath) {
+    return this._scene.streamPlayer.takeSnapshot(streamId, filePath);
+  }
+  async addLocalScreenStream(config) {
+    try {
+      const res = await this._api.startShareScreen({
+        roomId: this._scene.sceneId,
+        userId: this._scene.getLocalUser().getLocalUserId(),
+        config: _objectSpread({
+          videoSourceUuid: 'default',
+          videoSourceType: _.FcrVideoSourceType.SCREEN,
+          audioSourceType: _.FcrAudioSourceType.LOOPBACK
+        }, (0, _imports.convertStreamTypeToPublishState)(config.streamType))
+      });
+      const {
+        data: {
+          rtcToken: token,
+          streamUuid: streamId
+        }
+      } = res;
+      this._screenStreamId = streamId;
+      this._scene.localUser.prepareToPublishScreenStream(streamId, token);
+      return streamId;
+    } catch (error) {
+      if (error instanceof _imports.AgoraRestfulClientError) {
+        var _error$serviceCode;
+        this.logger.error("[FcrStreamControl] addLocalScreenStream failed, error: ".concat(error.message));
+        throw (0, _error.generateFcrCoreServerError)((_error$serviceCode = error.serviceCode) !== null && _error$serviceCode !== void 0 ? _error$serviceCode : -1, error.message, error);
+      }
+      throw (0, _error.generateFcrCoreClientError)(_error.FcrErrorModuleCode.MEDIA_CONTROL_SCREEN, _error.FcrErrorCode.UNDEFINED_ERROR, 'addLocalScreenStream failed', error);
+    }
+  }
+  async removeScreenStream() {
+    const res = await this._api.stopShareScreen({
+      roomId: this._scene.sceneId,
+      userId: this._scene.getLocalUser().getLocalUserId()
+    });
+    if (this._screenStreamId) {
+      this._scene.localUser.removePreparePublishScreenStream(this._screenStreamId);
+    }
+    return res;
+  }
+  adjustRemoteAudioStreamVolume(streamId, volume) {
+    this._scene.streamPlayer.adjustRemoteAudioStreamVolume(streamId, volume);
+  }
+  mergeAudioStream(targetUserId) {
+    return this._api.mergeAudioStream(targetUserId, {
+      roomId: this._scene.sceneId
+    });
+  }
+  splitAudioStream(userId) {
+    return this._api.splitAudioStream(userId, {
+      roomId: this._scene.sceneId
+    });
+  }
+
+  // @bound
+  // addAudioRawDataObserver(observer: FcrAudioRawDataOutputObserver) {
+  //   return this._scene.streamPlayer.addAudioRawDataObserver(observer);
+  // }
+
+  // @bound
+  // removeAudioRawDataObserver(observer: FcrAudioRawDataOutputObserver) {
+  //   return this._scene.streamPlayer.removeAudioRawDataObserver(observer);
+  // }
+
+  addObserver(observer) {
+    this._observable.addObserver(observer);
+  }
+  removeObserver(observer) {
+    this._observable.removeObserver(observer);
+  }
+}
+exports.FcrStreamControlImpl = FcrStreamControlImpl;
+_FcrStreamControlImpl = FcrStreamControlImpl;
+[_initProto] = _applyDecs(_FcrStreamControlImpl, [[_imports.bound, 2, "getStreams"], [_imports.bound, 2, "getStreamList"], [_imports.bound, 2, "getStreamsByUserId"], [_imports.bound, 2, "getStreamByStreamId"], [_imports.bound, 2, "addLocalStreams"], [_imports.bound, 2, "bindLocalStreams"], [_imports.bound, 2, "updatePublishPrivilegeOfStreams"], [_imports.bound, 2, "removeStreams"], [_imports.bound, 2, "setVideoEncoderConfig"], [_imports.bound, 2, "startRenderRemoteVideoStream"], [_imports.bound, 2, "stopRenderRemoteVideoStream"], [_imports.bound, 2, "startPlayRemoteAudioStream"], [_imports.bound, 2, "stopPlayRemoteAudioStream"], [_imports.bound, 2, "takeSnapshot"], [_imports.bound, 2, "addLocalScreenStream"], [_imports.bound, 2, "removeScreenStream"], [_imports.bound, 2, "adjustRemoteAudioStreamVolume"], [_imports.bound, 2, "mergeAudioStream"], [_imports.bound, 2, "splitAudioStream"], [_imports.bound, 2, "addObserver"], [_imports.bound, 2, "removeObserver"]], []).e;

package/lib/room-control/stream-control/type.d.ts

@@ -0,0 +1,209 @@
+import { FcrOperateCause, FcrRenderView, FcrStreamInfo, FcrUserInfo, FcrUserRole, FcrVideoEncoderConfig, FcrVideoRenderConfig } from '../../type';
+import { FcrVideoStreamType, FcrStreamPrivilegeOperation, FcrStreamPrivilegeVideoSourceType, FcrStreamPrivilegeAudioSourceType } from '../..';
+import { AgoraRteSnapshotInfo, AgoraRteStreamBindConfig, AgoraRtcLocalVideoStats, AgoraRtcLocalAudioStats, AgoraRtcRemoteVideoStats, AgoraRtcRemoteAudioStats, AgoraRtcDimensions, AgoraRteMediaStreamCreateConfig } from '../../imports';
+export interface FcrStreamControl {
+    /**
+     * Gets the map of list of streams, indexed by user ID.
+     */
+    getStreams(): Readonly<Record<string, FcrStreamInfo[]>>;
+    /**
+     * Gets the list of streams.
+     */
+    getStreamList(): Readonly<FcrStreamInfo[]>;
+    /**
+     * Gets the list of streams by user ID.
+     * @param userId
+     */
+    getStreamsByUserId(userId: string): Readonly<FcrStreamInfo[]>;
+    /**
+     * Gets the stream by stream ID.
+     * @param streamId
+     */
+    getStreamByStreamId(streamId: string): FcrStreamInfo | undefined;
+    /**
+     * Adds multiple local streams.
+     * @param configs
+     */
+    addLocalStreams(configs: FcrLocalStreamCreateConfig[]): Promise<void>;
+    /**
+     * Binds multiple local streams.
+     * @param configs
+     */
+    bindLocalStreams(configs: FcrStreamBindConfig[]): Promise<void>;
+    /**
+     * Updates the publish privilege of streams.
+     * @param privileges
+     */
+    updatePublishPrivilegeOfStreams(privileges: Record<string, FcrUpdateStreamPrivilege>): Promise<void>;
+    /**
+     * Updates the publish privilege of streams.
+     * @param privilege
+     * @param scope
+     */
+    updatePublishPrivilegeOfStreams(privilege: FcrUpdateStreamPrivilege, scope: FcrUpdateStreamPrivilegeScope): Promise<void>;
+    /**
+     * Removes multiple streams by stream ID.
+     * @param streams
+     */
+    removeStreams(streams: string[]): Promise<void>;
+    /** Adjust remote audio stream volume
+     * @param streamId
+     * @param volume
+     */
+    adjustRemoteAudioStreamVolume(streamId: string, volume: number): void;
+    /**
+     * Sets the video encoder configuration for local a stream.
+     * @param streamId
+     * @param config
+     * @param streamType
+     */
+    setVideoEncoderConfig(streamId: string, config: FcrVideoEncoderConfig, streamType: FcrVideoStreamType): void;
+    /**
+     * Starts rendering the remote video stream.
+     * @param streamId
+     * @param type
+     * @param config
+     * @param element
+     */
+    startRenderRemoteVideoStream(streamId: string, type: FcrVideoStreamType, config: FcrVideoRenderConfig, element: FcrRenderView): void;
+    /**
+     * Stops rendering the remote video stream.
+     * @param streamId
+     * @param element
+     */
+    stopRenderRemoteVideoStream(streamId: string, element: FcrRenderView): void;
+    /**
+     * Starts playing the remote audio stream.
+     * @param streamId
+     */
+    startPlayRemoteAudioStream(streamId: string): void;
+    /**
+     * Stops playing the remote audio stream.
+     * @param streamId
+     */
+    stopPlayRemoteAudioStream(streamId: string): void;
+    /**
+     * Takes a snapshot of the remote video stream.
+     * @param streamId
+     * @param filePath
+     */
+    takeSnapshot(streamId: string, filePath: string): Promise<FcrSnapshotInfo>;
+    /**
+     * Merges the specified audio stream into the local audio stream.
+     * @param targetUserId
+     */
+    mergeAudioStream(targetUserId: string): Promise<void>;
+    /**
+     * Splits the specified audio stream from the local audio stream.
+     * @param userId
+     */
+    splitAudioStream(userId: string): Promise<void>;
+    /**
+     * Adds a local screen stream.
+     * @param config
+     */
+    addLocalScreenStream(config: FcrScreenStreamCreateConfig): Promise<string>;
+    /**
+     * Removes the local screen stream.
+     */
+    removeScreenStream(): Promise<void>;
+    /**
+     * Adds an observer.
+     * @param observer
+     */
+    addObserver(observer: FcrStreamObserver): void;
+    /**
+     * Removes an observer.
+     * @param observer
+     */
+    removeObserver(observer: FcrStreamObserver): void;
+}
+export type FcrLocalStreamCreateConfig = AgoraRteMediaStreamCreateConfig;
+export type FcrStreamBindConfig = AgoraRteStreamBindConfig;
+export type FcrScreenStreamCreateConfig = Pick<FcrStreamCreateConfig, 'streamType'> & {
+    audioDeviceName?: string;
+};
+export type FcrUpdateStreamPrivilege = {
+    videoPrivilege: FcrStreamPrivilegeOperation;
+    audioPrivilege: FcrStreamPrivilegeOperation;
+};
+export type FcrUpdateStreamPrivilegeScope = {
+    videoSourceType?: FcrStreamPrivilegeVideoSourceType;
+    audioSourceType?: FcrStreamPrivilegeAudioSourceType;
+    targetRoleType: FcrUserRole[];
+    targetRoleTypeIsInclude: boolean;
+};
+export type FcrStreamEvent = {
+    readonly modifiedStream: FcrStreamInfo;
+    readonly operatorUser?: FcrUserInfo;
+    readonly cause?: FcrOperateCause;
+};
+export type FcrLocalVideoStats = AgoraRtcLocalVideoStats;
+export type FcrLocalAudioStats = AgoraRtcLocalAudioStats;
+export type FcrRemoteVideoStats = AgoraRtcRemoteVideoStats;
+export type FcrRemoteAudioStats = AgoraRtcRemoteAudioStats;
+export type FcrDimensions = AgoraRtcDimensions;
+export type FcrStreamObserver = {
+    /**
+     * Callback to receive the stream added events.
+     * @param roomId
+     * @param events
+     */
+    onStreamsAdded?(roomId: string, events: FcrStreamEvent[]): void;
+    /**
+     * Callback to receive the stream removed events.
+     * @param roomId
+     * @param events
+     */
+    onStreamsRemoved?(roomId: string, events: FcrStreamEvent[]): void;
+    /**
+     * Callback to receive the stream updated events.
+     * @param roomId
+     * @param events
+     */
+    onStreamsUpdated?(roomId: string, events: FcrStreamEvent[]): void;
+    /**
+     * Callback to receive the volume indication change of a remote stream.
+     * @param roomId
+     * @param streamId
+     * @param volume
+     */
+    onStreamVolumeIndicationUpdated?(roomId: string, streamId: string, volume: number): void;
+    /**
+     * Callback to receive the local video stats updated events.
+     * @param roomId
+     * @param streamId
+     * @param stats
+     */
+    onLocalVideoStatsUpdated?(roomId: string, streamId: string, stats: FcrLocalVideoStats): void;
+    /**
+     * Callback to receive the local audio stats updated events.
+     * @param roomId
+     * @param streamId
+     * @param stats
+     */
+    onLocalAudioStatsUpdated?(roomId: string, streamId: string, stats: FcrLocalAudioStats): void;
+    /**
+     * Callback to receive the remote video stats updated events.
+     * @param roomId
+     * @param streamId
+     * @param stats
+     */
+    onRemoteVideoStatsUpdated?(roomId: string, streamId: string, stats: FcrRemoteVideoStats): void;
+    /**
+     * Callback to receive the remote audio stats updated events.
+     * @param roomId
+     * @param streamId
+     * @param stats
+     */
+    onRemoteAudioStatsUpdated?(roomId: string, streamId: string, stats: FcrRemoteAudioStats): void;
+    /**
+     * Callback to receive the first remote video frame rendered events.
+     * @param roomId
+     * @param streamId
+     * @param dimensions
+     */
+    onFirstRemoteVideoFrameRendered?(roomId: string, streamId: string): void;
+};
+export type FcrSnapshotInfo = AgoraRteSnapshotInfo;
+export type FcrStreamCreateConfig = AgoraRteMediaStreamCreateConfig;

package/lib/room-control/stream-control/type.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});