互动白板>客户端 API>iOS

iOS

编辑文档 更新于
概况RoomDocumentUserChat对象和枚举BRTMError最佳实践

1 BRTMDocumentDelegate

1.1 BRTMDocumentDelegate

文档和画笔相关的代理回调。

函数列表 描述
didReceiveAllDocuments 收到所有文档的回调
didAddPage 增加一页白板的回调
didDeletePageWithIndex 删除一页白板的回调
didAddDocument 增加ppt文档的回调
didDeleteDocument 删除ppt文档的回调
didUpdateDocument 更新ppt文档的回调
didChangePage 文档翻页的回调
didChangeType 动态和静态ppt之间的切换的回调
roomWillBeginGestureWith 画笔: 触摸事件将要开始的回调
didClearShapesWithDocumentID 某一页画笔清空的回调
didLaserPointMoveToLocation 激光笔移动的回调

1.2 BRTMDocumentDelegate接口函数定义

didReceiveAllDocuments
收到所有文档的回调 

- (void)room:(BRTMRoom *)room didReceiveAllDocuments:(nullable NSArray<BJLDocument *> *)allDocuments currentDocumentID:(NSString *)documentID;

参数

返回

didAddPage
增加一页白板的回调 

- (void)room:(BRTMRoom *)room document:(BJLDocument *)document didAddPage:(NSInteger)pageIndex;

参数

返回

didDeletePageWithIndex
删除一页白板的回调 

- (void)room:(BRTMRoom *)room document:(BJLDocument *)document didDeletePageWithIndex:(NSInteger)pageIndex;

参数

Name Type Description
pageIndex NSInteger 白板id

返回

didAddDocument
增加ppt文档的回调 

- (void)room:(BRTMRoom *)room didAddDocument:(BJLDocument *)document;

参数

返回

didDeleteDocument
删除ppt文档的回调 

- (void)room:(BRTMRoom *)room didDeleteDocument:(BJLDocument *)document;

参数

返回

didUpdateDocument
更新ppt文档的回调 

- (void)room:(BRTMRoom *)room didUpdateDocument:(BJLDocument *)document;

参数

返回

didChangePage
文档翻页的回调 

- (void)room:(BRTMRoom *)room document:(BJLDocument *)document didChangePage:(NSInteger)pageIndex;

参数

返回

didChangeType
动态和静态ppt之间的切换的回调 

- (void)room:(BRTMRoom *)room document:(BJLDocument *)document didChangeType:(BJLPPTViewType)type;

参数

Name Type Description
type BJLPPTViewType 动态/静态课件的类型

返回

roomWillBeginGestureWith
画笔: 触摸事件将要开始的回调 

- (void)roomWillBeginGestureWith:(BRTMRoom *)room;

参数

返回

didClearShapesWithDocumentID
双击回调 

- (void)room:(BRTMRoom *)room didClearShapesWithDocumentID:(NSString *)documentID pageID:(NSUInteger)pageID userNumber:(nullable NSString *)userNumber;

参数

返回

didLaserPointMoveToLocation
激光笔移动的回调 

- (void)room:(BRTMRoom *)room didLaserPointMoveToLocation:(CGPoint)location documentID:(NSString *)documentID pageID:(NSUInteger)pageID;

参数

返回

2 BJLSlideshowUI

2.1 BJLSlideshowUI函数

函数列表 描述
initWithDocument 通过课件数据初始化视图
initWithDocument 使用文档初始化
updateDocuments 更新课件数据
updateDocument 更新当前页面课件
updatePreview 是否是预览课件
updateMaxSlidePage 设置当前允许翻到的最大页码
updateSyncPageChange 是否需要同步控制直播间内页码
updateDisableOverMaxPage 否禁止超过翻页超过最大页码，默认 YES
updateScrollEnabled 设置最大可翻页码数
updatePageIndex 设置当前页码
pageStepForward 向前翻页
pageStepBackward 向后翻页
updateShowPPTRemarkInfo 是否显示课件备注
clearDrawing 清除当前画布上所有画笔
updateUseOriginalImage 是否加载课件原图
updateContentMode 静态课件显示模式
updateScaleEnabled 静态课件是否支持缩放
updateWebPPTInteractable 动态课件交互状态
updateEnableWebPPTChangePage 是否允许在可以滑动翻页时翻页动态课

