互动白板>客户端 API>Android

Android

编辑文档 更新于
概况房间文档与白板用户聊天对象和枚举错误码最佳实践

本页包含 IBRTMDocument、IBRTMDocumentListener 以及IBRTMDocumentManager 三大部分的接口/回调说明。涵盖了关于文档共享、白板相关的各种操作以及相关事件回调监听。

IBRTMDocumentListener

函数列表 描述
onDocumentServiceEnable 文档服务可用状态变化通知
onWhiteboardPageAdded 添加白板回调
onWhiteboardPageDeleted 删除白板回调
onAllDocumentsReceived 获取文档缓存回调
onDocumentAdded 添加文档回调
onDocumentDeleted 删除文档回调
onDocumentUpdated 更新文档回调
onPageSelected 翻页完成回调
onDocumentListChanged 文档集合发送改变
onSingleTapConfirmed 在页面上单击的事件回调通知
onDoubleTapConfirmed 在页面上双击的事件回调通知
onDoubleTapOnShape 在选取模式下双击文字的事件回调通知

onDocumentServiceEnable

文档服务可用状态变化通知

void onDocumentServiceEnable(boolean enable, String userId)

参数

Name Type Description
enable 布尔 文档服务是否可用，true 表示可用，false 表示不可用
userId 字符串 触发文档服务状态变更的用户 ID

返回
无

onWhiteboardPageAdded

新增一页白板的回调通知 

void onWhiteboardPageAdded()

参数
无

返回
无

onWhiteboardPageDeleted

删除一页白板的回调通知 

void onWhiteboardPageDeleted()

参数
无

返回
无

onAllDocumentsReceived

所有文档缓存数据的回调通知 

void onAllDocumentsReceived(BRTMResRoomDocAllModel docAllModel)

参数

Name Type Description
docAllModel BRTMResRoomDocAllModel 所有文档信息

返回
无

onDocumentAdded

文档添加的回调通知 

void onDocumentAdded(BRTMResRoomDocAddModel docAddModel)

参数

Name Type Description
docAddModel BRTMResRoomDocAddModel 添加的文档信息

返回
无

onDocumentDeleted

删除文档的回调通知 

void onDocumentDeleted(BRTMResRoomDocDelModel docDelModel)

参数

Name Type Description
docDelModel BRTMResRoomDocDelModel 删除的文档信息

返回
无

onDocumentUpdated

更新文档的回调通知 

void onDocumentUpdated(BRTMResRoomDocUpdateModel docUpdateModel)

参数

Name Type Description
docUpdateModell BRTMResRoomDocUpdateModel 更新的文档信息

返回
无

onPageSelected

页码变更完成的回调通知 

void onPageSelected(BRTMResRoomPageChangeModel pageChangeModel)

参数

Name Type Description
pageChangeModel BRTMResRoomPageChangeModel 页码信息

返回
无

onDocumentListChanged

文档内容（通常是页面数量）发生变化的回调通知 

void onDocumentListChanged(String docId)

参数

Name Type Description
docId String 发生改变的文档id

返回
无

onSingleTapConfirmed

在页面上单击的事件回调通知

void onSingleTapConfirmed();

参数
无

返回
无

onDoubleTapConfirmed

在页面上双击的事件回调通知 

void onDoubleTapConfirmed()

参数
无

返回
无

onDoubleTapOnShape

在选取模式下，在文字图形单元上双击的事件回调通知 

void onDoubleTapOnShape()

参数
无

返回
无

说明
此事件仅在BRTMConstants.ShapeOperateMode.SelectMode模式下会触发，可以使用 IBRTMDocument.setShapeOperateMode()方法接口来设置不同的模式。

IBRTMDocument

