agora-edu-core
Version:
Core APIs for building an online classroom
381 lines (380 loc) • 9.17 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
Object.defineProperty(exports, "AgoraCloudProxyType", {
enumerable: true,
get: function () {
return _agoraRteSdk.AgoraCloudProxyType;
}
});
exports.EduRoomTypeEnum = exports.EduRoleTypeEnum = exports.ClassroomState = exports.AgoraEduEventType = exports.AgoraEduClassroomEvent = exports.AgoraCommandEnum = void 0;
var _agoraRteSdk = require("agora-rte-sdk");
/**
* 房间连接状态
*/
/** @en
* Room connection state
*/
let ClassroomState = exports.ClassroomState = /*#__PURE__*/function (ClassroomState) {
/**
* 未连接
*/
/** @en
* Not connected
*/
ClassroomState[ClassroomState["Idle"] = 0] = "Idle";
/**
* 正在连接
*/
/** @en
* Connecting
*/
ClassroomState[ClassroomState["Connecting"] = 1] = "Connecting";
/**
* 已连接
*/
/** @en
* Connected
*/
ClassroomState[ClassroomState["Connected"] = 2] = "Connected";
/**
* 正在重练
*/
/** @en
* Reconnecting
*/
ClassroomState[ClassroomState["Reconnecting"] = 3] = "Reconnecting";
/**
* 连接出错
*/
/** @en
* Error occurred while connecting
*/
ClassroomState[ClassroomState["Error"] = 4] = "Error";
return ClassroomState;
}({});
/**
* 房间类型
*/
/** @en
* Edu room type enum
*/
let EduRoomTypeEnum = exports.EduRoomTypeEnum = /*#__PURE__*/function (EduRoomTypeEnum) {
/**
* 一对一
*/
/** @en
* One to one classroom
*/
EduRoomTypeEnum[EduRoomTypeEnum["Room1v1Class"] = 0] = "Room1v1Class";
/**
* 小班课
*/
/** @en
* Small classroom
*/
EduRoomTypeEnum[EduRoomTypeEnum["RoomSmallClass"] = 4] = "RoomSmallClass";
/**
* 大班课
*/
/** @en
* Lecture hall
*/
EduRoomTypeEnum[EduRoomTypeEnum["RoomBigClass"] = 2] = "RoomBigClass";
/**
* 自习室
*/
/** @en
* Study room
*/
EduRoomTypeEnum[EduRoomTypeEnum["RoomStudy"] = 7] = "RoomStudy";
/**
* @internal
*/
/** @en
*
* @internal
*/
EduRoomTypeEnum[EduRoomTypeEnum["RoomGroup"] = 101] = "RoomGroup";
/**
* 监考场景
*/
/** @en
* Cloud examination room
*/
EduRoomTypeEnum[EduRoomTypeEnum["RoomProctor"] = 6] = "RoomProctor";
/**
* 云课堂
*/
/** @en
* Cloud class room
*/
EduRoomTypeEnum[EduRoomTypeEnum["CloudClass"] = 10] = "CloudClass";
return EduRoomTypeEnum;
}({});
/**
* 角色类型
*/
/** @en
* Edu role type enum
*/
let EduRoleTypeEnum = exports.EduRoleTypeEnum = /*#__PURE__*/function (EduRoleTypeEnum) {
/**
* 空
*/
/** @en
* None
*/
EduRoleTypeEnum[EduRoleTypeEnum["none"] = -1] = "none";
/**
* 观众（录制）
*/
/** @en
* Invisible（Recorder）
*/
EduRoleTypeEnum[EduRoleTypeEnum["invisible"] = 0] = "invisible";
/**
* 老师
*/
/** @en
* Teacher
*/
EduRoleTypeEnum[EduRoleTypeEnum["teacher"] = 1] = "teacher";
/**
* 学生
*/
/** @en
* Student
*/
EduRoleTypeEnum[EduRoleTypeEnum["student"] = 2] = "student";
/**
* 助教
*/
/** @en
* Assistant
*/
EduRoleTypeEnum[EduRoleTypeEnum["assistant"] = 3] = "assistant";
/**
* 监课
*/
/** @en
* Observer
*/
EduRoleTypeEnum[EduRoleTypeEnum["observer"] = 4] = "observer";
return EduRoleTypeEnum;
}({});
/**
* 房间 Session 信息。
*/
/** @en
* Represents the information of an education session.
*/
/**
* 教育事件类型
*/
/** @en
* Edu event type
*/
let AgoraEduEventType = exports.AgoraEduEventType = /*#__PURE__*/function (AgoraEduEventType) {
AgoraEduEventType["classroomEvents"] = "classroom-events";
return AgoraEduEventType;
}({});
/**
* 教室事件
*/
/** @en
* Classroom Events
*/
let AgoraEduClassroomEvent = exports.AgoraEduClassroomEvent = /*#__PURE__*/function (AgoraEduClassroomEvent) {
/**
* 进入教室成功
*/
/** @en
* Joined the classroom
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["Ready"] = 1] = "Ready";
/**
* 教室销毁
*/
/** @en
* Classroom is destroyed
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["Destroyed"] = 2] = "Destroyed";
/**
* 进入教室失败
*/
/** @en
* Failed to join the classroom
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["FailedToJoin"] = 3] = "FailedToJoin";
/**
* 被踢出教室
*/
/** @en
* Kicked out of the classroom by teacher
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["KickOut"] = 101] = "KickOut";
/**
* 老师允许学生打开麦克风
*/
/** @en
* The teacher allowed the students to turn on the microphone
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["TeacherTurnOnMyMic"] = 102] = "TeacherTurnOnMyMic";
/**
* 老师不允许学生打开麦克风
*/
/** @en
* The teacher disallowed the students to turn on the microphone
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["TeacherTurnOffMyMic"] = 103] = "TeacherTurnOffMyMic";
/**
* 当前用户上台
*/
/** @en
* The current user has became on stage
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["UserAcceptToStage"] = 106] = "UserAcceptToStage";
/**
* 当前用户下台
*/
/** @en
* The current user has left stage
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["UserLeaveStage"] = 107] = "UserLeaveStage";
/**
* 用户收到奖励
*/
/** @en
* Users receive rewards
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["RewardReceived"] = 108] = "RewardReceived";
/**
* 老师允许学生打开摄像头
*/
/** @en
* The teacher allowed the students to turn on the camera
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["TeacherTurnOnMyCam"] = 109] = "TeacherTurnOnMyCam";
/**
* 老师不允许学生打开摄像头
*/
/** @en
* The teacher disallowed the students to turn on the camera
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["TeacherTurnOffMyCam"] = 110] = "TeacherTurnOffMyCam";
/**
* 摄像头被拔出
*/
/** @en
* Camera pulled out
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["CurrentCamUnplugged"] = 111] = "CurrentCamUnplugged";
/**
* 麦克风被拔出
*/
/** @en
* Microphone pulled out
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["CurrentMicUnplugged"] = 112] = "CurrentMicUnplugged";
/**
* 扬声器被拔出
*/
/** @en
* Speaker pulled out
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["CurrentSpeakerUnplugged"] = 113] = "CurrentSpeakerUnplugged";
/**
* 用户未授权屏幕共享
*/
/** @en
* The user does not authorize screen sharing
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["CaptureScreenPermissionDenied"] = 114] = "CaptureScreenPermissionDenied";
/**
* 用户收到奖励（通过批量接口）
*/
/** @en
* Users receive rewards(through batched API)
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["BatchRewardReceived"] = 117] = "BatchRewardReceived";
/**
* 被邀请至小组
*/
/** @en
* Being invited to the group
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["InvitedToGroup"] = 118] = "InvitedToGroup";
/**
* 用户被移动至小组
*/
/** @en
* User moved to other group
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["MoveToOtherGroup"] = 119] = "MoveToOtherGroup";
/**
* 当前用户加入分组
*/
/** @en
* Current user joined to the group
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["JoinSubRoom"] = 120] = "JoinSubRoom";
/**
* 用户离开分组
*/
/** @en
* Current user left the group
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["LeaveSubRoom"] = 121] = "LeaveSubRoom";
/**
* 用户接收小组邀请
*/
/** @en
* Users receive group invitations
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["AcceptedToGroup"] = 122] = "AcceptedToGroup";
/**
* 用户加入小组通知
*/
/** @en
* Notification of a user joining a group
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["UserJoinGroup"] = 123] = "UserJoinGroup";
/**
* 用户离开小组通知
*/
/** @en
* Notification of a user leaving a group
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["UserLeaveGroup"] = 124] = "UserLeaveGroup";
/**
* 用户拒绝小组邀请
*/
/** @en
* User rejected invitation from joining group
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["RejectedToGroup"] = 125] = "RejectedToGroup";
/**
* RTC 连接状态变更
*/
/** @en
* The state of RTC channel is changed
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["RTCStateChanged"] = 201] = "RTCStateChanged";
/**
* 房间连接状态变更
*/
/** @en
* The state of the classroom connection is changed
*/
AgoraEduClassroomEvent[AgoraEduClassroomEvent["ClassStateChanged"] = 202] = "ClassStateChanged";
return AgoraEduClassroomEvent;
}({});
let AgoraCommandEnum = exports.AgoraCommandEnum = /*#__PURE__*/function (AgoraCommandEnum) {
AgoraCommandEnum[AgoraCommandEnum["UserRewardChanged"] = 1101] = "UserRewardChanged";
return AgoraCommandEnum;
}({});
/**
* 业务流状态
*/