fcr-core 3.7.8 → 3.8.0-alpha

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

@@ -0,0 +1,353 @@
+"use strict";
+
+require("core-js/modules/es.symbol.description.js");
+require("core-js/modules/es.error.cause.js");
+require("core-js/modules/esnext.function.metadata.js");
+require("core-js/modules/esnext.iterator.for-each.js");
+require("core-js/modules/esnext.symbol.metadata.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrSttControlImpl = void 0;
+require("core-js/modules/es.array.push.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.filter.js");
+require("core-js/modules/esnext.iterator.map.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 _logger = require("../../utilities/logger");
+var _schema = require("../../schema");
+var _type = require("./type");
+var _error = require("../../utilities/error");
+var _type2 = require("../../type");
+var _validateParams = _interopRequireDefault(require("../../utilities/validate-params"));
+var _user = require("../../utilities/user");
+var _type3 = require("../type");
+var _FcrSttControlImpl;
+let _initProto, _startCaptionDecs, _startTranscribingDecs, _updateSourceLanguageDecs, _subscribeTranscribingLanguageDecs, _ref;
+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
+ */
+_ref = (_startCaptionDecs = [_imports.trace, (0, _validateParams.default)(_schema.fcrLanguageConfigSchema)], _startTranscribingDecs = [_imports.trace, (0, _validateParams.default)(_schema.fcrLanguageConfigSchema)], _updateSourceLanguageDecs = [_imports.trace, (0, _validateParams.default)(_schema.fcrLanguageSchema)], _subscribeTranscribingLanguageDecs = [_imports.trace, (0, _validateParams.default)(_schema.fcrLanguageSchema)], "logger");
+class FcrSttControlImpl {
+  constructor(_scene, _api, _sharedCache) {
+    //@internal
+    (0, _defineProperty2.default)(this, _ref, (_initProto(this), (0, _logger.createLogger)({
+      prefix: 'FcrUserControlImpl'
+    })));
+    //@internal
+    (0, _defineProperty2.default)(this, "_observable", new _imports.AgoraObservable());
+    (0, _defineProperty2.default)(this, "_cacheMaxLimit", 10);
+    (0, _defineProperty2.default)(this, "_sttEventWrapperListMap", new Map());
+    //@internal
+    (0, _defineProperty2.default)(this, "_sceneObserver", {
+      onStreamMessageReceived: async (sceneId, data) => {
+        const sttUids = this._scene.getScenePropertiesByKeyPath('widgets.stt.extra.pubBotUids');
+        const isSttBot = sttUids.includes(Number(data.streamId));
+        if (!isSttBot) {
+          return;
+        }
+        const sttreamMessagetData = await (0, _imports.deCompressGzipToJson)(data.payload);
+        const sttEvent = this._parseSTT(sttreamMessagetData);
+        if (sttEvent) {
+          this._observable.notifyObservers('onSttEventReceived', sceneId, sttEvent);
+        }
+      },
+      onUserPropertiesUpdated: (sceneId, event) => {
+        if (event.cause && event.cause.data) {
+          const causeData = event.cause.data;
+          if (causeData.widgetUuid == _type3.FcrWidgetUuid.STT && causeData.widgetCause && causeData.widgetCause.cmd == 3450) {
+            const localUserId = this._scene.localUser.getLocalUserId();
+            if (event.operatorUser.userId !== localUserId) {
+              return;
+            }
+            const operatorUser = (0, _user.convertRteUserToFcrUser)(event.operatorUser, this._roomCache);
+            if (causeData.widgetCause.reason === 0) {
+              const isTranscribingStopped = this._getTranscribingState() === _type.FcrTranscribingState.STOPPED;
+              if (isTranscribingStopped) {
+                this._sttEventWrapperListMap.clear();
+              }
+              this._observable.notifyObservers('onLocalCaptionStateUpdated', sceneId, _type.FcrCaptionState.STOPPED, operatorUser);
+            }
+            if (causeData.widgetCause.reason === 1) {
+              this._observable.notifyObservers('onLocalCaptionStateUpdated', sceneId, _type.FcrCaptionState.STARTED, operatorUser);
+            }
+          }
+        }
+      },
+      onScenePropertiesUpdated: (sceneId, event) => {
+        if (event.cause && event.cause.data) {
+          const causeData = event.cause.data;
+          if (!causeData.widgetCause) {
+            return;
+          }
+          if (causeData.widgetUuid == _type3.FcrWidgetUuid.TRANSCRIBE && causeData.widgetCause.cmd == _type3.FcrWidgetCauseCmd.TRANSCRIBE) {
+            const operatorUser = (0, _user.convertRteUserToFcrUser)(event.operatorUser, this._roomCache);
+            if (causeData.widgetCause.reason === 0) {
+              const isCaptionStopped = this._getLocalCaptionState() === _type.FcrCaptionState.STOPPED;
+              if (isCaptionStopped) {
+                this._sttEventWrapperListMap.clear();
+              }
+              this._observable.notifyObservers('onTranscribingStateUpdated', sceneId, _type.FcrTranscribingState.STOPPED, operatorUser);
+            }
+            if (causeData.widgetCause.reason === 1) {
+              this._observable.notifyObservers('onTranscribingStateUpdated', sceneId, _type.FcrTranscribingState.STARTED, operatorUser);
+            }
+          }
+          if (causeData.widgetUuid == _type3.FcrWidgetUuid.STT && causeData.widgetCause.cmd == _type3.FcrWidgetCauseCmd.STT) {
+            let operatorUser;
+            if (event.operatorUser) {
+              operatorUser = (0, _user.convertRteUserToFcrUser)(event.operatorUser, this._roomCache);
+            }
+            if (causeData.widgetCause.reason === 2) {
+              this._observable.notifyObservers('onSourceLanguageUpdated', sceneId, operatorUser);
+            }
+          }
+        }
+      }
+    });
+    this._scene = _scene;
+    this._api = _api;
+    this._sharedCache = _sharedCache;
+    this._roomCache = _sharedCache.getRoomCache(this._scene.sceneId);
+    this._scene.addObserver(this._sceneObserver);
+    this._addLogObserver();
+  }
+  startCaption(config) {
+    return (0, _error.handleRequestError)(() => this._api.startCaption({
+      roomUuid: this._scene.sceneId,
+      userUuid: this._scene.localUser.getLocalUserId(),
+      config
+    }), _error.FcrErrorModuleCode.ROOM_STT, 'start caption failed');
+  }
+  stopCaption() {
+    return (0, _error.handleRequestError)(() => this._api.stopCaption({
+      roomUuid: this._scene.sceneId,
+      userUuid: this._scene.localUser.getLocalUserId()
+    }), _error.FcrErrorModuleCode.ROOM_STT, 'stop caption failed');
+  }
+  startTranscribing(config) {
+    return (0, _error.handleRequestError)(() => this._api.startTranscribing({
+      roomUuid: this._scene.sceneId,
+      userUuid: this._scene.localUser.getLocalUserId(),
+      config
+    }), _error.FcrErrorModuleCode.ROOM_STT, 'start transcribing failed');
+  }
+  stopTranscribing() {
+    return (0, _error.handleRequestError)(() => this._api.stopTranscribing({
+      roomUuid: this._scene.sceneId,
+      userUuid: this._scene.localUser.getLocalUserId()
+    }), _error.FcrErrorModuleCode.ROOM_STT, 'stop transcribing failed');
+  }
+  updateSourceLanguage(language) {
+    return (0, _error.handleRequestError)(() => this._api.updateSourceLanguage({
+      roomUuid: this._scene.sceneId,
+      userUuid: this._scene.localUser.getLocalUserId(),
+      language
+    }), _error.FcrErrorModuleCode.ROOM_STT, 'update source language failed');
+  }
+  subscribeTranscribingLanguage(language) {
+    return (0, _error.handleRequestError)(() => this._api.subscribeTranscribingLanguage({
+      roomUuid: this._scene.sceneId,
+      userUuid: this._scene.localUser.getLocalUserId(),
+      language
+    }), _error.FcrErrorModuleCode.ROOM_STT, 'subscribe transcribing language failed');
+  }
+  unsubscribeTranscribingLanguage() {
+    return (0, _error.handleRequestError)(() => this._api.unsubscribeTranscribingLanguage({
+      roomUuid: this._scene.sceneId,
+      userUuid: this._scene.localUser.getLocalUserId()
+    }), _error.FcrErrorModuleCode.ROOM_STT, 'unsubscribe transcribing language failed');
+  }
+  getLocalCaptionState() {
+    return this._getLocalCaptionState();
+  }
+  getTranscribingState() {
+    return this._getTranscribingState();
+  }
+  getSourceLanguage() {
+    const transcribingState = this._getTranscribingState();
+    if (transcribingState === _type.FcrTranscribingState.STOPPED) {
+      return null;
+    }
+    return this._scene.getScenePropertiesByKeyPath('widgets.stt.extra.speechLanguage');
+  }
+  getConfig() {
+    const sourceLanguages = this._scene.getScenePropertiesByKeyPath('widgets.stt.extra.sourceLanguages');
+    const translateLanguages = this._scene.getScenePropertiesByKeyPath('widgets.stt.extra.translateLanguages');
+    const cacheMaxLimit = this._scene.getScenePropertiesByKeyPath('widgets.stt.extra.maxLimit');
+    if (!sourceLanguages || !translateLanguages || !cacheMaxLimit) {
+      return null;
+    }
+    return {
+      sourceLanguages,
+      translateLanguages,
+      cacheMaxLimit
+    };
+  }
+  addObserver(observer) {
+    this._observable.addObserver(observer);
+  }
+  removeObserver(observer) {
+    this._observable.removeObserver(observer);
+  }
+  release() {
+    this._sttEventWrapperListMap.clear();
+    this._scene.removeObserver(this._sceneObserver);
+  }
+  _getLocalCaptionState() {
+    const captionState = this._scene.getUserPropertiesByKeyPath('widgets.stt.caption', this._scene.localUser.getLocalUserId());
+    return captionState;
+  }
+  _getTranscribingState() {
+    return this._scene.getScenePropertiesByKeyPath('widgets.transcribe.state');
+  }
+  _parseSTT(sttreamMessagetData) {
+    var _this$_scene$getStrea;
+    const codeMap = {
+      'zh-CN': _type2.FcrLanguage.ZH,
+      'en-US': _type2.FcrLanguage.EN,
+      'ja-JP': _type2.FcrLanguage.JP,
+      'de-DE': _type2.FcrLanguage.DE,
+      'fr-FR': _type2.FcrLanguage.FR,
+      'pt-PT': _type2.FcrLanguage.PT,
+      'es-ES': _type2.FcrLanguage.ES
+    };
+    const transcript = sttreamMessagetData.transcript;
+    const translation = sttreamMessagetData.translation;
+    const messageItem = transcript || translation;
+    const uid = messageItem === null || messageItem === void 0 ? void 0 : messageItem.uid;
+    if (!uid) {
+      this.logger.error('parseSTT failed, uid is null');
+      return null;
+    }
+    const owner = (_this$_scene$getStrea = this._scene.getStreamByStreamId(uid.toString())) === null || _this$_scene$getStrea === void 0 ? void 0 : _this$_scene$getStrea.owner;
+    if (!owner) {
+      this.logger.error('parseSTT failed, owner is null');
+      return null;
+    }
+    const userId = owner.userId;
+    if (!userId) {
+      this.logger.error('parseSTT failed, userId is null');
+      return null;
+    }
+    let sttEventWrapperList = this._sttEventWrapperListMap.get(userId);
+    let sttEventWrapper = null;
+    if (transcript) {
+      const sentenceId = transcript.uid + '-' + transcript.textTs;
+      const formatTranscript = {
+        id: sentenceId,
+        text: transcript.text,
+        language: codeMap[transcript.language],
+        owner: (0, _user.convertRteUserToFcrUser)(owner, this._roomCache),
+        timestamp: transcript.textTs,
+        isFinal: transcript.isFinal
+      };
+      if (!sttEventWrapperList || sttEventWrapperList.length === 0) {
+        sttEventWrapper = {
+          startTs: 0,
+          endTs: transcript.textTs,
+          event: {
+            transcript: formatTranscript,
+            translations: new Map()
+          }
+        };
+        sttEventWrapperList = [sttEventWrapper];
+      } else {
+        const lastSttEventWrapper = sttEventWrapperList[sttEventWrapperList.length - 1];
+        // add
+        if (lastSttEventWrapper.event.transcript.isFinal == true) {
+          sttEventWrapper = {
+            startTs: lastSttEventWrapper.endTs,
+            endTs: transcript.textTs,
+            event: {
+              transcript: formatTranscript,
+              translations: new Map()
+            }
+          };
+          sttEventWrapperList.push(sttEventWrapper);
+          // 超过 10 条，移除 oldest
+          if (sttEventWrapperList.length > this._cacheMaxLimit) {
+            // remove oldest
+            sttEventWrapperList.shift();
+          }
+        } else {
+          if (transcript.textTs >= lastSttEventWrapper.endTs) {
+            // update
+            sttEventWrapperList[sttEventWrapperList.length - 1] = {
+              startTs: lastSttEventWrapper.endTs,
+              endTs: transcript.textTs,
+              event: (0, _imports.merge)(lastSttEventWrapper.event, {
+                transcript: _objectSpread(_objectSpread({}, formatTranscript), {}, {
+                  id: lastSttEventWrapper.event.transcript.id
+                })
+              })
+            };
+          }
+        }
+      }
+    }
+    if (translation) {
+      var _sttEventWrapperList;
+      // 获取缓存句子
+      sttEventWrapperList = (_sttEventWrapperList = sttEventWrapperList) === null || _sttEventWrapperList === void 0 ? void 0 : _sttEventWrapperList.map(wrapper => {
+        const formatTranslation = {
+          id: wrapper.event.transcript.id,
+          language: codeMap[translation.results0.language],
+          text: translation.results0.texts.join(''),
+          timestamp: translation.textTs,
+          isFinal: translation.isFinal,
+          owner: (0, _user.convertRteUserToFcrUser)(owner, this._roomCache)
+        };
+        if (translation.textTs > wrapper.startTs && translation.textTs <= wrapper.endTs) {
+          const transInfo = wrapper.event.translations.get(translation.results0.language);
+          if (!transInfo) {
+            wrapper.event.translations.set(formatTranslation.language, formatTranslation);
+          } else if (translation.textTs >= transInfo.timestamp) {
+            wrapper.event.translations.set(formatTranslation.language, _objectSpread(_objectSpread({}, formatTranslation), {}, {
+              id: wrapper.event.transcript.id
+            }));
+          } else if (transInfo.isFinal == true && wrapper.event.transcript.isFinal == true) {
+            return null;
+          }
+        }
+        return wrapper;
+      }).filter(wrapper => wrapper !== null);
+    }
+    if (sttEventWrapperList) {
+      this._sttEventWrapperListMap.set(userId, sttEventWrapperList);
+      const lastSttEventWrapper = sttEventWrapperList[sttEventWrapperList.length - 1];
+      return lastSttEventWrapper.event;
+    }
+    return null;
+  }
+  _addLogObserver() {
+    this.addObserver((0, _logger.generateLogObserver)(this.logger, ['onSttEventReceived', 'onLocalCaptionStateUpdated', 'onTranscribingStateUpdated', 'onSourceLanguageUpdated']));
+  }
+}
+exports.FcrSttControlImpl = FcrSttControlImpl;
+_FcrSttControlImpl = FcrSttControlImpl;
+[_initProto] = _applyDecs(_FcrSttControlImpl, [[_startCaptionDecs, 2, "startCaption"], [_imports.trace, 2, "stopCaption"], [_startTranscribingDecs, 2, "startTranscribing"], [_imports.trace, 2, "stopTranscribing"], [_updateSourceLanguageDecs, 2, "updateSourceLanguage"], [_subscribeTranscribingLanguageDecs, 2, "subscribeTranscribingLanguage"], [_imports.trace, 2, "unsubscribeTranscribingLanguage"], [_imports.trace, 2, "release"]], []).e;

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

@@ -0,0 +1,142 @@
+import { FcrLanguage, FcrUserInfo } from '../../type';
+export interface FcrSttControl {
+    /**
+     * Adds the observer.
+     * @param observer
+     */
+    addObserver(observer: FcrSttObserver): void;
+    /**
+     * Removes the observer.
+     * @param observer
+     */
+    removeObserver(observer: FcrSttObserver): void;
+    /**
+     * Starts the caption.
+     */
+    startCaption(config: FcrLanguageConfig): Promise<void>;
+    /**
+     * Stops the caption.
+     */
+    stopCaption(): Promise<void>;
+    /**
+     * Starts the transcribing.
+     */
+    startTranscribing(config: FcrLanguageConfig): Promise<void>;
+    /**
+     * Stops the transcribing.
+     */
+    stopTranscribing(): Promise<void>;
+    /**
+     * Updates the source language.
+     */
+    updateSourceLanguage(language: FcrLanguage): Promise<void>;
+    /**
+     * Subscribes the transcribing language.
+     */
+    subscribeTranscribingLanguage(language: FcrLanguage): Promise<void>;
+    /**
+     * Unsubscribes the transcribing language.
+     */
+    unsubscribeTranscribingLanguage(): Promise<void>;
+    /**
+     * Gets the source language.
+     */
+    getSourceLanguage(): FcrLanguage | null;
+    /**
+     * Gets the transcribing language.
+     */
+    getLocalCaptionState(): FcrCaptionState;
+    /**
+     * Gets the transcribing language.
+     */
+    getTranscribingState(): FcrTranscribingState;
+    /**
+     * Gets the transcribing language.
+     */
+    getConfig(): FcrSttConfig | null;
+}
+export interface FcrSttObserver {
+    /**
+     * Callback to receive the stt event.
+     * @param roomId
+     * @param event
+     */
+    onSttEventReceived?: (roomId: string, event: FcrSttEvent) => void;
+    /**
+     * Callback to receive the stt state changed.
+     * @param roomId
+     * @param state
+     */
+    onLocalCaptionStateUpdated?: (roomId: string, state: FcrCaptionState, operatorUser?: FcrUserInfo) => void;
+    /**
+     * Callback to receive the transcribing state changed.
+     * @param roomId
+     * @param state
+     */
+    onTranscribingStateUpdated?: (roomId: string, state: FcrTranscribingState, operatorUser?: FcrUserInfo) => void;
+    /**
+     * Callback to receive the source language changed.
+     * @param roomId
+     * @param operatorUser
+     */
+    onSourceLanguageUpdated?: (roomId: string, operatorUser?: FcrUserInfo | null) => void;
+}
+export interface FcrLanguageConfig {
+    sourceLanguage: FcrLanguage;
+    targetLanguage?: FcrLanguage;
+}
+export declare enum FcrCaptionState {
+    STOPPED = 0,
+    STARTED = 1
+}
+export declare enum FcrTranscribingState {
+    STOPPED = 0,
+    STARTED = 1
+}
+export interface FcrCaptionConfig {
+    selectedSourceLanguage: FcrLanguage;
+    sourceLanguages: Array<FcrLanguage>;
+    translateLanguages?: Array<FcrLanguage>;
+}
+export interface FcrSttConfig {
+    sourceLanguages: Array<FcrLanguage>;
+    translateLanguages: Array<FcrLanguage>;
+    cacheMaxLimit: number;
+}
+export interface FcrSttEvent {
+    transcript: FcrSttInfo;
+    translations: Map<FcrLanguage, FcrSttInfo>;
+}
+export interface FcrSttEventWrapper {
+    startTs: number;
+    endTs: number;
+    event: FcrSttEvent;
+}
+export interface FcrSttInfo {
+    id: string;
+    text: string;
+    language: FcrLanguage;
+    owner: FcrUserInfo;
+    timestamp: number;
+    isFinal: boolean;
+}
+export interface FcrSttTranslation extends FcrSttMessageItem {
+    results0: {
+        texts: string[];
+        language: FcrLanguage;
+    };
+}
+export interface FcrSttMessageItem {
+    textTs: number;
+    isFinal: boolean;
+    uid: number;
+    offset: number;
+}
+export interface FcrSttTranscript extends FcrSttMessageItem {
+    text: string;
+    language: FcrLanguage;
+}
+export interface FcrSttreamMessagetData {
+    transcript?: FcrSttTranscript;
+    translation?: FcrSttTranslation;
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrTranscribingState = exports.FcrCaptionState = void 0;
+let FcrCaptionState = exports.FcrCaptionState = /*#__PURE__*/function (FcrCaptionState) {
+  FcrCaptionState[FcrCaptionState["STOPPED"] = 0] = "STOPPED";
+  FcrCaptionState[FcrCaptionState["STARTED"] = 1] = "STARTED";
+  return FcrCaptionState;
+}({});
+let FcrTranscribingState = exports.FcrTranscribingState = /*#__PURE__*/function (FcrTranscribingState) {
+  FcrTranscribingState[FcrTranscribingState["STOPPED"] = 0] = "STOPPED";
+  FcrTranscribingState[FcrTranscribingState["STARTED"] = 1] = "STARTED";
+  return FcrTranscribingState;
+}({});

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

@@ -10,7 +10,12 @@ import { FcrStreamControl } from './stream-control/type';
 import { FcrUserControl, FcrUserRole } from './user-control/type';
 import { FcrAbilityControl } from './ability-control/type';
 import { FcrSharingControl } from './sharing-control/type';
+import { FcrSttControl } from './stt-control/type';
 export interface FcrBaseRoomControl {
+    /**
+     * Gets the caption control.
+     */
+    getSttControl(): FcrSttControl;
     /**
      * Gets the user control.
      */
@@ -284,3 +289,13 @@ export declare enum FcrLineType {
     SINGLE_ROW = 1,
     MULTI_ROW = 2
 }
+export declare enum FcrWidgetUuid {
+    STT = "stt",
+    TRANSCRIBE = "transcribe",
+    ANNOTATION = "annotation"
+}
+export declare enum FcrWidgetCauseCmd {
+    STT = 3450,
+    TRANSCRIBE = 3430,
+    ANNOTATION = 1
+}

package/lib/room-control/type.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.FcrRoomType = exports.FcrLiveStreamingStateUpdatedReason = exports.FcrLineType = void 0;
+exports.FcrWidgetUuid = exports.FcrWidgetCauseCmd = exports.FcrRoomType = exports.FcrLiveStreamingStateUpdatedReason = exports.FcrLineType = void 0;
 let FcrRoomType = exports.FcrRoomType = /*#__PURE__*/function (FcrRoomType) {
   FcrRoomType[FcrRoomType["Mainroom"] = 11] = "Mainroom";
   FcrRoomType[FcrRoomType["Waitingroom"] = 102] = "Waitingroom";
@@ -21,4 +21,16 @@ let FcrLineType = exports.FcrLineType = /*#__PURE__*/function (FcrLineType) {
   FcrLineType[FcrLineType["SINGLE_ROW"] = 1] = "SINGLE_ROW";
   FcrLineType[FcrLineType["MULTI_ROW"] = 2] = "MULTI_ROW";
   return FcrLineType;
+}({});
+let FcrWidgetUuid = exports.FcrWidgetUuid = /*#__PURE__*/function (FcrWidgetUuid) {
+  FcrWidgetUuid["STT"] = "stt";
+  FcrWidgetUuid["TRANSCRIBE"] = "transcribe";
+  FcrWidgetUuid["ANNOTATION"] = "annotation";
+  return FcrWidgetUuid;
+}({});
+let FcrWidgetCauseCmd = exports.FcrWidgetCauseCmd = /*#__PURE__*/function (FcrWidgetCauseCmd) {
+  FcrWidgetCauseCmd[FcrWidgetCauseCmd["STT"] = 3450] = "STT";
+  FcrWidgetCauseCmd[FcrWidgetCauseCmd["TRANSCRIBE"] = 3430] = "TRANSCRIBE";
+  FcrWidgetCauseCmd[FcrWidgetCauseCmd["ANNOTATION"] = 1] = "ANNOTATION";
+  return FcrWidgetCauseCmd;
 }({});

package/lib/room-control/whiteboard-control/enum.d.ts

@@ -0,0 +1,15 @@
+/**
+ * common enums shared by whiteboard v1 and v2
+ */
+export declare enum FcrBoardInactiveReason {
+    CLOSE = 1,
+    TIMEOUT = 2,
+    SEIZE = 3
+}
+export declare enum FcrBoardRegion {
+    CN = "cn-hz",
+    US = "us-sv",
+    IN = "in-mum",
+    SG = "sg",
+    GB = "gb-lon"
+}

package/lib/room-control/whiteboard-control/{types.js → enum.js}

@@ -3,10 +3,21 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.FcrBoardInactiveReason = void 0;
+exports.FcrBoardRegion = exports.FcrBoardInactiveReason = void 0;
+/**
+ * common enums shared by whiteboard v1 and v2
+ */
 let FcrBoardInactiveReason = exports.FcrBoardInactiveReason = /*#__PURE__*/function (FcrBoardInactiveReason) {
   FcrBoardInactiveReason[FcrBoardInactiveReason["CLOSE"] = 1] = "CLOSE";
   FcrBoardInactiveReason[FcrBoardInactiveReason["TIMEOUT"] = 2] = "TIMEOUT";
   FcrBoardInactiveReason[FcrBoardInactiveReason["SEIZE"] = 3] = "SEIZE";
   return FcrBoardInactiveReason;
+}({});
+let FcrBoardRegion = exports.FcrBoardRegion = /*#__PURE__*/function (FcrBoardRegion) {
+  FcrBoardRegion["CN"] = "cn-hz";
+  FcrBoardRegion["US"] = "us-sv";
+  FcrBoardRegion["IN"] = "in-mum";
+  FcrBoardRegion["SG"] = "sg";
+  FcrBoardRegion["GB"] = "gb-lon";
+  return FcrBoardRegion;
 }({});

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

@@ -0,0 +1,38 @@
+import { ColorSchema } from '../../schema';
+import { FcrBoardInactiveReason, FcrBoardRegion } from './enum';
+/**
+ * common types shared by whiteboard v1 and v2
+ */
+export type FcrBoardPageInfo = {
+    showIndex: number;
+    count: number;
+};
+export type FcrColor = ColorSchema;
+export type FcrBoardActiveInfo = {
+    isActive: true;
+    ownerUserId: string;
+    reason?: FcrBoardInactiveReason;
+} | {
+    isActive: false;
+    ownerUserId: null;
+    reason?: FcrBoardInactiveReason;
+};
+export type FcrBoardExtra = {
+    boardAppId: string;
+    boardId: string;
+    boardRegion: FcrBoardRegion;
+    boardToken: string;
+};
+export type FcrBoardInfo = {
+    state: FcrBoardPropertiesState;
+    isActive: boolean;
+    ownerUserUuid: string;
+    extra: FcrBoardExtra & {
+        backgroundColor: string;
+    };
+};
+export declare enum FcrBoardPropertiesState {
+    ACTIVE = 1,
+    INACTIVE = 0,
+    BACKGROUND_COLOR_UPDATED = 100101
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrBoardPropertiesState = void 0;
+/**
+ * common types shared by whiteboard v1 and v2
+ */
+let FcrBoardPropertiesState = exports.FcrBoardPropertiesState = /*#__PURE__*/function (FcrBoardPropertiesState) {
+  FcrBoardPropertiesState[FcrBoardPropertiesState["ACTIVE"] = 1] = "ACTIVE";
+  FcrBoardPropertiesState[FcrBoardPropertiesState["INACTIVE"] = 0] = "INACTIVE";
+  FcrBoardPropertiesState[FcrBoardPropertiesState["BACKGROUND_COLOR_UPDATED"] = 100101] = "BACKGROUND_COLOR_UPDATED";
+  return FcrBoardPropertiesState;
+}({});

package/lib/room-control/whiteboard-control/utils.d.ts

@@ -0,0 +1,3 @@
+import { FcrPermissionInfo } from '../privilege-control/type';
+export declare const hasBoardWritePermission: (permissions: FcrPermissionInfo[]) => boolean;
+export declare const hasAnnotationWritePermission: (permissions: FcrPermissionInfo[]) => boolean;