2.2 JLSlideshowUI函数定义

2.2.1 初始化

initWithDocument
通过课件数据初始化视图

  • 参数为空时，需要通过 updateDocuments: 更新课件数据
  • 参数不为空时，视图固定为该课件的视图，无法通过 updateDocuments 更新视图内容
- (instancetype)initWithDocument:(nullable BJLDocument *)document;

参数

Name Type Description
document BJLDocument * 课件，类型为 BJLDocument

返回

  • instancetype

initWithDocument
通过课件数据初始化视图 

- (instancetype)initWithDocument:(nullable BJLDocument *)document isPlayback:(BOOL)isPlayback;

参数

Name Type Description
document BJLDocument * 课件，类型为 BJLDocument
isPlayback BOOL 是否为回放

返回

  • instancetype

updateDocuments
更新课件数据 

- (void)updateDocuments:(nullable NSArray<BJLDocument *> *)allDocuments;

参数

Name Type Description
allDocuments NSArray * 视图需要处理的全部课件数据

返回

updateDocument
更新当前页面课件 

- (void)updateDocument:(nullable BJLDocument *)document;

参数

Name Type Description
document BJLDocument * 更新当前页面课件

返回

updatePreview
是否是预览课件

  • 默认 NO，作为预览课件时任何数据将不会同步，也没有任何翻页的限制
- (void)updatePreview:(BOOL)isPreview;

参数

Name Type Description
isPreview BOOL 是否是预览课件，默认 NO

返回

2.2.2 显示页面控制

updateMaxSlidePage
设置当前允许翻到的最大页码

  • 在未主动翻页前作为当前页码，在 disableOverMaxPage 为 YES 时，否则仅作为当前的页码使用
- (void)updateMaxSlidePage:(BJLSlidePage *)slidePage;

参数

Name Type Description
slidePage BJLSlidePage 最大页码

返回

updateSyncPageChange
是否需要同步控制直播间内页码 

- (void)updateSyncPageChange:(BOOL)syncPageChange;

参数

Name Type Description
syncPageChange BOOL 默认为 NO，设置为 YES 时，本地的翻页等操作都会同步给直播间内其他用户

返回

updateDisableOverMaxPage
是否禁止超过翻页超过最大页码 

- (void)updateDisableOverMaxPage:(BOOL)disableOverMaxPage;

参数

Name Type Description
disableOverMaxPage BOOL 默认 YES

返回

updateScrollEnabled
当前课件是否支持滑动翻页，默认可滑动

  • 开启画笔或者动态课件可交互的情况下，仍然不能滑动翻页
- (void)updateScrollEnabled:(BOOL)scrollEnabled;

参数

Name Type Description
scrollEnabled BOOL 默认 YES

返回

updatePageIndex
设置当前页码

  • 不能滑动翻页时，参考 scrollEnabled，设置 pageIndex 无效
- (nullable BJLError *)updatePageIndex:(NSInteger)pageIndex;

参数

Name Type Description
pageIndex NSInteger 设置的当前页码

返回

  • BJLError

pageStepForward
向前翻页 

- (nullable BJLError *)pageStepForward;

参数

Name Type Description
pageIndex NSInteger 设置的当前页码

返回

  • BJLError

updateShowPPTRemarkInfo
是否显示课件备注，默认显示 

- (void)updateShowPPTRemarkInfo:(BOOL)show;

参数

Name Type Description
show BOOL

返回

clearDrawing
清除当前画布上所有画笔 

- (void)clearDrawing;

参数

返回

updateUseOriginalImage
是否加载课件原图

  • 默认不加载原图，设置后改变 imageSize 无效
- (void)updateUseOriginalImage:(BOOL)useOriginalImage;

