ClientOptions创建 client 配置项
JoinConfigclient join 调用参数
RoleBRTM 用户角色
UserInfouser 可选配置项
BroadcastMessageOptions广播消息配置项
UploadDoc文档上传后后台返回的 doc 数据
pageInfo文档页的配置信息
WhiteboardImageConfig自定义白板配置
Page文档 Page 接口
DocDoc 接口
extra文档扩展数据
PPTEventppt 事件定义
DocumentPlayerOptions文档播放器配置项
1
onLoadingStart: (this: DocumentPlayer, page: number, step: number, pageChanged: boolean) => void;
onLoadingEnd: (this: DocumentPlayer, page: number, step: number, pageChanged: boolean, status: DocPlayerLoadingEndStatus) => void;
onPageChange: (this: DocumentPlayer, page: number, step: number) => void;
onStepChange: (this: DocumentPlayer, page: number, step: number) => void;
onPageCountChange: (this: DocumentPlayer, totalPage: number) => void;
getImageDimension: (this: DocumentPlayer, width: number, height: number) => {width: number;height: number;};
compressImage: (url: string, width: number, height: number, quality: number, ratio: number, hasWebp: boolean, watermark: WaterMark) => string;
onUrlChange: (this: DocumentPlayer, url: DocImageUrl, width: number, height: number, pageChanged: boolean, sourcePage: Page, backups?: DocImageUrl[]) => void;
<Text>
createTextarea: (text: Text) => Promise<Text>;
urlPreload: (this: DocumentPlayer, url: DocImageUrl, backups?: DocImageUrl[]) => void;
Laser激光笔坐标数据
ProgressType文档上传进度
ChatMessageData聊天发送接口
ChannelMessage聊天数据接口
EmitterOptions事件订阅选项
DocUploaderOptions文档上传器配置项
Type declaration:
onprogress(): function (this: DocUploader, file: File | WXFile, type: ProgressType, progress: number): void
FileExtra文档上传过程中写入的数据
FileOptions文档上传配置项
ToStaticOptions静态文件配置项
Error Code错误码
Web
ClientOptions
创建 client 配置项
JoinConfig
client join 调用参数
Role
BRTM 用户角色
UserInfo
user 可选配置项
BroadcastMessageOptions
广播消息配置项
true: 所有人可收到消息
false: 只有 root 和 admin 的用户可以收到
UploadDoc
文档上传后后台返回的 doc 数据
pageInfo
文档页的配置信息
WhiteboardImageConfig
自定义白板配置
Page
文档 Page 接口
Doc
Doc 接口
extra
文档扩展数据
PPTEvent
ppt 事件定义
DocumentPlayerOptions
文档播放器配置项
不开启无法获取画笔快照，但性能较优
若不需要保存画笔数据，请保持不开启
默认不开启
取值范围 [2, 20]
默认 5
取值范围 [0.1, 1]<br.>默认
1最高质量page 当前 page
step 当前 step
pageChanged 页码是否变化
onLoadingStart: (this: DocumentPlayer, page: number, step: number, pageChanged: boolean) => void;page 当前 page
step 当前 step
status 状态
pageChanged 页码是否变化
onLoadingEnd: (this: DocumentPlayer, page: number, step: number, pageChanged: boolean, status: DocPlayerLoadingEndStatus) => void;page 当前 page
step 当前 step
onPageChange: (this: DocumentPlayer, page: number, step: number) => void;page 当前 page
step 当前 step
onStepChange: (this: DocumentPlayer, page: number, step: number) => void;totalPage 总页数
onPageCountChange: (this: DocumentPlayer, totalPage: number) => void;width 图片原始宽度
height 图片原始高度
getImageDimension: (this: DocumentPlayer, width: number, height: number) => {width: number;height: number;};url 图片原始 url 地址
width 图片显示宽度
height 图片显示高度
quality 图片显示质量
ratio 倍数
hasWebp 是否有 webp 格式
watermark 水印配置
compressImage: (url: string, width: number, height: number, quality: number, ratio: number, hasWebp: boolean, watermark: WaterMark) => string;url cdn 地址
width 宽度
height 高度
backupCDN 备份 cdn 地址
source 图片源地址
onUrlChange: (this: DocumentPlayer, url: DocImageUrl, width: number, height: number, pageChanged: boolean, sourcePage: Page, backups?: DocImageUrl[]) => void;<Text>createTextarea: (text: Text) => Promise<Text>;urlPreload: (this: DocumentPlayer, url: DocImageUrl, backups?: DocImageUrl[]) => void;默认 false 不开启
默认 false 不开启
Laser
激光笔坐标数据
ProgressType
文档上传进度
ChatMessageData
聊天发送接口
key: string
type: string
url: string
height?: number
width?: number
ChannelMessage
聊天数据接口
key: string;
type: string; // 自定义消息类型
url: string; // 图片 url
width?: number; //图片宽度
height?: number; //图片高度
content: string; //消息内容
data:{ //图片和表情数据
key: string;
type: string; //自定义消息类型
url: string; //图片 url
width?: number; //图片宽度
height?: number;//图片高度
from?: BRTMUser;//发送 user
}
EmitterOptions
事件订阅选项
DocUploaderOptions
文档上传器配置项
Type declaration:
FileExtra
文档上传过程中写入的数据
FileOptions
文档上传配置项
ToStaticOptions
静态文件配置项
EmitterOptions
事件订阅选项
Error Code
错误码