函数列表 描述
init 初始化 BRTMDocument 实例
setActivated 设置当前文档为激活选择状态
enableLaserShape 是否启用内置激光笔画笔
addPageToDocument 给指定的文档添加一页白板
deletePageFromDocument 删除一页白板
goToPage 翻页
pageStepForward 向前翻页
pageStepBackward 向后翻页
setShapeOperateMode 设置编辑模式
getCurrentPageIndex 获取当前页码
getTotalPage 获取总页码数
getView 获取当前文档视图
getDocumentId 获取当前文档编号
setAnimatedDocumentEnable 设置是否显示文档动效
setMaxPage 设置最大可翻页码数
setPageChangeInSync 设置是否同步翻页，默认为同步
setUserScrollEnable 设置是否支持手势滑动（仅静态文档）
setZoomEnable 设置是否支持缩放（仅静态文档）
getDocumentType 获取当前文档的类型（静态文档/动态文档）
setShapeType 设置最大可翻页码数
getShapeType 获取当前画笔类型
setPaintColor 设置画笔颜色
setPaintTextSize 设置文字画笔字体大小
setPaintTextBold 设置文字画笔是否加粗
setPaintTextItalic 设置文字画笔是否斜体
sendText 发送文字画笔内容
sendTextComplete 文字画笔发送完成，通知视图刷新
setShowShapeAuthor 设置画笔被选中是否显示画笔作者名字
setShapeStrokeWidth 设置画笔线宽
clearSelectedShapes 清除选中画笔
clearAllShapes 清除全部画笔
getScreenshotOfAllShape 返回带有所有画笔的bitmap
destroy 销毁实例

init

初始化 BRTMDocument 实例 

void init(String docId)

参数

Name Type Description
docId String 此文档的 id

返回

无

说明

  • 如果传入的 docId 是 null 或者空值，此方法将直接返回，您将获得一个无法工作的 BRTMDocument 对象
  • 如果传入的 docId 不存在，则默认会以白板进行初始化

setActivated

设置当前文档为激活选择状态

void setActivated()

参数

无

说明

当存在多个共享文档时，可以通过调用此方法来通知内部将某个文档标记为激活选择状态，便于进行识别。

enableLaserShape

是否启用内置激光笔画笔
若关闭内置激光笔，则不会自动显示激光笔。需要在IBRTMShapeListener#onShapeLaser(BRTMResRoomShapeSingleModel)中获取数据来自行实现激光笔显示

void enableLaserShape(boolean enable)

参数

Name Type Description
enable boolean 启用则为true，默认为true

返回

无

addPageToDocument

给指定的文档添加一页白板 

BRTMError addPageToDocument(String docId);

参数

Name Type Description
docId String 白板 ID：BRTMConstants.WHITEBOARD_DOC_ID

返回

BRTMError

deletePageFromDocument

删除一页白板 

BRTMError deletePageFromDocument(String docId, int pageId)

参数

Name Type Description
docId String 白板 ID：BRTMConstants.WHITEBOARD_DOC_ID
pageId int 白板页id

返回

BRTMError

goToPage

翻页 

BRTMError goToPage(int index)

参数

Name Type Description
index int 当前文档下标

返回

BRTMError

pageStepForward

向前翻页 

BRTMError pageStepForward()

参数

无

返回

BRTMError

pageStepBackward

向后翻页 

BRTMError pageStepBackward()

参数

无

返回

BRTMError

setShapeOperateMode

设置编辑模式 

void setShapeOperateMode(BRTMConstants.ShapeOperateMode shapeOperateMode)

参数

Name Type Description
shapeOperateMode BRTMConstants.ShapeOperateMode 编辑模式

返回

无

getCurrentPageIndex

获取当前页码 

int getCurrentPageIndex()

参数

无

返回

返回当前页码id。如果文档尚未初始化，返回 0

getTotalPage

获取总页码数 

int getTotalPage()

参数

无

返回

返回总页数。如果文档尚未初始化，返回 0

getView

获取当前文档视图 

View getView()

参数
无

返回