参数

Name Type Description
useOriginalImage BOOL 是否加载课件原图

返回

updateContentMode
静态课件显示模式

  • 每次动态和静态课件切换时都会重置成 BJLContentMode_scaleAspectFit 完整显示
- (void)updateContentMode:(BJLContentMode)contentMode;

参数

Name Type Description
contentMode BJLContentMode 显示模式

返回

updateScaleEnabled
静态课件是否支持缩放

  • 默认支持缩放
- (void)updateScaleEnabled:(BOOL)scaleEnabled;

参数

Name Type Description
scaleEnabled BOOL 是否支持缩放

返回

updateWebPPTInteractable
动态课件交互状态，默认不可交互

  • 不能滑动翻页时，参考 scrollEnabled，也无法交互
- (void)updateWebPPTInteractable:(BOOL)interactable;

参数

Name Type Description
interactable BOOL 是否交互状态

返回

updateEnableWebPPTChangePage
是否允许在可以滑动翻页时翻页动态课件，默认可以

  • 设置为 NO 时，只能操作课件中动效，不能滑动翻页
  • 即使设置为 NO，如果课件中的动效会触发翻页，也将会成功翻页
- (void)updateEnableWebPPTChangePage:(BOOL)enableWebPPTChangePage;

参数

Name Type Description
enableWebPPTChangePage BOOL 是否可以翻页

返回

3 BRTMDocumentManager

3.1 BRTMDocumentManager类成员变量

delegate
文档和画笔相关的代理 

@property (nonatomic, weak) id <BRTMDocumentDelegate> documentDelegate;

allDocuments
所有课件

  • allDocuments发生变化会回调 'BRTMDocumentDelegate' 的 'allDocumentsDidOverwrite'
@property (nonatomic, readonly, copy, nullable) NSArray<BJLDocument *> *allDocuments;

brushOperateMode
画笔操作模式 

@property (nonatomic, readonly) BJLBrushOperateMode brushOperateMode;

shapeType
画笔类型 

@property (nonatomic) BJLDrawingShapeType shapeType;

strokeColor
画笔边框颜色 

@property (nonatomic, nonnull) NSString *strokeColor;

strokeAlpha
画笔边框颜色透明度，取值范围 0~1 

@property (nonatomic) CGFloat strokeAlpha;

fillColor
画笔填充颜色 

@property (nonatomic, nullable) NSString *fillColor;

fillAlpha
画笔填充颜色透明度，取值范围 0~1, fillColor 不为空时有效 

@property (nonatomic) CGFloat fillAlpha;

doodleStrokeWidth
画笔线宽 

@property (nonatomic) CGFloat doodleStrokeWidth;

textFontSize
文字画笔字体大小, 范围 [0.0001, 1.0], 默认值0.02

  • 渲染文字时的 字体 为 textFontSize * 画布宽度
@property (nonatomic) CGFloat textFontSize;

textBold
文字画笔是否加粗 

@property (nonatomic) BOOL textBold;

textItalic
文字画笔是否为斜体 

@property (nonatomic) BOOL textItalic;

paintEnabled
画笔开关状态，参考 updatePaintEnabled: 

@property (nonatomic, readonly) BOOL paintEnabled;

isDottedLine
画笔是否虚线 

@property (nonatomic) BOOL isDottedLine;

showShapeAuthorNameWhenSelected
选中画笔时是否显示归属信息 

@property (nonatomic) BOOL showShapeAuthorNameWhenSelected;

hasSelectedShape
是否有选中的画笔 

@property (nonatomic) BOOL hasSelectedShape;

3.2 BRTMDocumentManager类函数

