互动白板>客户端 API>uni-app

uni-app

编辑文档更新于 2025-02-21 01:50:57

BRTMBRTMDocumentManagerBRTMChatManagerBRTMUserManagerBRTMDocument对象和枚举

enum structure

对象类型	描述
BrtmUserRole	用户角色
BrtmEndpointType	终端类型
BrtmShapeOperateMode	画笔操作模式
BrtmDocumentType	文档类型
BrtmShapeType	画笔类型

Object

对象类型	描述
BrtmUserInfo	传入的用户信息
BrtmUser	用户信息
BrtmChatMessage	聊天消息
PageItem	页面信息
DocPageInfo	文档页面信息
PageChangeInfo	页面变化信息
DocExtraInfo	文档额外信息
DocRemarkInfo	课件备注信息
BrtmDocumentItem	文档数据信息
BrtmDocAllRes	所有文档数据信息

详情

BrtmUserRole

用户角色

枚举	取值	描述
User	0	普通用户
Root	1	超级管理员
Admin	2	管理员

BrtmEndpointType

终端类型

枚举	取值	描述
PCHtml	0	PC 网站
PCClient	1	PC 客户端
PCH5	2	PC H5
iOS	3	iOS 客户端
Android	4	Android 客户端
PCMacClient	5	Mac 客户端

BrtmShapeOperateMode

画笔操作模式

枚举	取值	描述
Normal	0	普通模式
SelectMode	1	选择模式
ShapeMode	2	画笔模式
EraserMode	3	橡皮擦模式
DocumentTouchMode	4	文档控制模式

BrtmDocumentType

文档类型

枚举	取值	描述
Static	0	静态文档
Animated	1	动态文档

BrtmShapeType

画笔类型

枚举	取值	描述
StraightLine	0	直线
Arrow	1	单箭头
DoubleArrow	2	双箭头
Rect	3	矩形
Oval	4	椭圆
IsoscelesTriangle	5	等腰三角形
RightTriangle	6	直角三角形
RectSolid	7	实心矩形
OvalSolid	8	实心椭圆
IsoscelesTriangleSold	9	等腰实心三角形
RightTriangleSolid	10	实心直角三角形
Text	11	文本
Point	12	激光笔
Bitmap	13	位图
Doodle	14	涂鸦
DottedLine	15	虚线
MarkerDoodle	16	马克笔

BrtmUserInfo

传入的用户信息

变量名	类型	描述
userId	string	用户 userId
role	BrtmUserRole	用户角色
userName	string	用户名称
userAvatar	string	用户头像（链接）

BrtmUser

用户信息

变量名	类型	描述
userId	string	服务器分配的用户 userId
userNumber	string	进入房间时传入的 userId
role	BrtmUserRole	用户角色
userName	string	用户名称
userAvatar	string	用户头像（链接）
endPointType	BrtmEndpointType	终端类型，目前定义了一些常见端类型

BrtmChatMessage

聊天消息

变量名	类型	描述
id	string	聊天消息 id
content	string	消息具体内容
timestamp	number	消息时间戳
isPrivate	boolean	是否私聊消息
fromUser	BrtmUser	消息发送至用户
toUser	BrtmUser	消息发送给用户

PageItem

页面信息

变量名	类型	描述
width	number	页面的宽
height	number	页面的高
url	string	页面的 URL

DocPageInfo

文档页面信息

变量名	类型	描述
totalPages	number	页面的总页数
urlPrefix	string	URL 前缀
isDoc	boolean	是否 doc 文档
isH5Doc	boolean	是否 h5 doc 文档
url	string	URL 信息
width	number	文档的宽
height	number	文档的高
pageIds	array	页面 id 列表

PageChangeInfo

文档页面信息

变量名	类型	描述
docId	string	文档 id
page	number	当前页面 index 信息
step	number	当前页面动画 step 信息
pageId	number	当前页面索引

DocExtraInfo

文档额外信息

变量名	类型	描述
visible	number
scrollTop	string	文档区域当前滑动位置的 top 值
scrollLeft	string	文档区域当前滑动位置的 left 值
page	number	当前页面索引
step	number	当前页面动画 step 信息
x	number	文档 x 坐标值
y	number	文档 y 坐标值
fullscreen	boolean	是否全屏
fitWay	number	内容适配模式
scale	string	缩放比例

DocRemarkInfo

课件备注信息

变量名	类型	描述
remark	string	备注信息
page	number	当前页面索引

BrtmDocumentItem

文档数据信息

变量名	类型	描述
id	string	文档 id
number	string	文档对应 number id
ext	string	文档后缀名字
name	string	文档名字
size	number	文档大小
pptUrl	string	ppt url
pageList	PageItem[]	所有页面信息
pageInfo	DocPageInfo	当前页面信息
extraInfo	DocExtraInfo	文档扩展信息
remarkInfo	DocRemarkInfo[]	课件备注信息
page	number	当前页面索引

BrtmDocAllRes

所有文档数据信息

变量名	类型	描述
docId	string	文档 id
page	number	当前页面索引
step	number	当前页面动画 step 信息
docList	BrtmDocumentItem[]	文档具体列表信息
pageId	number	pageId 信息

{{allComment[version]}} ×

暂无评论
{{comment.author}}

{{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}

{{comment.content}}