静态文档返回的 View 对象类型是 androidx.viewpager2.widget.ViewPage2，动态文档返回的 View 对象类型是 android.widget.FrameLayout。如果文档未能正确初始化，返回 null。

getDocumentId

获取当前文档 ID

String getDocumentId()

参数

无

返回

返回当前的文档 ID

setAnimatedDocumentEnable

设置是否显示文档动效 

void setAnimatedDocumentEnable(boolean animatedEnable)

参数

Name Type Description
animatedEnable boolean true 显示，false 不显示

返回

无

setMaxPage

设置最大可翻页码数 

void setMaxPage(int maxPage)

参数

Name Type Description
maxPage int 最大可翻页码数，小等于设置的页码数都可以翻

返回

无

setPageChangeInSync

设置是否同步翻页，默认为同步 

void setPageChangeInSync(boolean enableSync);

参数

Name Type Description
enableSync boolean 是否同步翻页，true为同步

返回

无

setUserScrollEnable

设置是否支持手势滑动

void setUserScrollEnable(boolean scrollEnable);

参数

Name Type Description
scrollEnable boolean true 表示启用（默认），false 禁用

返回

无

setZoomEnable

设置是否支持使用手势进行缩放

void setZoomEnable(boolean zoomEnable);

参数

Name Type Description
zoomEnable boolean true 表示启用（默认），false 禁用

返回

无

getDocumentType

获取当前文档的类型

BRTMDocumentType getDocumentType();

参数

无

返回

Name Description
BRTMDocumentType.STATIC 静态文档
BRTMDocumentType.ANIMATED 动态文档

setShapeType

设置画笔类型 

void setShapeType(BRTMConstants.ShapeType shapeType)

参数

Name Type Description
shapeType BRTMConstants.ShapeType 画笔类型

返回

无

getShapeType

获取当前画笔类型 

BRTMConstants.ShapeType getShapeType()

参数

无

返回

BRTMConstants.ShapeType

setPaintColor

设置画笔颜色 

void setPaintColor(@ColorInt int color)

参数

Name Type Description
color 通常是一个 ARGB 颜色值，例如 0xFF0077B6 颜色值

返回

无

setPaintTextSize

设置文字画笔字体大小 

void setPaintTextSize(float textSize)

参数

Name Type Description
textSize float 限制 0.0001f 到 1f，字号为 PPT 宽度的 textSize 倍

返回

无

setPaintTextBold

设置文字画笔是否加粗 

void setPaintTextBold(boolean bold)

参数

Name Type Description
bold boolean true为加粗

返回

无

setPaintTextItalic

设置文字画笔是否斜体 

void setPaintTextItalic(boolean italic)

参数

Name Type Description
italic boolean true为斜体

返回

无

sendText

发送文字画笔内容 

void sendText(@Nullable String beforeText, @Nullable String afterText)

参数

Name Type Description
beforeText String 更新之前的文字内容
afterText String 更新之前的文字内容

返回

无

sendTextComplete

文字画笔发送完成，通知视图刷新 

void sendTextComplete()

参数

无

返回

无

setShowShapeAuthor

设置画笔被选中是否显示画笔作者名字 

void setShowShapeAuthor(boolean showShapeAuthor)

参数

Name Type Description
showShapeAuthor boolean true 表示显示，false 表示不显示

返回

无

setShapeStrokeWidth

设置文字画笔字体大小 

void setShapeStrokeWidth(float strokeWidth)

参数

Name Type Description
strokeWidth float 限制 0.0001f 到 1f，画笔字体大小

返回

无

clearSelectedShapes

清除选中画笔 

void clearSelectedShapes()

参数

无

返回

无

clearAllShapes

清除全部画笔 

void clearAllShapes()

参数

无

返回

无

getScreenshotOfAllShape

返回带有所有画笔的bitmap 

@Nullable Bitmap getScreenshotOfAllShape()

参数

无

返回