函数列表 描述
requestTurnToDocumentID 翻页课件
addDocument 增加文档
deleteDocumentWithID 删除文档
addPageToDocument 增加一页白板
deletePageIndex 删除一页白板
documentWithID 通过documentID获取document
setWhiteboardBackgroundImageUrl 给白板设置背景图片
uploadImageFile 上传图片，用于添加课件
uploadFile 上传文档
requestTranscodingProgressWithFileIDList 文档转码进度查询
requestDocumentListWithFileIDList 获取文档转码后的新的文档
requestCompleteRemarkInfoWithDocumentID 获取文档备注信息
updatePaintEnabled 开启、关闭画笔
updateBrushOperateMode 更新画笔操作模式
clearShapesWithDocumentID 添加图片画笔
updateLaserPointImage 改变内部实现的激光笔的图片
customLaserPonitUI 自定义激光笔
moveLaserPointToLocation 激光笔位置移动请求

3.3 BRTMDocumentManager类函数定义

requestTurnToDocumentID
翻页课件

  • 成功会回调 'BRTMDocumentDelegate' 的 'didPageChange'
- (nullable BRTMError *)requestTurnToDocumentID:(NSString *)documentID pageIndex:(NSInteger)pageIndex;

参数

Name Type Description
documentID NSString * 文件路径
pageIndex NSInteger 目标页在课件中的序号, 即页码

返回

addDocument
增加文档

  • 成功将回调 'BRTMDocumentDelegate' 的 'didAddDocument'
- (nullable BRTMError *)addDocument:(BJLDocument *)document;

参数

Name Type Description
document BJLDocument * document

返回

deleteDocumentWithID
删除文档 

- (nullable BRTMError *)deleteDocumentWithID:(NSString *)documentID;

参数

Name Type Description
documentID NSString * documentID description

返回

addPageToDocument
增加一页白板,只有白板的document才有效

  • 成功将回调 'BRTMDocumentDelegate' 的 'didDeleteWhiteboardPageWithIndex'
  • 限制每 0.5s 只能调用一次
- (nullable BRTMError *)addPageToDocument:(BJLDocument *)document;

参数

Name Type Description
pageIndex NSInteger 白板页码
document BJLDocument * 文档object

返回

documentWithID
通过documentID获取document 

- (nullable BJLDocument *)documentWithID:(NSString *)documentID;

参数

Name Type Description
documentID NSString * 文档id

返回

  • BJLDocument *: 文档object

setWhiteboardBackgroundImageUrl
设置白板背景图 

- (void)setWhiteboardBackgroundImageUrl:(NSString *)imageUrl;

参数

Name Type Description
imageUrl NSString * 背景图片URL链接

返回

documentViewControllerWithID
指定文档 ID 创建对应的视图控制器 

- (UIViewController<BJLSlideshowUI> *)documentViewControllerWithID:(NSString *)documentID;

参数

Name Type Description
documentID NSString * 指定的documentID

返回

  • UIViewController *: 创建的视图控制器

uploadImageFile
上传图片，用于添加课件 

- (NSURLSessionUploadTask *)uploadImageFile:(NSURL *)fileURL
     progress:(nullable void (^)(CGFloat progress))progress
    finish:(void (^)(BJLDocument * _Nullable document, 
    BRTMError * _Nullable error))finish;

参数

