TEduBoardDelegate Protocol Reference
Conforms to | NSObject |
Declared in | TEduBoardDef.h |
Tasks
通用事件回调
-
– onTEBError:msg:
required method -
– onTEBWarning:msg:
required method
基本流程回调
-
– onTEBInit
required method -
– onTEBHistroyDataSyncCompleted
required method -
– onTEBSyncData:
-
– onTEBUndoStatusChanged:
-
– onTEBRedoStatusChanged:
涂鸦功能回调
-
– onTEBImageStatusChanged:url:status:
-
– onTEBSetBackgroundImage:
-
– onTEBAddImageElement:
-
– onTEBAddElement:url:type:
-
– onTEBRemoveElement:
-
– onTEBBackgroundH5StatusChanged:url:status:
白板操作回调
-
– onTEBAddBoard:fileId:
-
– onTEBDeleteBoard:fileId:
-
– onTEBGotoBoard:fileId:
-
– onTEBGotoStep:totalStep:
-
– onTEBRectSelected
-
– onTEBRefresh
-
– onTEBSnapshot:errorCode:errorMsg:
文件操作回调
-
– onTEBAddTranscodeFile:
-
– onTEBDeleteFile:
-
– onTEBSwitchFile:
-
– onTEBFileUploadProgress:currentBytes:totalBytes:uploadSpeed:percent:
-
– onTEBFileUploadStatus:status:errorCode:errorMsg:
-
– onTEBH5FileStatusChanged:status:
-
– onTEBVideoStatusChanged:status:progress:duration:
-
– onTEBAudioStatusChanged:status:progress:duration:
-
– onTEBAddImagesFile:
-
– onTEBH5PPTStatusChanged:status:message:
-
– onTEBTextElementStatusChanged:status:value:left:top:
-
– onTEBImageElementStatusChanged:url:elementId:
-
– onTEBTextElemenWarning:msg:
-
– onTEBSelectedElements:
-
– onTEBElementsPositonChanged:
-
– onTEBMathGraphEvent:boardId:graphId:message:
-
– onTEBZoomDragStatus:scale:xOffset:yOffset:
-
– onTEBOfflineWarning:
-
– onTEBGroupStatusChanged:groupId:operationType:message:
-
– onTEBBoardScrollChanged:trigger:scrollLeft:scrollTop:scale:
-
– onTEBBoardScaleChanged:scale:
-
– onTEBBoardCursorPosition:
Instance Methods
onTEBAddBoard:fileId:
增加白板页回调
- (void)onTEBAddBoard:(NSArray *)boardIds fileId:(NSString *)fileId
Parameters
- boardIds
增加的白板页 ID 列表(使用后不需要自行调用 Release 方法释放,SDK 内部自动释放)
- fileId
增加的白板页所属的文件 ID(目前版本只可能为#DEFAULT)
Declared In
TEduBoardDef.h
onTEBAddElement:url:type:
添加元素回调
- (void)onTEBAddElement:(NSString *)elementId url:(NSString *)url type:(TEduBoardElementType)type
Parameters
- elementId
调用 addElement 时返回的元素 ID
- url
调用 addElement 时传入的 url
- type
-
只有本地调用 addElement 时会收到该回调 收到该回调表示元素添加成功,并且显示出来
Declared In
TEduBoardDef.h
onTEBAddImageElement:
添加图片元素回调
- (void)onTEBAddImageElement:(NSString *)url
Parameters
- url
调用 addImageElement 时传入的 URL
只有本地调用 addImageElement 时会收到该回调 收到该回调表示背景图片已经上传或下载成功,并且显示出来
Declared In
TEduBoardDef.h
onTEBAddImagesFile:
增加批量图片文件回调
- (void)onTEBAddImagesFile:(NSString *)fileId
Parameters
- fileId
增加的文件 ID
文件加载完成后会触发该回调
Declared In
TEduBoardDef.h
onTEBAddTranscodeFile:
增加转码文件回调
- (void)onTEBAddTranscodeFile:(NSString *)fileId
Parameters
- fileId
增加的文件 ID
文件加载完成后才会触发该回调
Declared In
TEduBoardDef.h
onTEBAudioStatusChanged:status:progress:duration:
音频文件状态回调
- (void)onTEBAudioStatusChanged:(NSString *)elementId status:(TEduBoardAudioStatus)status progress:(CGFloat)progress duration:(CGFloat)duration
Parameters
- elementId
元素 ID
- status
文件状态
- progress
当前进度(秒)
- duration
总时长(秒)
Declared In
TEduBoardDef.h
onTEBBackgroundH5StatusChanged:url:status:
设置白板背景 H5 状态改变回调
- (void)onTEBBackgroundH5StatusChanged:(NSString *)boardId url:(NSString *)url status:(TEduBoardBackgroundH5Status)status
Parameters
- boardId
白板 ID
- url
白板图片 URL
- status
新的白板图片状态
Declared In
TEduBoardDef.h
onTEBBoardCursorPosition:
自定义鼠标样式时,坐标位置回调
- (void)onTEBBoardCursorPosition:(CGPoint)position
Parameters
- position
鼠标坐标位置
Declared In
TEduBoardDef.h
onTEBBoardScaleChanged:scale:
白板缩放回调
- (void)onTEBBoardScaleChanged:(NSString *)boardId scale:(double)scale
Parameters
- boardId
分组模式状态
- scale
白板缩放比
Declared In
TEduBoardDef.h
onTEBBoardScrollChanged:trigger:scrollLeft:scrollTop:scale:
白板移动回调
- (void)onTEBBoardScrollChanged:(NSString *)boardId trigger:(NSInteger)trigger scrollLeft:(double)scrollLeft scrollTop:(double)scrollTop scale:(double)scale
Parameters
- boardId
分组模式状态
- trigger
事件触发来源
- scrollLeft
左侧滚动百分比距离
- scrollTop
顶部滚动百分比距离
- scale
白板缩放比
Declared In
TEduBoardDef.h
onTEBDeleteBoard:fileId:
删除白板页回调
- (void)onTEBDeleteBoard:(NSArray *)boardIds fileId:(NSString *)fileId
Parameters
- boardIds
删除的白板页 ID(使用后不需要自行调用 Release 方法释放,SDK 内部自动释放)
- fileId
删除的白板页所属的文件 ID(目前版本只可能为#DEFAULT)
Declared In
TEduBoardDef.h
onTEBDeleteFile:
删除文件回调
- (void)onTEBDeleteFile:(NSString *)fileId
Parameters
- fileId
删除的文件 ID
Declared In
TEduBoardDef.h
onTEBElementsPositonChanged:
元素位置发生改变回调
- (void)onTEBElementsPositonChanged:(NSArray<TEduBoardElementInfo*> *)elements
Parameters
- elements
位置发生变化的元素数组
Declared In
TEduBoardDef.h
onTEBError:msg:
白板错误回调
- (void)onTEBError:(TEduBoardErrorCode)code msg:(NSString *)msg
See Also
Declared In
TEduBoardDef.h
onTEBFileUploadProgress:currentBytes:totalBytes:uploadSpeed:percent:
文件上传进度回调
- (void)onTEBFileUploadProgress:(NSString *)path currentBytes:(int)currentBytes totalBytes:(int)totalBytes uploadSpeed:(int)uploadSpeed percent:(float)percent
Parameters
- path
正在上传的文件路径
- currentBytes
当前已上传大小,单位 bytes
- totalBytes
文件总大小,单位 bytes
- uploadSpeed
文件上传速度,单位 bytes
- percent
文件上传进度,取值范围 [0, 1]
Declared In
TEduBoardDef.h
onTEBFileUploadStatus:status:errorCode:errorMsg:
文件上传状态回调
- (void)onTEBFileUploadStatus:(NSString *)path status:(TEduBoardUploadStatus)status errorCode:(int)errorCode errorMsg:(NSString *)errorMsg
Parameters
- path
正在上传的文件路径
- status
文件上传状态
- errorCode
文件上传错误码
- errorMsg
文件上传错误信息
Declared In
TEduBoardDef.h
onTEBGotoBoard:fileId:
跳转白板页回调
- (void)onTEBGotoBoard:(NSString *)boardId fileId:(NSString *)fileId
Parameters
- boardId
跳转到的白板页 ID
- fileId
跳转到的白板页所属的文件 ID
Declared In
TEduBoardDef.h
onTEBGotoStep:totalStep:
白板页动画步数回调
- (void)onTEBGotoStep:(uint32_t)currentStep totalStep:(uint32_t)totalStep
Parameters
- currentStep
当前白板页动画步数,取值范围 [0, totalStep)
- totalStep
当前白板页动画总步数
Declared In
TEduBoardDef.h
onTEBGroupStatusChanged:groupId:operationType:message:
分组讨论状态变更
- (void)onTEBGroupStatusChanged:(bool)enable groupId:(NSString *)groupId operationType:(TEduBoardClassGroupOperationType)operationType message:(NSString *)message
Parameters
- enable
分组模式状态
- groupId
发生变化的分组id
- operationType
TEduBoardClassGroupOperationType
, 触发状态变更的操作
- message
操作信息
Declared In
TEduBoardDef.h
onTEBH5FileStatusChanged:status:
H5 文件状态回调
- (void)onTEBH5FileStatusChanged:(NSString *)fileId status:(TEduBoardH5FileStatus)status
Parameters
- fileId
文件 ID
- status
文件状态
Declared In
TEduBoardDef.h
onTEBH5PPTStatusChanged:status:message:
H5PPT 文件状态改变回调
- (void)onTEBH5PPTStatusChanged:(NSString *)fileId status:(TEduBoardH5PPTStatus)status message:(NSString *)message
Parameters
- fileId
文件 ID
- status
文件状态
- message
状态消息
Declared In
TEduBoardDef.h
onTEBHistroyDataSyncCompleted
白板历史数据同步完成回调
- (void)onTEBHistroyDataSyncCompleted
Declared In
TEduBoardDef.h
onTEBImageElementStatusChanged:url:elementId:
白板图片元素加载状态
- (void)onTEBImageElementStatusChanged:(NSString *)boardId url:(NSString *)url elementId:(NSString *)elementId
Parameters
- boardId
白板 ID
- url
白板图片 URL
- elementId
当前元素id
Declared In
TEduBoardDef.h
onTEBImageStatusChanged:url:status:
白板图片状态改变回调
- (void)onTEBImageStatusChanged:(NSString *)boardId url:(NSString *)url status:(TEduBoardImageStatus)status
Parameters
- boardId
白板 ID
- url
白板图片 URL
- status
新的白板图片状态,注意:如果监听到TEDU_BOARD_IMAGE_STATUS_LOAD_ERROR, TEDU_BOARD_IMAGE_STATUS_LOAD_TIMEOUT事件,请调用refresh 接口进行重新渲染白板。
Declared In
TEduBoardDef.h
onTEBInit
白板初始化完成回调
收到该回调后表示白板已处于可正常工作状态(此时白板为空白白板,历史数据尚未拉取到)
- (void)onTEBInit
Declared In
TEduBoardDef.h
onTEBMathGraphEvent:boardId:graphId:message:
数学函数图像工具事件
- (void)onTEBMathGraphEvent:(TEduBoardMathGraphCode)code boardId:(NSString *)boardId graphId:(NSString *)graphId message:(NSString *)message
Parameters
- code
元素ID
- boardId
函数画板ID
- graphId
函数图像ID
- message
异常信息
Declared In
TEduBoardDef.h
onTEBOfflineWarning:
白板离线告警
- (void)onTEBOfflineWarning:(NSInteger)count
Parameters
- count
告警次数
Declared In
TEduBoardDef.h
onTEBRedoStatusChanged:
白板可重做状态改变回调
- (void)onTEBRedoStatusChanged:(bool)canRedo
Parameters
- canRedo
白板当前是否还能执行 Redo 操作
Declared In
TEduBoardDef.h
onTEBRemoveElement:
删除元素回调
- (void)onTEBRemoveElement:(NSArray *)elementIds
Parameters
- elementIds
删除的元素 IDs
只有本地调用 addElement 时会收到该回调
Declared In
TEduBoardDef.h
onTEBSelectedElements:
框选工具选中元素回调
- (void)onTEBSelectedElements:(NSArray<TEduBoardElementInfo*> *)selectdElements
Parameters
- selectdElements
被选中元素数组
Declared In
TEduBoardDef.h
onTEBSetBackgroundImage:
设置白板背景图片回调
- (void)onTEBSetBackgroundImage:(NSString *)url
Parameters
- url
调用 SetBackgroundImage 时传入的 URL
只有本地调用 SetBackgroundImage 时会收到该回调 收到该回调表示背景图片已经上传或下载成功,并且显示出来
Declared In
TEduBoardDef.h
onTEBSnapshot:errorCode:errorMsg:
白板快照
- (void)onTEBSnapshot:(NSString *)path errorCode:(TEduBoardErrorCode)code errorMsg:(NSString *)msg
Parameters
- path
快照本地路径
- code
错误码,返回 0,表示获取快照成功
- msg
错误信息
Declared In
TEduBoardDef.h
onTEBSwitchFile:
切换文件回调
- (void)onTEBSwitchFile:(NSString *)fileId
Parameters
- fileId
切换到的文件 ID
Declared In
TEduBoardDef.h
onTEBSyncData:
白板同步数据回调
- (void)onTEBSyncData:(NSString *)data
Parameters
- data
白板同步数据(JSON 格式字符串)
收到该回调时需要将回调数据通过信令通道发送给房间内其他人,接受者收到后调用 addSyncData 接口将数据添加到白板以实现数据同步 该回调用于多个白板间的数据同步,使用腾讯云 IMSDK 进行实时数据同步时,不会收到该回调
Declared In
TEduBoardDef.h
onTEBTextElemenWarning:msg:
白板图片元素加载状态
- (void)onTEBTextElemenWarning:(TEduBoardTextComponentStatus)code msg:(NSString *)msg
Parameters
- code
白板文字工具异常状态码
- msg
异常信息
Declared In
TEduBoardDef.h
onTEBTextElementStatusChanged:status:value:left:top:
文本组件状态回调
- (void)onTEBTextElementStatusChanged:(NSString *)elementId status:(NSString *)status value:(NSString *)value left:(float)left top:(float)top
Parameters
- elementId
文本组件id
- status
文本组件状态(focus:获得焦点,blur:失去焦点)
- value
文本内容
- left
文本组件水平偏移
- top
文本组件垂直偏移
Declared In
TEduBoardDef.h
onTEBUndoStatusChanged:
白板可撤销状态改变回调
- (void)onTEBUndoStatusChanged:(bool)canUndo
Parameters
- canUndo
白板当前是否还能执行 Undo 操作
Declared In
TEduBoardDef.h
onTEBVideoStatusChanged:status:progress:duration:
视频文件状态回调
- (void)onTEBVideoStatusChanged:(NSString *)fileId status:(TEduBoardVideoStatus)status progress:(CGFloat)progress duration:(CGFloat)duration
Parameters
- fileId
文件 ID
- status
文件状态
- progress
当前进度(秒)(仅支持 mp4 格式)
- duration
总时长(秒)(仅支持 mp4 格式)
Declared In
TEduBoardDef.h