fcr-core/lib/type.js

Core APIs for building online scenes

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
Object.defineProperty(exports, "FcrAbility", {
  enumerable: true,
  get: function () {
    return _type2.FcrAbility;
  }
});
Object.defineProperty(exports, "FcrAiDenoiseLevel", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRtcAiDenoiseLevel;
  }
});
Object.defineProperty(exports, "FcrAudioSourceType", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRtcAudioSourceType;
  }
});
Object.defineProperty(exports, "FcrBoardShape", {
  enumerable: true,
  get: function () {
    return _enum.FcrBoardShape;
  }
});
Object.defineProperty(exports, "FcrBoardToolType", {
  enumerable: true,
  get: function () {
    return _enum.FcrBoardToolType;
  }
});
Object.defineProperty(exports, "FcrCapability", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRtcCapability;
  }
});
Object.defineProperty(exports, "FcrChatPermissionType", {
  enumerable: true,
  get: function () {
    return _type4.FcrChatPermissionType;
  }
});
Object.defineProperty(exports, "FcrChatRoomConnectionState", {
  enumerable: true,
  get: function () {
    return _type3.FcrChatRoomConnectionState;
  }
});
Object.defineProperty(exports, "FcrChatRoomMessageType", {
  enumerable: true,
  get: function () {
    return _type3.FcrChatRoomMessageType;
  }
});
exports.FcrCloudRecordingAudioProfile = void 0;
Object.defineProperty(exports, "FcrConnectionState", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteConnectionState;
  }
});
Object.defineProperty(exports, "FcrCoreEngine", {
  enumerable: true,
  get: function () {
    return _imports.FcrCoreEngine;
  }
});
Object.defineProperty(exports, "FcrDeviceType", {
  enumerable: true,
  get: function () {
    return _type8.FcrDeviceType;
  }
});
Object.defineProperty(exports, "FcrError", {
  enumerable: true,
  get: function () {
    return _error.FcrError;
  }
});
Object.defineProperty(exports, "FcrIPConnectorSessionType", {
  enumerable: true,
  get: function () {
    return _type5.FcrIPConnectorSessionType;
  }
});
Object.defineProperty(exports, "FcrInterpreterActionType", {
  enumerable: true,
  get: function () {
    return _types.FcrInterpreterActionType;
  }
});
Object.defineProperty(exports, "FcrLanguage", {
  enumerable: true,
  get: function () {
    return _types.FcrLanguage;
  }
});
Object.defineProperty(exports, "FcrLineType", {
  enumerable: true,
  get: function () {
    return _type7.FcrLineType;
  }
});
exports.FcrLiveStreamingState = exports.FcrLiveStreamingLayoutType = void 0;
Object.defineProperty(exports, "FcrMediaSourceState", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRtcMediaSourceState;
  }
});
Object.defineProperty(exports, "FcrOperatePermissionType", {
  enumerable: true,
  get: function () {
    return _type4.FcrOperatePermissionType;
  }
});
Object.defineProperty(exports, "FcrPermissionAction", {
  enumerable: true,
  get: function () {
    return _type4.FcrPermissionAction;
  }
});
exports.FcrPlatform = void 0;
Object.defineProperty(exports, "FcrPrivilegeUserRole", {
  enumerable: true,
  get: function () {
    return _type4.FcrPrivilegeUserRole;
  }
});
Object.defineProperty(exports, "FcrPrivilegeUserRoleToStringMap", {
  enumerable: true,
  get: function () {
    return _type4.FcrPrivilegeUserRoleToStringMap;
  }
});
Object.defineProperty(exports, "FcrPrivilegeUserStringToRoleMap", {
  enumerable: true,
  get: function () {
    return _type4.FcrPrivilegeUserStringToRoleMap;
  }
});
exports.FcrRecordingState = void 0;
Object.defineProperty(exports, "FcrRegion", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteRegion;
  }
});
Object.defineProperty(exports, "FcrRoomConnectorPhoneRegion", {
  enumerable: true,
  get: function () {
    return _type5.FcrRoomConnectorPhoneRegion;
  }
});
Object.defineProperty(exports, "FcrRoomConnectorSessionReason", {
  enumerable: true,
  get: function () {
    return _type5.FcrRoomConnectorSessionReason;
  }
});
Object.defineProperty(exports, "FcrRoomConnectorSessionState", {
  enumerable: true,
  get: function () {
    return _type5.FcrRoomConnectorSessionState;
  }
});
Object.defineProperty(exports, "FcrRoomConnectorType", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteRoomConnectorType;
  }
});
exports.FcrRoomState = void 0;
Object.defineProperty(exports, "FcrScreenCaptureType", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteScreenCaptureType;
  }
});
Object.defineProperty(exports, "FcrScreenSharingState", {
  enumerable: true,
  get: function () {
    return _type6.FcrScreenSharingState;
  }
});
Object.defineProperty(exports, "FcrSecurityAction", {
  enumerable: true,
  get: function () {
    return _type4.FcrSecurityAction;
  }
});
Object.defineProperty(exports, "FcrStreamLatencyLevel", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteLatencyLevel;
  }
});
Object.defineProperty(exports, "FcrStreamPrivilegeAudioSourceType", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteStreamPrivilegeAudioSourceType;
  }
});
Object.defineProperty(exports, "FcrStreamPrivilegeOperation", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteStreamPrivilegeOperation;
  }
});
Object.defineProperty(exports, "FcrStreamPrivilegeVideoSourceType", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteStreamPrivilegeVideoSourceType;
  }
});
exports.FcrStreamState = void 0;
Object.defineProperty(exports, "FcrStreamType", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteMediaStreamType;
  }
});
Object.defineProperty(exports, "FcrUserKickedOutType", {
  enumerable: true,
  get: function () {
    return _type.FcrUserKickedOutType;
  }
});
Object.defineProperty(exports, "FcrUserLeftReason", {
  enumerable: true,
  get: function () {
    return _type.FcrUserLeftReason;
  }
});
Object.defineProperty(exports, "FcrUserRole", {
  enumerable: true,
  get: function () {
    return _type.FcrUserRole;
  }
});
exports.FcrUserStringToRoleMap = exports.FcrUserRoleToStringMap = void 0;
Object.defineProperty(exports, "FcrUserUpdatedReason", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteUserUpdatedReason;
  }
});
Object.defineProperty(exports, "FcrVideoOrientation", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRteVideoOrientation;
  }
});
Object.defineProperty(exports, "FcrVideoRenderMode", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRtcRenderMode;
  }
});
Object.defineProperty(exports, "FcrVideoSourceType", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRtcVideoSourceType;
  }
});
Object.defineProperty(exports, "FcrVideoStreamType", {
  enumerable: true,
  get: function () {
    return _imports.AgoraRtcVideoStreamType;
  }
});
Object.defineProperty(exports, "FcrWatermarkPermissionState", {
  enumerable: true,
  get: function () {
    return _type4.FcrWatermarkPermissionState;
  }
});
Object.defineProperty(exports, "FcrWhiteboardState", {
  enumerable: true,
  get: function () {
    return _type6.FcrWhiteboardState;
  }
});
exports.RoomMessageKey = void 0;
Object.defineProperty(exports, "registerPlugin", {
  enumerable: true,
  get: function () {
    return _imports.registerPlugin;
  }
});
var _type = require("./room-control/user-control/type");
var _imports = require("./imports");
var _type2 = require("./room-control/ability-control/type");
var _type3 = require("./room-control/chatroom-control/type");
var _types = require("./room-control/interpreter-control/types");
var _type4 = require("./room-control/privilege-control/type");
var _type5 = require("./room-control/room-connector-control/type");
var _type6 = require("./room-control/sharing-control/type");
var _type7 = require("./room-control/type");
var _type8 = require("./media-control/type");
var _error = require("./utilities/error");
var _enum = require("./room-control/whiteboard-control-v2/enum");
// 基础导入类型（集中管理第三方依赖类型别名）
// 内部枚举与基础类型导入
// 模块类型导出（按功能模块分组）
// 聊天连接模块
// 引擎核心配置
// 第三方类型别名（统一前缀避免冲突）
// 基础类型别名（简化常用类型引用）
// 媒体控制模块
// 监控控制模块
// 点对点会话模块
// 房间控制模块 - 能力控制
// 房间控制模块 - 聊天室控制
// 房间控制模块 - 翻译控制
// 房间控制模块 - 权限控制
// 房间控制模块 - 连接器控制
// 房间控制模块 - 房间会话
// 房间控制模块 - 共享控制
// 房间控制模块 - 流控制
// 房间控制模块 - 用户控制
// 房间控制模块 - 白板标注控制
// 房间控制模块 - 白板控制
// 房间路由模块
// 服务相关类型
// 核心引擎类型扩展
// 房间相关核心类型
let FcrRoomState = exports.FcrRoomState = /*#__PURE__*/function (FcrRoomState) {
  FcrRoomState[FcrRoomState["Initialized"] = 0] = "Initialized";
  FcrRoomState[FcrRoomState["Started"] = 1] = "Started";
  FcrRoomState[FcrRoomState["Ended"] = 2] = "Ended";
  FcrRoomState[FcrRoomState["Closed"] = 3] = "Closed";
  return FcrRoomState;
}({});
let FcrRecordingState = exports.FcrRecordingState = /*#__PURE__*/function (FcrRecordingState) {
  FcrRecordingState[FcrRecordingState["Starting"] = 1] = "Starting";
  FcrRecordingState[FcrRecordingState["Started"] = 2] = "Started";
  FcrRecordingState[FcrRecordingState["Paused"] = 3] = "Paused";
  FcrRecordingState[FcrRecordingState["Stopped"] = 4] = "Stopped";
  return FcrRecordingState;
}({});
/** 房间基本信息 */
/** 平台类型枚举 */
let FcrPlatform = exports.FcrPlatform = /*#__PURE__*/function (FcrPlatform) {
  FcrPlatform[FcrPlatform["UNSUPPORTED"] = -1] = "UNSUPPORTED";
  FcrPlatform[FcrPlatform["WEB_DESKTOP"] = 1] = "WEB_DESKTOP";
  FcrPlatform[FcrPlatform["MACOS"] = 2] = "MACOS";
  FcrPlatform[FcrPlatform["WINDOWS"] = 3] = "WINDOWS";
  FcrPlatform[FcrPlatform["IOS"] = 4] = "IOS";
  FcrPlatform[FcrPlatform["ANDROID"] = 5] = "ANDROID";
  FcrPlatform[FcrPlatform["WEB_MOBILE"] = 6] = "WEB_MOBILE";
  FcrPlatform[FcrPlatform["HARMONY"] = 7] = "HARMONY";
  FcrPlatform[FcrPlatform["CONNECTOR_PSTN"] = 101] = "CONNECTOR_PSTN";
  FcrPlatform[FcrPlatform["CONNECTOR_SIP"] = 102] = "CONNECTOR_SIP";
  FcrPlatform[FcrPlatform["CONNECTOR_H323"] = 103] = "CONNECTOR_H323";
  return FcrPlatform;
}({});
/** 用户信息类型 */
/** 流信息类型 */
/** 房间日程安排 */
/** 录制信息 */
// 群组相关类型
// 群组事件类型（统一事件格式）
// 房间路由事件
// 会话相关类型
// 媒体设备相关类型
// 性能与网络相关类型
// 云端录制配置
let FcrCloudRecordingAudioProfile = exports.FcrCloudRecordingAudioProfile = /*#__PURE__*/function (FcrCloudRecordingAudioProfile) {
  FcrCloudRecordingAudioProfile[FcrCloudRecordingAudioProfile["DEFAULT"] = 0] = "DEFAULT";
  // mono 单声道 48khz 48kbps
  FcrCloudRecordingAudioProfile[FcrCloudRecordingAudioProfile["MONO_48KHZ_128KBPS"] = 1] = "MONO_48KHZ_128KBPS";
  // mono 单声道 48khz 128kbps
  FcrCloudRecordingAudioProfile[FcrCloudRecordingAudioProfile["STEREO_48KHZ_192KBPS"] = 2] = "STEREO_48KHZ_192KBPS"; // stereo 立体声 48khz 192kbps
  return FcrCloudRecordingAudioProfile;
}({});
const FcrUserRoleToStringMap = exports.FcrUserRoleToStringMap = {
  [_type.FcrUserRole.HOST]: 'host',
  [_type.FcrUserRole.COHOST]: 'cohost',
  [_type.FcrUserRole.PARTICIPANT]: 'participant',
  [_type.FcrUserRole.AUDIENCE]: 'audience',
  [_type.FcrUserRole.OBSERVER]: 'observer',
  [_type.FcrUserRole.ROBOT]: 'robot'
};
const FcrUserStringToRoleMap = exports.FcrUserStringToRoleMap = {
  host: _type.FcrUserRole.HOST,
  cohost: _type.FcrUserRole.COHOST,
  participant: _type.FcrUserRole.PARTICIPANT,
  audience: _type.FcrUserRole.AUDIENCE,
  observer: _type.FcrUserRole.OBSERVER,
  robot: _type.FcrUserRole.ROBOT
};

