枚举与类型

SDK 对外导出的所有枚举和 TypeScript 类型定义。

INFO

枚举有运行时值（可用于 switch/比较），类型为纯编译期（零运行时开销）。

枚举

枚举名	说明
AskStageStatus	申请上台状态枚举。
BoardErrorCode	白板错误码（非连续值）
BoardFitMode	白板内容适配模式
BoardStatus	白板状态枚举。
BoardToolType	白板工具类型
CoursewarePermission	课件权限
DeviceStatus	设备状态枚举。
DeviceType	设备类型枚举（Camera
JoinProgress	进房流程阶段枚举。
JoinType	进房类型枚举（CDN
KickOutReason	踢出原因枚举。
LiveStreamType	快直播流类型（对齐老项目 business/tbusiness_member.ts:281-284）
MemberActionType	Member action types (对齐老项目 tbusiness_member.ts:36-54)
NetworkModule	网络监控模块标识枚举。
NetworkQualityLevel	网络质量等级枚举（0-5，数值越低越好）。
NetworkSeverity	网络严重性等级枚举。
PackageType	套餐类型枚举。
QuestionType	答题器题目类型（对齐后端 question_type 字段）
QuizStatus	答题器状态（字符串枚举，对齐 VodPlayStatus 等项目内状态类型）
RtcEvent	RTC 适配器内部事件枚举。
StreamType	流类型枚举（Camera 摄像头
TI18nNamespace	词条命名空间枚举。
TranscodeState	转码状态
TranscodeType	转码类型
TranscriptionStatus	字幕转写任务状态（对齐后端 describeSubtitleTranscriptionTask 返回值）。
UploadTrackStatus	上传跟踪状态枚举

接口

接口名	说明
AddOnlineCoursewareParam	添加在线 H5 课件参数
BatchGetCoursewareInfoResult	批量获取课件信息结果
BoardConfig	白板配置。
BoardInitParams	白板初始化参数
BoardResourceConfig	白板资源配置接口，所有字段可选，缺省时使用 DEFAULT_BOARD_RESOURCES
BoardStyleConfig	白板样式配置。
BoardSyncData	白板信令数据（TEduBoard TEB_SYNCDATA 事件的回调载荷）。
BoardTranscodeResult	白板转码结果
ClassInfo	课堂完整信息。
ClassroomBehavior	SDK 内部行为开关。
ClassroomConfig	SDK 构造参数。
ClassroomEvents	课堂事件类型图谱。
ClassTask	课堂白板任务。
COSTokenResult	COS 上传凭证
CoursewareInfo	课件完整信息
CreateDocumentResult	创建文档记录结果
CustomMessageContent	自定义消息内容（Message.type === 'custom' 时用 JSON.parse(content) 获取）
DeviceInfo	设备信息。
DocUploadProgressPayload	上传进度事件 payload（DOC_UPLOAD_PROGRESS）
EnvironmentCheckResult	环境检测结果。
FileMessageContent	文件消息内容（Message.type === 'file' 时用 JSON.parse(content) 获取）
GetCoursewareListParam	获取课件列表参数
GetCoursewareListResult	获取课件列表结果
GetTaskListResult	getTasks 接口返回结果
GlobalNetworkStatus	全局网络状态聚合。
ImgMessageContent	图片消息内容（Message.type === 'image' 时用 JSON.parse(content) 获取）
JoinParams	进房参数。
LiveStreamInfo	快直播流信息（严格 3 字段，对齐老项目 TStreamInfo，business/tbusiness_member.ts:289-311）。
MarqueeConfig	跑马灯配置。
MarqueeParam	跑马灯参数。
MemberActionParam	Member action parameters
MemberInfo	成员信息（含权限字段）。
Message	IM 聊天消息。
ModuleNetworkStatus	模块网络状态。
MouseToolBehavior	鼠标工具行为配置
MusicPlayParam	背景音乐播放参数
NetworkQuality	网络质量信息。
PackageFeatureConfig	套餐功能配置。
QuizAnswer	单条答题记录
QuizStat	答题统计结果
ReadonlySignal	只读响应式信号接口。
RoleCapabilities	角色能力配置。
SchoolCustomContent	学校自定义内容。
SchoolInfo	学校信息。
SimpleCoursewareInfo	课件精简信息
StageLoopParams	Stage loop parameters
StartQuizParam	发起答题参数
SubmitRateParam	提交课后评价的参数
SubtitleData	字幕数据。
TaskInfo	课堂业务任务信息。
TAvatarParam	虚拟形象参数。
TBeautyParam	美颜参数。
TDeviceInfo	设备信息（TRTC 格式）。
TErrorPayload	统一错误事件 payload（TEvent.ERROR）
TranslateConfig	IM 消息翻译功能配置
TranslateMsgPayload	翻译消息事件 payload（translateMsg 事件携带）
TRemoteAVInfo	远端音视频信息。
TResultFail	失败结果（ok=false, code+message+detail）。
TResultOk	成功结果（ok=true, data=T）。
TVideoEncoderParam	视频编码参数。
TVirtualBackgroundParam	虚拟背景参数。
TWarnPayload	统一警告事件 payload（TEvent.WARN）
UpdateTaskParam	创建或更新课堂任务的参数（答题器/计时器等）
UploadCoursewareParam	上传课件参数
UploadCoursewareResult	uploadCourseware 成功后的返回数据
UploadDocumentResult	COS 上传文件结果=
UploadTrackInfo	上传文件跟踪状态
ViewBinding	远端视频绑定句柄（不透明对象）。
VodPlayParam	VOD 播放参数
WatermarkConfig	水印配置。
WatermarkPosition	水印位置。
WatermarkTextStyle	水印文字样式。
WritableSignal	可读写响应式信号接口。

类型别名

类型名	说明
ClassLayout	课堂布局类型。
ClassroomEventPayload	提取某个事件回调的 payload 类型。
ClassStatus	课堂状态。
Listener	信号订阅回调函数类型。
MessageFilterType	消息过滤类型。
MessageType	消息类型。
MusicPlayStatus	背景音乐播放状态。
Platform	平台类型。
Role	课堂角色。
ScreenShareStatus	屏幕共享状态。
ScreenState	屏幕共享状态。
SilenceMode	聊天禁言模式。
StageStatus	上台状态。
TErrorModule	错误/警告事件的来源模块标识。
TEventName	事件名类型 — ClassroomEvents 的所有 key 联合类型
TI18nMessages	扁平词条表：key → 本地化文案
TResult	SDK 统一方法返回值（成功 TResultOk 或失败 TResultFail）。
TResultCode	统一错误码常量（分段设计：1xxx 框架、10xxx API、20xxx RTC、30xxx IM、40xxx 白板）。
Unsubscribe	取消订阅函数类型。
UploadProgressCallback	上传进度回调：(已上传字节, 总字节, 速度 bytes/s, 百分比 0~1)
UploadReadyCallback	COS 上传就绪回调 — 在文件开始传输前触发，携带 taskId。
VodPlayStatus	视频点播播放状态。

工具函数与常量

名称	说明
BOARD_EXT	白板信令扩展标识
detectSystemLocale	从浏览器
getTResultDomain	根据错误码获取所属模块域名。
isTResultCode	检查结果的错误码是否匹配。
SDK_VERSION	@tencent-classroom/sdk — 常量定义
SUPPORTED_LOCALES	SDK 内置支持的语言代码集合（与 locales/ 目录保持同步）。
TEvent	事件名常量。
tfail	创建失败结果。
tfromError	从 catch 块的 error 创建失败结果。
tok	创建成功结果。