Name Type Description
fileURL NSURL * 图片文件路径
progress nullable void (^)(CGFloat progress) 上传进度，非主线程回调、可能过于频繁, 0.0 ~ 1.0
finish void (^)(BJLDocument _Nullable document, BRTMError _Nullable error 结束回调：document: 非 nil 即为成功，用于 addDocument: ; error: 错误

返回

  • NSURLSessionUploadTask *

uploadFile
上传文档 

- (NSURLSessionUploadTask *)uploadFile:(NSURL *)fileURL
                              mimeType:(NSString *)mimeType
                              fileName:(NSString *)fileName
                            isAnimated:(BOOL)isAnimated
                              progress:(nullable void (^)(CGFloat progress))progress
                                finish:(void (^)(BJLDocument * _Nullable document, BRTMError * _Nullable error))finish;

参数

Name Type Description
fileURL NSURL * 文档路径
mimeType NSString * 文档类型
fileName NSString * 文件名
isAnimated BOOL 是否有动画
progress nullable void (^)(CGFloat progress) 进度 0.0 ~ 1.0
finish void (^)(BJLDocument _Nullable document, BRTMError _Nullable error) 结束回调

返回

  • NSURLSessionUploadTask *

requestTranscodingProgressWithFileIDList
文档转码进度查询

  • 可以通过这个接口查询文档转码进度, 转码完成后，需要去获取转码后的新的文档
- (nullable NSURLSessionDataTask *)requestTranscodingProgressWithFileIDList: 
     (NSArray<NSString *> *)fileIDList
     completion:(nullable void (^)(NSArray<BJLDocumentTranscodeModel *> * _Nullable transcodeModelArray, BRTMError * _Nullable error))completion;

参数

Name Type Description
fileIDList NSArray * file ID 数组
completion nullable void (^)(NSArray _Nullable transcodeModelArray, BRTMError _Nullable error transcodeArray

返回

  • NSURLSessionUploadTask

requestDocumentListWithFileIDList
获取文档转码后的新的文档 

- (nullable NSURLSessionDataTask *)requestDocumentListWithFileIDList:
   (NSArray<NSString *> *)fileIDList
   completion:(nullable void (^)(NSArray<BJLDocument *> * _Nullable documentArray, BRTMError * _Nullable error))completion;

参数

Name Type Description
fileIDList NSArray * file ID 数组
completion nullable void (^)(NSArray _Nullable transcodeModelArray, BRTMError _Nullable error transcodeArray

返回

  • NSURLSessionUploadTask *

requestCompleteRemarkInfoWithDocumentID
获取文档备注信息 

- (nullable NSURLSessionDataTask *)requestCompleteRemarkInfoWithDocumentID:(NSString *)documentID
 completion:(void (^)(NSDictionary * _Nullable remarkInfo, BRTMError * _Nullable error))completion;

参数

Name Type Description
documentID NSString * 文档ID
completion void (^)(NSDictionary _Nullable remarkInfo, BRTMError _Nullable error) 返回 remarkInfo 备注信息

返回

  • NSURLSessionUploadTask *

updatePaintEnabled
开启、关闭画笔

  • 开启画笔时，单文档实例情况下如果本地页数与服务端页数不同步则无法绘制
- (nullable BRTMError *)updatePaintEnabled:(BOOL)paintEnabled;

参数

Name Type Description
paintEnabled BOOL ES：开启，NO：关闭

返回

  • BRTMError *

updateBrushOperateMode
更新画笔操作模式 

- (nullable BRTMError *)updateBrushOperateMode:(BJLBrushOperateMode)operateMode;

参数

Name Type Description
operateMode BJLBrushOperateMode 操作模式

返回

  • BRTMError *
  • BRTMErrorCode_invalidCalling paintEnabled 是 NO

clearShapesWithDocumentID
清除某一页的所有画笔 

- (nullable BRTMError *)clearShapesWithDocumentID:(NSString *)documentID
                                    pageIndex:(NSUInteger)pageIndex
                                    userID:(nullable NSString *userID;

参数

Name Type Description
documentID NSString * 文档 ID
pageIndex NSUInteger 当前页的id
userID NSString * user ID

返回

  • BRTMError *

updateLaserPointImage
改变内部实现的激光笔的图片 

- (void)updateLaserPointImage:(UIImage *)image;

参数

Name Type Description
image UIImage *

返回

customLaserPonitUI
自定义激光笔

  • 默认使用内部实现的激光笔，如果调用这个方法，则需要外部实现接收激光笔点的ui
- (void)customLaserPonitUI;

参数

返回

moveLaserPointToLocation
改变内部实现的激光笔的图片

  • 自定义激光笔时调用
- (nullable BRTMError *)moveLaserPointToLocation:(CGPoint)location
                documentID:(nonnull NSString *)documentID
                pageIndex:(NSUInteger)pageIndex;

参数

Name Type Description
location CGPoint 激光笔目标位置
documentID NSString * 文档ID
pageIndex NSUInteger 页码

返回

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