// 直播相关类型
let FcrLiveStreamingLayoutType = exports.FcrLiveStreamingLayoutType = /*#__PURE__*/function (FcrLiveStreamingLayoutType) {
  FcrLiveStreamingLayoutType[FcrLiveStreamingLayoutType["GALLERY"] = 1] = "GALLERY";
  // 画廊模式
  FcrLiveStreamingLayoutType[FcrLiveStreamingLayoutType["SPEAKER"] = 2] = "SPEAKER"; // 主讲模式
  return FcrLiveStreamingLayoutType;
}({});
let FcrLiveStreamingState = exports.FcrLiveStreamingState = /*#__PURE__*/function (FcrLiveStreamingState) {
  FcrLiveStreamingState[FcrLiveStreamingState["STARTING"] = 1] = "STARTING";
  FcrLiveStreamingState[FcrLiveStreamingState["STARTED"] = 2] = "STARTED";
  FcrLiveStreamingState[FcrLiveStreamingState["STOPPED"] = 3] = "STOPPED";
  return FcrLiveStreamingState;
}({});
let RoomMessageKey = exports.RoomMessageKey = /*#__PURE__*/function (RoomMessageKey) {
  RoomMessageKey["USER_WAITING_ROOM_JOINED"] = "USER_WAITING_ROOM_JOINED";
  return RoomMessageKey;
}({});
let FcrStreamState = exports.FcrStreamState = /*#__PURE__*/function (FcrStreamState) {
  FcrStreamState[FcrStreamState["UNPUBLISH"] = 0] = "UNPUBLISH";
  FcrStreamState[FcrStreamState["PUBLISH"] = 1] = "PUBLISH";
  return FcrStreamState;
}({});