Global

Members

TPackageType :string

Properties:
Name Type Description
Default number

0 默认（现存应用）
Trial number

1 试用
Light number

2 轻量版
Standard number

3 标准版
Flagship number

4 旗舰版

当前应用版本级别 5个等级

Type:
  • string

(constant) TFunctionControlDefaultMap

默认或下发配置识别

TIMEvent :string

IM 事件 EventBusNames

Type:
  • string

TIMConvType

IM 会话类型

TIMMsgType

IM 消息类型

TMainEvent

业务层相关事件 EventBusNames

TMainState :string

业务层相关状态

Type:
  • string

TPermissionUpdateReason :string

Properties:
Name Type Description
Unknown string

'unknown' 未知
Init string

'init' 进房后初始化
MuteAll string

'mute_all' 开启或取消全员静音
MuteVideoAll string

'mute_video_all' 开启或关闭全员视频
KickOut string

'member_kick' 被踢出课堂
KickOutForever string

'member_kick_forever' 被永久踢出课堂
Action string

'action' 调用MemberAction修改权限

权限更新原因

Type:
  • string

TResourceType :string

资源类型

Type:
  • string

TPermissionFlag

权限类型

TPlatform :number

Properties:
Name Type Description
Unknown number

0 未知
Windows number

1 Windows
Mac number

2 Mac
Android number

3 Android
IOS number

4 iOS
Web number

5 Web
H5 number

6 H5
Miniprogram number

7 小程序
TV number

8 智能电视

平台类型

Type:
  • number

TDevice :number

Properties:
Name Type Description
Unknown number

0 未知
Windows number

1 Windows
Mac number

2 Mac
Pad number

3 Pad
Phone number

4 Phone
TV number

5 TV
Miniprogram number

6 小程序

设备类型

Type:
  • number

TPlatformCategory :string

Properties:
Name Type Description
Unknown string
Web string
Miniprogram string
Mobile string
PC string
Others string

平台分类

Type:
  • string

TClassStatus :number

Properties:
Name Type Description
Not_Start number

0 未开始
Already_Start number

1 已经开始
Has_Ended number

2 已经结束
Has_Expired number

3 已过期

课堂状态

Type:
  • number

TClassType :number

Properties:
Name Type Description
Interactive number

0 互动课
Live number

1 公开课
United number

2 统一课堂

课堂类型

Type:
  • number

TClassSubType :String

Properties:
Name Type Description
UnKnow string

'' 未知课程
VideoDoc string

'videodoc' 视频+文档
Video string

'video' 纯视频

课堂子类型

Type:
  • String

TAudienceType :number

Properties:
Name Type Description
Unknown number

0 未知
RTC number

1 互动观看
CDN number

2 CDN观看

观看类型

Type:
  • number

TClassLayout :string

Properties:
Name Type Description
Top string

'top' 顶部布局（互动班课）
Double string

'double' 双排布局（互动班课）
Right string

'right' 右侧布局（互动班课）
Left string

'left' 左侧布局（互动班课）
Three string

'three' 三分屏（互动班课、1v1课）
PicInPic string

'picinpic' 电脑文档+视频，手机画中画（公开课）
VideoDoc string

'videodoc' 电脑文档+视频， 手机文档+视频（公开课）
Video string

'video' 纯视频模式（公开课、1v1课）

课堂布局

Type:
  • string

(constant) CheckValueInEnum

检查某个值是否为对象或enum 的有效值

TCameraResolution :number

Properties:
Name Type Description
Resolution_320_180 number

320x180
Resolution_640_360 number

640x360
Resolution_960_540 number

960x540
Resolution_1280_720 number

1280x720
Resolution_1920_1080 number

1920x1080

摄像头分辨率

Type:
  • number

TQuestionType :number

Properties:
Name Type Description
Single number

单选
Multiple number

多选

问题类型

Type:
  • number

TQuestionStatus :number

Properties:
Name Type Description
Starting number

正在进行
Ended number

已结束
Canceled number

已取消

问题状态1

Type:
  • number

TMemberStatus :number

Properties:
Name Type Description
Absent number

0 未到
Online number

1 在线
Quited number

2 已退出
KickOuted number

3 被踢出
KickOutedForever number

4 被永久踢出
Offline number

5 掉线

成员在线状态

Type:
  • number

TMemberActionType :number

Properties:
Name Type Description
None number

0 未知
Camera_Open number

1 打开摄像头
Camera_Close number

2 关闭摄像头
Mic_Open number

3 打开麦克风
Mic_Close number

4 关闭麦克风
Camera_Mic_Open number

5 打开摄像头和麦克风
Camera_Mic_Close number

6 关闭摄像头和麦克风
Hand_Up number

7 举手
Hand_Up_Cancel number

8 取消举手
Kick_Out number

9 踢出课堂
Board_Enable number

10 允许操作白板
Board_Disable number

11 禁止操作白板
Silence number

12 禁言
Silence_Cancel number

13 取消禁言
Screen_Share_Open number

14 开始屏幕分享
Screen_Share_Close number

15 停止屏幕分享
Stage_Up number

16 上台
Stage_Down number

17 下台
Kick_Out_Forever number

18 永久踢出
Vod_Play number