android.graphics.Bitmap 对象，可能为 null

destroy

销毁实例 

void destroy()

参数

无

返回

无

IBRTMDocumentManager

函数列表 描述
uploadDocument 上传文档并转码
requestDocumentTransferProgress 获取文档转码进度
requestTransferredDocument 请求转码之后的文档信息
requestDocumentDelete 删除指定文档
requestDocumentRemark 设置白板背景图
setWhiteboardBackgroundImageUrl 获取文档转码进度
setWhiteboardAspectRation 设置白板宽高比，默认图片比例
setWhiteboardScaleType 设置白板缩放方式，同 ImageView.ScaleType
getDocumentList 获取指定的文档
setLaserBitmap 设置激光笔样式
destroy 销毁及清理文档管理器内部资源

uploadDocument

上传文档并转码 

BRTMError uploadDocument(String filePath, boolean isAnimated, BJProgressCallback callback)

参数

Name Type Description
filePath boolean 文件路径
isAnimated boolean 是否转码为动效文档
callback BJProgressCallback 上传和转码进度通知回调

返回

BRTMError

requestDocumentTransferProgress

获取文档转码进度 

void requestDocumentTransferProgress(String fid, IBRTMResponseCallback<BRTMDocTranslateProgressModel> translateProgressCallback);

参数

Name Type Description
fid String 指定获取文件进度的id
translateProgressCallback IBRTMResponseCallback 转码进度回调函数变量

返回

BRTMError

requestTransferredDocument

请求转码之后的文档信息 

void requestTransferredDocument(BRTMUploadDocModel uploadDocModel, IBRTMResponseCallback<BRTMDocumentModel> documentPageInfoCallback)

参数

Name Type Description
uploadDocModel BRTMUploadDocModel 上传文档信息
documentPageInfoCallback IBRTMResponseCallback 转码后文档信息回调函数变量

返回

requestDocumentDelete

请求转码之后的文档信息 

void requestDocumentDelete(String docId)

参数

Name Type Description
docId String 文档 ID

返回

无

requestDocumentRemark

请求文档备注 

void requestDocumentRemark(String fid, IBRTMResponseCallback<BRTMRemarkInfoModel> documentRemarkCallback)

参数

Name Type Description
fid String 文档id
documentRemarkCallback IBRTMResponseCallback 文档备注信息回调函数变量

返回

无

setWhiteboardBackgroundImageUrl

设置白板背景图 

void setWhiteboardBackgroundImageUrl(String backgroundImageUrl)

参数

Name Type Description
backgroundImageUrl String 背景图片URL链接

返回

无

setWhiteboardAspectRation

设置白板宽高比，默认图片比例

void setWhiteboardAspectRation(float aspectRation);

参数

Name Type Description
aspectRation float > 0 的宽高比数值。例如 4:3 = 1.3333，16:9 = 1.7778

返回

无

setWhiteboardScaleType

设置白板缩放方式

void setWhiteboardScaleType(ImageView.ScaleType scaleType);

参数

Name Type Description
scaleType android.widget.ImageView.ScaleType Android 系统图片视图的缩放类型定义

返回

无

setLaserBitmap

设置激光笔样式 

void setLaserBitmap(Bitmap laserBitmap)

参数

Name Type Description
laserBitmap Bitmap 激光笔样式图片资源。如果不设置，SDK 内部会自行绘制一个红色光晕圆圈作为默认的激光笔图形。

返回

无

getDocumentList

获取指定文档的所有页内容信息 

List<BRTMDocModel> getDocumentList(@Nullable String docId)

参数

Name Type Description
docId String 指定文档 ID。如果传入 null 或者空值，将返回包含白板页在内的全部文档页内容信息

返回

返回指定的文档所有页的内容信息，每一页文档存储在 BRTMDocModel 对象中。

destroy

销毁及清理文档管理器内部资源

void destroy()

参数

无

返回

无

{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论