Enums & Types

All exported enums and TypeScript type definitions.

INFO

Enums have runtime values (usable in switch/comparison). Types are compile-time only (zero runtime cost).

Enumerations

Enum	Description
`AskStageStatus`
`BoardErrorCode`
`BoardFitMode`
`BoardStatus`
`BoardToolType`
`CoursewarePermission`
`DeviceStatus`
`DeviceType`	Microphone / Speaker）。Device type enum.
`JoinProgress`
`JoinType`	Live / RTC）。Join type enum (CDN / Live / RTC).
`KickOutReason`
`LiveStreamType`
`MemberActionType`
`NetworkModule`
`NetworkQualityLevel`
`NetworkSeverity`
`PackageType`
`QuestionType`
`QuizStatus`
`RtcEvent`
`StreamType`	Screen 屏幕共享）。Stream type enum.
`TI18nNamespace`
`TranscodeState`
`TranscodeType`
`TranscriptionStatus`
`UploadTrackStatus`

Interfaces

Interface	Description
`AddOnlineCoursewareParam`	H5 URL
`BatchGetCoursewareInfoResult`
`BoardConfig`
`BoardInitParams`	SDK AppID
`BoardResourceConfig`	axios JS URL
`BoardStyleConfig`
`BoardSyncData`
`BoardTranscodeResult`
`ClassInfo`
`ClassroomBehavior`	```ts
`ClassroomConfig`	[`lang`: `string`]: `object`
`ClassroomEvents`	`number`
`ClassTask`
`COSTokenResult`	expired_time / bucket_name / appid / region / path / doc_name
`CoursewareInfo`
`CreateDocumentResult`
`CustomMessageContent`
`DeviceInfo`
`DocUploadProgressPayload`
`EnvironmentCheckResult`	WebRTC）。
`FileMessageContent`
`GetCoursewareListParam`
`GetCoursewareListResult`
`GetTaskListResult`
`GlobalNetworkStatus`
`ImgMessageContent`
`JoinParams`
`LiveStreamInfo`
`MarqueeConfig`
`MarqueeParam`
`MemberActionParam`	Member action parameters
`MemberInfo`
`Message`
`ModuleNetworkStatus`
`MouseToolBehavior`
`MusicPlayParam`
`NetworkQuality`
`PackageFeatureConfig`
`QuizAnswer`
`QuizStat`
`ReadonlySignal`	- `WritableSignal`
`RoleCapabilities`
`SchoolCustomContent`
`SchoolInfo`
`SimpleCoursewareInfo`
`StageLoopParams`	Stage loop parameters
`StartQuizParam`
`SubmitRateParam`
`SubtitleData`
`TaskInfo`	task_id → taskId, create_time → createTime,
`TAvatarParam`
`TBeautyParam`
`TDeviceInfo`
`TErrorPayload`
`TranslateConfig`
`TranslateMsgPayload`
`TRemoteAVInfo`
`TResultFail`
`TResultOk`	`T` = `void`
`TVideoEncoderParam`
`TVirtualBackgroundParam`
`TWarnPayload`
`UpdateTaskParam`
`UploadCoursewareParam`	```typescript
`UploadCoursewareResult`
`UploadDocumentResult`
`UploadTrackInfo`
`ViewBinding`
`VodPlayParam`
`WatermarkConfig`
`WatermarkPosition`
`WatermarkTextStyle`
`WritableSignal`	- `ReadonlySignal`<`T`>

Type Aliases

Type	Description
`ClassLayout`	Classroom layout type (backend values; synced via setLayout API).
`ClassroomEventPayload`	Extract the payload type of an event callback.
`ClassStatus`
`Listener`	`T`
`MessageFilterType`
`MessageType`
`MusicPlayStatus`
`Platform`
`Role`
`ScreenShareStatus`
`ScreenState`
`SilenceMode`
`StageStatus`
`TErrorModule`	TEvent.WARN 时，通过 module 字段判断来源，
`TEventName`
`TI18nMessages`
`TResult`	`T` = `void`
`TResultCode`
`Unsubscribe`	`void`
`UploadProgressCallback`	`number`
`UploadReadyCallback`	`string`
`VodPlayStatus`

Utility Functions & Constants

Name	Description
`BOARD_EXT`
`detectSystemLocale`	Node 环境中检测系统语言，并尝试匹配到 SDK 支持的语言列表。
`getTResultDomain`	`"success"` \| `"framework"` \| `"api"` \| `"rtc"` \| `"im"` \| `"board"` \| `"quiz"` \| `"mediaplay"` \| `"subtitle"` \| `"watermark"` \| `"statistics"`
`isTResultCode`	`boolean`
`SDK_VERSION`
`SUPPORTED_LOCALES`
`TEvent`	Event name constants.
`tfail`	`string`
`tfromError`	`unknown`
`tok`	`T` = `void`

Enums & Types ​

Enumerations ​

Interfaces ​

Type Aliases ​

Utility Functions & Constants ​

Enums & Types

Enumerations

Interfaces

Type Aliases

Utility Functions & Constants