19 分享播片
Sub_Camera number

20 分享辅助摄像头

成员相关操作

Type:
  • number

(readonly) TMemberType :number

Properties:
Name Type Description
All number

0 全部成员
Inviter number

1 受邀者
Visitor number

2 访客
Offline number

3 离线成员

成员类型

Type:
  • number

TStreamType :number

Properties:
Name Type Description
Main number

主流
Sub number

辅流

流类型

Type:
  • number

TJoinType :number

Properties:
Name Type Description
Unknown number

0 未知(废弃)
CDN number

1 CDN观看[旧版本]
Live number

2 快直播观看[旧版本]
RTC number

3 RTC观看[当前支持]
number

加入课堂类型

Type:
  • number

TDeviceStatus :number

Properties:
Name Type Description
Fail number

1001 打开失败
Not_Found number

1002 找不到设备
No_Permission number

1003 未授权
Busy number

1004 设备被占用
Unknown number

0 未知
Open number

1 已打开
Closed number

2 已关闭

设备状态

Type:
  • number

TLiveAction :string

方法名列表，主要用于 PromiseExecutor 的 Action 参数

Type:
  • string

TResourceType

资源类型

TDeviceOrientation

设备方向

TNetworkQuality

网络质量

TBoardToolType :number

Properties:
Name Type Description
TBoardToolType_Mouse number

鼠标
TBoardToolType_Pen number

画笔工具
TBoardToolType_Eraser number

橡皮擦
TBoardToolType_Laser number

激光笔
TBoardToolType_Line number

直线
TBoardToolType_Oval number

空心椭圆
TBoardToolType_Rect number

空心矩形
TBoardToolType_Oval_Solid number

实心椭圆
TBoardToolType_Rect_Solid number

实心矩形
TBoardToolType_Point_Select number

点选工具
TBoardToolType_Rect_Select number

框选工具
TBoardToolType_Text number

文本工具
TBoardToolType_Zoom_Drag number

缩放移动工具
TBoardToolType_Square number

空心正方形
TBoardToolType_Square_Solid number

实心正方形
TBoardToolType_Circle number

空心正圆形
TBoardToolType_Circle_Solid number

实心正圆形
TBoardToolType_Board_Custom_Graph number

自定义图形
TBoardToolType_Mouse number

鼠标

白板工具

Type:
  • number

TBoardFitMode :number

Properties:
Name Type Description
TBoardFitMode_NONE number

不使用文件自适应，我们目前使用的模式，不自动调整白板宽高比，文件等比例缩放居中显示，文件宽高<=白板宽高
TBoardFitMode_CENTER_INSIDE number

自动调整白板宽高比与文件一致，文件铺满白板，白板等比例缩放居中显示，白板宽高<=容器宽高
TBoardFitMode_CENTER_COVER number

自动调整白板宽高比与文件一致，文件铺满白板，白板等比例缩放居中显示，白板宽高>=容器宽高

白板填充模式

Type:
  • number

TLevel

日志和上报级别

TDeviceOrientation :number

Properties:
Name Type Description
Landscape string

0 横屏（默认）
Portrait string

1 竖屏

设备方向

Type:
  • number

TTrtcEvent :string

音视频相关事件

Type:
  • string

TTrtcMode :string

TRTC模式

Type:
  • string

TTrtcDeviceType :number

Properties:
Name Type Description
Unknown number

未知，Device_Change 事件回调专用
Mic number

麦克风，Device_Change 事件回调专用
Speaker number

扬声器，Device_Change 事件回调专用
Camera number

摄像头，Device_Change 事件回调专用

设备类型

Type:
  • number

TTrtcDeviceState :number

Properties:
Name Type Description
Add number

添加
Remove number

移除
Active number

可使用
Update number

更新

设备插拔事件类型

Type:
  • number

TTrtcVideoStreamType :number

视频流类型

Type:
  • number

TTrtcVideoResolution :number

视频分辨率

Type:
  • number

TTrtcVideoFillMode :number

Properties:
Name Type Description
Fill number

0 等比缩放，填满视窗
Fit number

1 等比缩放，保留黑边

视频填充模式

Type:
  • number

TTrtcVideoRotation :number

Properties:
Name Type Description
Rotation_0 number

0 不旋转
Rotation_90 number

1 顺时针旋转90度
Rotation_180 number

2 旋转180度
Rotation_270 number

3 顺时针旋转270度

视频旋转角度

Type:
  • number

TTrtcVideoMirrorType :number

Properties:
Name Type Description
Auto number

0 自动：前置摄像头镜像，后置摄像头不镜像
Enable number

1 打开镜像
Disable number

2 关闭镜像

镜像类型

Type:
  • number

TScreenCaptureSourceType :number

Properties:
Name Type Description
Unknown number

1 未知
Window number

0 窗口
Screen number

1 屏幕
Custom number

2 自定义

屏幕共享源类型

Type:
  • number

TTrtcAction :string

方法名列表，主要用于 PromiseExecutor 的 Action 参数

Type:
  • string

Type Definitions

TRoleName

用户角色权限

Type:
  • 'none' | 'visitor' | 'student' | 'supervisor' | 'assistant' | 'teacher'