Inherits from NSObject
Declared in TEduBoardController.h

Overview

@ingroup ctrl

Tasks

Other Methods

设置 TEduBoardCallback 回调

基本流程接口

涂鸦相关接口

白板页操作接口

文件操作接口

Class Methods

enableCache

获取缓存的启用状态

+ (BOOL)enableCache

Return Value

是否启用

Declared In

TEduBoardController.h

getVersion

获取版本号

+ (NSString *)getVersion

Return Value

NSString 版本号字符串

Declared In

TEduBoardController.h

isSingleMode

获取单实例模式

+ (BOOL)isSingleMode

Return Value

是否启用单实例模式

Declared In

TEduBoardController.h

setEnableCache:

启用和关闭缓存, 请在TEduBoardController初始化之前调用

+ (void)setEnableCache:(bool)enable

Parameters

enable

是否启用，默认为 YES

Declared In

TEduBoardController.h

setSingleMode:

是否开启单实例模式

+ (void)setSingleMode:(bool)singleMode

Parameters

singleMode

单实例模式，true为单例(第二个TEduBoardController实例初始化时会回收旧的实例)，false则容许多实例

Discussion

Warning: SDK默认为单实例模式

Declared In

TEduBoardController.h

Instance Methods

addBackupDomain:backup:priority:

添加资源主备域名映射 1.主备域名均需包含协议类型(支持http/https) 2.切换域名重试超时默认为5s 3.多次调用此接口，可为统一主域名添加多个备用域名。如果备用域名已在列表中则不再添加 4.当主域名不可用时，SDK将按从前往后的顺序从列表中选择一个备用域名并重试，请务必将可用性高的域名添加到列表前面

- (void)addBackupDomain:(NSString *)domain backup:(NSString *)backup priority:(NSInteger)priority

Parameters

domain

主域名 (必填）

backup

备用域名 (必填)

priority

优先级，备用域名优先级相同时，按添加的顺序决定优先级，添加越前优先级越高

Declared In

TEduBoardController.h

addBoard:model:type:needSwitch:

增加一页白板

- (NSString *)addBoard:(NSString *)url model:(TEduBoardImageFitMode)model type:(TEduBoardBackgroundType)type needSwitch:(BOOL)needSwitch

Parameters

url

【可选】要使用的背景图片url，为 null 表示不指定背景图片，只支持https协议的图片url

model

【可选】要使用的图片填充对齐模式TEduBoardImageFitMode，当设置url时有效

type

【可选】背景类型，TEduBoardBackgroundType

needSwitch

【可选】是否切换到添加的白板页

Discussion

Warning: 1、白板页会被添加到默认文件（文件 ID 为#DEFAULT)，自行上传的文件无法添加白板页;

Warning: 2、触发 TEduBoard.EVEN.TEB_ADDBOARD 事件

返回值内存由SDK内部管理，用户不需要自己释放

Declared In

TEduBoardController.h

addBoard:toClassGroup:

添加白板到分组

- (void)addBoard:(NSString *)boardId toClassGroup:(NSString *)groupId

Parameters

boardId

【必填】白板id

groupId

【必填】分组id

Declared In

TEduBoardController.h

addBoardWithBackgroundImage:

增加一页白板

- (NSString *)addBoardWithBackgroundImage:(NSString *)url

Parameters

url

要使用的背景图片 URL，编码格式为 UTF8，为 nullptr 表示不指定背景图片

Return Value

白板ID

Discussion

Warning: 白板页会被添加到默认文件（文件 ID 为#DEFAULT)，自行上传的文件无法添加白板页

返回值内存由SDK内部管理，用户不需要自己释放

Declared In

TEduBoardController.h

addDelegate:

设置事件回调监听

- (void)addDelegate:(id<TEduBoardDelegate>)delegate

Parameters

delegate

事件回调监听, TEduBoardDelegate

Discussion

Warning: 建议在调用 [TEduBoardController initWithAuthParam:roomId:initParam:] 之后马上调用该方法以支持错误处理

Declared In

TEduBoardController.h

addElement:type:

- (NSString *)addElement:(NSString *)url type:(TEduBoardElementType)type

addElement:type:options:

添加白板元素， 会触发 [TEduBoardDelegate onTEBAddElement:url:type:] 事件

- (NSString *)addElement:(NSString *)url type:(TEduBoardElementType)type options:(TEduBoardAddElementOptions *)options

Parameters

url

网页或者图片的 url，只支持 https 协议的网址或者图片 url

type

元素类型，当设置TEDU_BOARD_ELEMENT_IMAGE时，等价于addImageElement方法 TEduBoardElementType

options

配置参数 TEduBoardAddElementOptions

Return Value

元素ID

Discussion

添加白板元素， 会触发 [TEduBoardDelegate onTEBAddElement:url:type:] 事件

Warning: （1）当 type = TEDU_BOARD_ELEMENT_IMAGE，支持 png、jpg、gif、svg 格式的本地和网络图片，当 url 是一个有效的本地文件地址时，该文件会被自动上传到 COS，上传进度回调 onTEBFileUploadStatus

Warning: （2）当 type = TEDU_BOARD_ELEMENT_CUSTOM_GRAPH，仅支持网络 url，请与自定义图形工具 TEDU_BOARD_TOOL_TYPE_BOARD_CUSTOM_GRAPH 配合使用

Warning: （3）当 type = TEDU_BOARD_ELEMENT_AUDIO 或 TEDU_BOARD_ELEMENT_GLOBAL_AUDIO，仅支持网络 url

Warning: （4）当 type = TEDU_BOARD_ELEMENT_MATH_BOARD 或 TEDU_BOARD_ELEMENT_MATH_GRAPH,请使用addElementWithBoard或addElementWithGraph

Warning: （5）addElement不支持涂鸦元素TEDU_BOARD_ELEMENT_GRAFFITI_LINE ~ TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_OVAL

Warning: （6）当 type = TEDU_BOARD_ELEMENT_FORMULA, 添加一个公式元素, 请使用addElementWithExpression， 示例: [boardController addElementWithExpression:@“f(x) = \\int_{-\\infty}^\\infty \\hat{f}(\\xi)\\,e^{2 \\pi i \\xi x} \\,d\\xi” type:TEDU_BOARD_ELEMENT_FORMULA];

Declared In

TEduBoardController.h

addElementWithBoard:options:

添加一个数学函数画板

- (NSString *)addElementWithBoard:(TEduBoardElementMathBoard *)mathBoard options:(TEduBoardAddElementOptions *)options

Parameters

mathBoard

【必填】数学函数画板 TEduBoardElementMathBoard

options

配置参数 TEduBoardAddElementOptions

Return Value

元素ID

Discussion

Warning: 会触发[TEduBoardDelegate onTEBAddElement:url:type:]回调

Declared In

TEduBoardController.h

addElementWithExpression:type:

添加白板元素，公式元素

- (NSString *)addElementWithExpression:(NSString *)expression type:(TEduBoardElementType)type

Parameters

expression

公式的函数表达式，注意添加转义字符 示例:[boardController addElementWithExpression:@“f(x) = \\int_{-\\infty}^\\infty \\hat{f}(\\xi)\\,e^{2 \\pi i \\xi x} \\,d\\xi” type:TEDU_BOARD_ELEMENT_FORMULA];

type

元素类型，此处只能设置为TEDU_BOARD_ELEMENT_FORMULA时，TEduBoardElementType

Return Value

元素ID

Discussion

添加白板元素，公式元素

Declared In

TEduBoardController.h

addElementWithGraph:options:

添加一个数学函数图像

- (NSString *)addElementWithGraph:(TEduBoardElementMathGraph *)mathGraph options:(TEduBoardAddElementOptions *)options

Parameters

mathGraph

【必填】数学函数图像 TEduBoardElementMathGraph

options

配置参数 TEduBoardAddElementOptions

Return Value

元素ID

Discussion

Warning: 会触发 [TEduBoardDelegate onTEBAddElement:url:type:]回调

Declared In

TEduBoardController.h

addH5File:title:needSwitch:

添加 H5 页面

- (NSString *)addH5File:(NSString *)url title:(NSString *)title needSwitch:(BOOL)needSwitch

Parameters

url

网页地址

title

文件名

needSwitch

添加文件后是否切换到该文件

Return Value

文件 ID

Discussion

Warning: 只支持展示，不支持互动

Declared In

TEduBoardController.h

addImageElement:

添加图片资源

- (void)addImageElement:(NSString *)url

Parameters

url

【必填】图片地址 支持 png/jpg/gif/svg 格式的本地和网络图片，当 URL 是一个有效的本地文件地址时，该文件会被自动上传到 COS。上传进度回调 onTEBFileUploadProgress，上传结果回调 onTEBFileUploadStatus

Declared In

TEduBoardController.h

addImagesFile:title:needSwitch:

批量导入图片到白板

- (NSString *)addImagesFile:(NSArray<NSString*> *)urls title:(NSString *)title needSwitch:(BOOL)needSwitch

Parameters

urls

要使用的背景图片 URL 列表，编码格式为 UTF8

title

文件名

needSwitch

添加文件后是否切换到该文件

Return Value

新增加文件Id

Discussion

Warning: 当传入文件的 URL 重复时，返回 URL 对应的 文件 ID

Declared In

TEduBoardController.h

addSnapshotMark

调用此接口可在后台生成当前白板的板书内容

- (void)addSnapshotMark

Declared In

TEduBoardController.h

addSyncData:

添加白板同步数据

- (void)addSyncData:(NSString *)data

Parameters

data

接收到的房间内其他人发送的同步数据

该接口用于多个白板间的数据同步，使用内置 IM 作为信令通道时，不需要调用该接口

Declared In

TEduBoardController.h

addTextElement:fontColor:fontSize:fontFace:fontStyle:

添加一个文本元素

- (void)addTextElement:(NSString *)textContent fontColor:(NSString *)fontColor fontSize:(NSInteger)fontSize fontFace:(NSString *)fontFace fontStyle:(TEduBoardTextStyle)fontStyle

Parameters

textContent

文本内容

fontColor

文本颜色, 默认值"#ff0000"

fontSize

文本大小, 默认值200

fontFace

文本字体库, 默认值PingFangSC-Regular

fontStyle

文本字体样式, TEduBoardTextStyle

Declared In

TEduBoardController.h

addTextFontFamily:fontUrl:

添加自定义字体

- (void)addTextFontFamily:(NSString *)fontFace fontUrl:(NSString *)fontUrl

Parameters

fontFace

字体样式名称

fontUrl

字体资源链接

Discussion

Warning: 建议在创建白板实例后立刻调用

Warning: 本地端和远端都需要设置字体样式，否则可能出现两端字体显示样式不同步

Warning: 添加系统内置字体时，fontUrl可以传入空字符串

Declared In

TEduBoardController.h

addTranscodeFile:needSwitch:

添加转码文件

- (NSString *)addTranscodeFile:(TEduBoardTranscodeFileResult *)result needSwitch:(BOOL)needSwitch

Parameters

result

文件转码结果 TEduBoardTranscodeFileResult

needSwitch

是否跳转到该文件

Return Value

文件ID

Discussion

Warning: 当传入文件的 URL 重复时，返回 URL 对应的 文件 ID

Warning: 在收到对应的 onTEBAddTranscodeFile 回调前，无法用返回的文件 ID 查询到文件信息

See Also

  • TEduBoardCallback::onTEBAddTranscodeFile

    TEduBoardTranscodeFileResult 的字段信息主要来自： 1. 使用客户端 ApplyFileTranscode 转码，直接将转码结果用于调用此接口 2. （推荐）使用服务端 REST API 转码，只需传入转码回调结果的四个字段（title，resolution，url，pages），其服务端->客户端字段的对应关系为 Title->title、Resolution->resolution、ResultUrl->url、Pages->pages 转码文档

    调用该接口后，SDK 会在后台进行文件加载，期间用户可正常进行其它操作，加载成功或失败后会触发相应回调 文件加载成功后，将自动切换到该文件

Declared In

TEduBoardController.h

addUser:toClassGroup:

添加用户到分组

- (void)addUser:(NSString *)userId toClassGroup:(NSString *)groupId

Parameters

userId

【必填】白板id

groupId

【必填】分组id

Declared In

TEduBoardController.h

addVideoFile:title:needSwitch:

添加视频文件

- (NSString *)addVideoFile:(NSString *)url title:(NSString *)title needSwitch:(BOOL)needSwitch

Parameters

url

文件播放地址

title

文件名

needSwitch

添加文件后是否切换到该文件

Return Value

文件 ID

Discussion

Warning: 当传入文件的 URL 重复时，返回 URL 对应的 文件 ID

支持 mp4/m3u8/hls，触发状态改变回调 onTEBVideoStatusChanged

Declared In

TEduBoardController.h

clear

清除涂鸦，同时清空背景色以及背景图片

- (void)clear

Declared In

TEduBoardController.h

clearBackground:andSelected:

清空当前白板页涂鸦

- (void)clearBackground:(BOOL)background andSelected:(BOOL)selected

Parameters

background

是否同时清空背景色以及背景图片

selected

是否只清除选中部分涂鸦

Discussion

Warning: 目前不支持清除选中部分的同时清除背景

Declared In

TEduBoardController.h

clearDraws

清除涂鸦

- (void)clearDraws

Declared In

TEduBoardController.h

clearFileDraws:

清空指定文件的所有白板涂鸦

- (void)clearFileDraws:(NSString *)fileId

Parameters

fileId

文件 ID

Declared In

TEduBoardController.h

deleteBoard:

删除一页白板

- (void)deleteBoard:(NSString *)boardId

Parameters

boardId

要删除的白板 ID，为 nullptr 表示删除当前页

Discussion

Warning: 只允许删除默认文件（文件 ID 为#DEFAULT）内的白板页，且默认白板页（白板 ID 为#DEFAULT）无法删除

Declared In

TEduBoardController.h

deleteFile:

删除文件

- (void)deleteFile:(NSString *)fileId

Parameters

fileId

要删除的文件 ID

文件 ID 为 nullptr 时表示当前文件，默认文件无法删除

Declared In

TEduBoardController.h

enableAudioControl:

是否启用音频控制面板

- (void)enableAudioControl:(BOOL)enable

Parameters

enable

启用或禁止

Discussion

Warning: 禁止控制面板后，不能通过界面交互方式操作音频元素

Declared In

TEduBoardController.h

enableMultiTouch:

开启多点触控

- (void)enableMultiTouch:(BOOL)enable

Parameters

enable

是否开启

Declared In

TEduBoardController.h

enablePenAutoFit:delay:

开启绘制涂鸦过程中自动拟合图形 用户在绘制过程中，保持鼠标或触摸不抬起会自动触发拟合图形 开启后默认会使用TEduBoardPenFittingMode.AUTO模式拟合

- (void)enablePenAutoFit:(BOOL)enable delay:(NSTimeInterval)delay

Parameters

enable

开启自动拟合

delay

触发时延，默认2000ms // 示例一：启用自动拟合 teduBoard.enablePenAutoFit(true, 2000); // 示例二：修改自动拟合模式 teduBoard.enablePenAutoFit(true, 2000); teduBoard.setPenAutoFittingMode(TEduBoardPenFittingMode.RECTANGLE);

Declared In

TEduBoardController.h

getAllClassGroupIds

获取所有分组id

- (NSArray<NSString*> *)getAllClassGroupIds

Return Value

分组id列表

Declared In

TEduBoardController.h

getAudioVolume:

获取音量

- (CGFloat)getAudioVolume:(NSString *)elementId

Parameters

elementId

调用 addElement 方法返回的元素 ID

Return Value

当前音量，取值范围[0-1]

Discussion

获取音量

Declared In

TEduBoardController.h

getBackgroundColor

获取当前白板页的背景色

- (TEColor *)getBackgroundColor

Return Value

当前白板页的背景色

Declared In

TEduBoardController.h

getBoardContentFitMode

获取白板内容自适应模式

- (TEduBoardContentFitMode)getBoardContentFitMode

Return Value

白板内容自适应模式 TEduBoardContentFitMode

Declared In

TEduBoardController.h

getBoardElementList:

获取白板中所有元素

- (NSArray<TEduBoardElementInfo*> *)getBoardElementList:(NSString *)boardId

Parameters

boardId

白板 ID，如果为空则获取当前白板所有元素

Return Value

白板元素列表 TEduBoardElementInfo

Declared In

TEduBoardController.h

getBoardList

获取所有文件的白板列表

- (NSArray<NSString*> *)getBoardList

Return Value

所有文件的白板列表

Declared In

TEduBoardController.h

getBoardRatio

获取当前白板页宽高比

- (NSString *)getBoardRatio

Return Value

白板宽高比，格式与 SetBoardRatio 接口参数格式一致

Declared In

TEduBoardController.h

getBoardRemark:

获取白板备注

- (NSDictionary<NSString*,NSString*> *)getBoardRemark:(NSString *)boardId

Parameters

boardId

【选填】获取指定的白板备注，不填表示获取所有设置过白板备注

Return Value

白板备注map， key为白板id，value为备注内容

Declared In

TEduBoardController.h

getBoardRenderView

获取白板渲染 View

- (TEView *)getBoardRenderView

Return Value

白板渲染 View

Declared In

TEduBoardController.h

getBoardScale

获取当前白板页缩放比例

- (UInt32)getBoardScale

Return Value

白板缩放比例，格式与 SetBoardScale 接口参数格式一致

Declared In

TEduBoardController.h

getBoardScroll

获取白板滚动位置 2.6.8新增

- (CGPoint)getBoardScroll

Return Value

CGPoint的x代表left，y代表top，以百分比形式展示，范围在 [0,1]

Declared In

TEduBoardController.h

getBrushColor

获取画笔颜色

- (TEColor *)getBrushColor

Return Value

画笔颜色

Declared In

TEduBoardController.h

getBrushThin

获取画笔粗细

- (UInt32)getBrushThin

Return Value

画笔粗细

Declared In

TEduBoardController.h

getClassGroupEnable

获取分组模式状态

- (BOOL)getClassGroupEnable

Return Value

是否启用

Declared In

TEduBoardController.h

getClassGroupIdByUserId:

获取用户所在的分组

- (NSArray<NSString*> *)getClassGroupIdByUserId:(NSString *)userId

Parameters

userId

【必填】用户Id

Return Value

分组id列表

Declared In

TEduBoardController.h

getClassGroupInfoById:

获取分组信息

- (NSDictionary *)getClassGroupInfoById:(NSString *)groupId

Parameters

groupId

【必填】分组id

Return Value

分组信息 { classGroupId: 分组id, boards: 白板列表, users: 用户列表, currentBoardId: 当前白板id, title: 分组标题 }

Declared In

TEduBoardController.h

getCurrentBoard

获取当前白板页 ID

- (NSString *)getCurrentBoard

Return Value

当前白板页 ID

返回值内存由 SDK 内部管理，用户不需要自己释放

Declared In

TEduBoardController.h

getCurrentFile

获取当前文件 ID

- (NSString *)getCurrentFile

Return Value

当前文件 ID

Declared In

TEduBoardController.h

getElementById:

获取白板中的元素信息

- (TEduBoardElement *)getElementById:(NSString *)elementId

Parameters

elementId

元素id

Return Value

白板元素信息 TEduBoardElement

Declared In

TEduBoardController.h

getEraserSize

获取橡皮擦大小

- (NSInteger)getEraserSize

Return Value

橡皮擦大小

Declared In

TEduBoardController.h

getFileBoardList:

获取指定文件的白板 ID 列表

- (NSArray<NSString*> *)getFileBoardList:(NSString *)fileId

Parameters

fileId

文件 ID

Return Value

白板 ID 列表

Discussion

Warning: 返回值不再使用时不需要自行 delete，但是务必调用其 release 方法以释放内存占用

Declared In

TEduBoardController.h

getFileInfo:

获取白板中指定文件的文件信息

- (TEduBoardFileInfo *)getFileInfo:(NSString *)fileId

Return Value

文件信息 TEduBoardFileInfo

Discussion

Warning: 每次调用该接口的返回值内容都指向同一块内存，若需要保存返回信息，请在拿到返回值后及时拷贝走

Declared In

TEduBoardController.h

getFileInfoList

获取白板中上传的所有文件的文件信息列表

- (NSArray<TEduBoardFileInfo*> *)getFileInfoList

Return Value

文件信息列表 TEduBoardFileInfo

Discussion

Warning: 返回值不再使用时不需要自行 delete，但是务必调用其 release 方法以释放内存占用

Declared In

TEduBoardController.h

getFileTranscodeProgress:

主动查询文件转码进度

- (void)getFileTranscodeProgress:(NSString *)taskId

Parameters

taskId

通过 onTEBFileTranscodeProgress 回调拿到的转码任务 taskId

Discussion

Warning: 该接口仅用于特殊业务场景下主动查询文件转码进度，调用 ApplyFileTranscode 后，SDK 内部将会自动定期触发 onTEBFileTranscodeProgress 回调，正常情况下您不需要主动调用此接口

Declared In

TEduBoardController.h

getGlobalBackgroundColor

获取白板全局背景色

- (TEColor *)getGlobalBackgroundColor

Return Value

全局背景色

Declared In

TEduBoardController.h

getGlobalBackgroundPic

获取白板背景图 2.6.8新增

- (NSDictionary *)getGlobalBackgroundPic

Return Value

object

Declared In

TEduBoardController.h

getGraphStyle

获取图形样式

- (TEduBoardGraphStyle *)getGraphStyle

Return Value

图形样式 TEduBoardGraphStyle

Declared In

TEduBoardController.h

getHighlighterColor

获取荧光笔颜色

- (TEColor *)getHighlighterColor

Return Value

荧光笔颜色

Declared In

TEduBoardController.h

getLineStyle

获取直线样式

- (TEduBoardLineStyle *)getLineStyle

Return Value

直线样式

Declared In

TEduBoardController.h

getOvalDrawMode

获取椭圆绘制模式

- (TEduBoardOvalDrawMode)getOvalDrawMode

Return Value

椭圆绘制模式

Declared In

TEduBoardController.h

getPPTRemarks:pageIndex:

获取PPT的备注 调用时机：收到PPT加载完成的事件onTEBH5PPTStatusChanged回调状态为TEDU_BOARD_H5_PPT_STATUS_LOADED

- (NSDictionary<NSString*,NSString*> *)getPPTRemarks:(NSString *)fid pageIndex:(NSInteger)pageIndex

Parameters

fid

【必填】文件ID

pageIndex

【选填】-1表示获取当前ppt所有备注；其他表示获取当前ppt索引页(从0开始)的备注 @return 返回当前页备注 {0: ‘这是第一页备注’} 返回所有页备注,页数索引从0开始:{0: ‘这是第一页备注’, 1: ‘这是第二页备注’}

Declared In

TEduBoardController.h

getSyncTime

获取同步时间戳

- (uint64_t)getSyncTime

Return Value

毫秒级同步时间戳

Declared In

TEduBoardController.h

getTextColor

获取文本颜色

- (TEColor *)getTextColor

Return Value

文本颜色

Declared In

TEduBoardController.h

getTextFontFamily

获取当前使用字体

- (NSString *)getTextFontFamily

Return Value

当前使用字体

Declared In

TEduBoardController.h

getTextSize

获取文本大小

- (UInt32)getTextSize

Return Value

文本大小

Declared In

TEduBoardController.h

getTextStyle

获取文本样式

- (TEduBoardTextStyle)getTextStyle

Return Value

文本样式

Declared In

TEduBoardController.h

getThumbnailImages:

获取指定文件的缩略图，不支持默认文件（fileId=#DEFAULT）

- (NSArray *)getThumbnailImages:(NSString *)fileId

Parameters

fileId

文件 ID

Return Value

缩略图 URL 列表

用户在调用 rest api 请求转码时，需要带上 “thumbnail_resolution” 参数，开启缩略图功能，否则返回的缩略图 url 无效

Declared In

TEduBoardController.h

getToolType

获取正在使用的白板工具

- (TEduBoardToolType)getToolType

Return Value

正在使用的白板工具

Declared In

TEduBoardController.h

gotoBoard:

跳转到指定白板页

- (void)gotoBoard:(NSString *)boardId

Parameters

boardId

要跳转到的白板页 ID

允许跳转到任意文件的白板页

Declared In

TEduBoardController.h

gotoBoard:resetStep:

跳转到指定白板页

- (void)gotoBoard:(NSString *)boardId resetStep:(BOOL)resetStep

Parameters

boardId

要跳转到的白板页 ID

resetStep

指定翻到指定页以后是否重置 PPT 动画步数

允许跳转到任意文件的白板页

Declared In

TEduBoardController.h

gotoClassGroupBoard:

分组内跳转

- (void)gotoClassGroupBoard:(NSString *)boardId

Parameters

boardId

【必填】白板id

Discussion

Warning: 分组模式下切换白板只能通过此方法进行，必须知道需要跳转的白板id

Declared In

TEduBoardController.h

gotoStep:ofBoard:

跳转到指定动画步数

- (void)gotoStep:(NSInteger)step ofBoard:(NSString *)boardId

Parameters

step

动画步数

boardId

白板id

Declared In

TEduBoardController.h

init

- (instancetype)init

initWithAuthParam:roomId:initParam:

初始化白板

- (instancetype)initWithAuthParam:(TEduBoardAuthParam *)authParam roomId:(UInt32)roomId initParam:(TEduBoardInitParam *)initParam

Parameters

authParam

授权参数 TEduBoardAuthParam

roomId

课堂 ID

initParam

可选参数，TEduBoardInitParam 指定用于初始化白板的一系列属性值

Discussion

Warning: 使用腾讯云 IMSDK 进行实时数据同步时，只支持一个白板实例，创建多个白板实例可能导致涂鸦状态异常

可用 initParam.timSync 指定是否使用腾讯云IMSDK进行实时数据同步 initParam.timSync == true 时，会尝试反射调用腾讯云 IMSDK 作为信令通道进行实时数据收发（只实现消息收发，初始化、进房等操作需要用户自行实现），目前仅支持 IMSDK 4.3.118 及以上版本

Declared In

TEduBoardController.h

initWithFrame:

- (instancetype)initWithFrame:(CGRect)frame

isDataSyncEnable

获取白板是否开启数据同步

- (BOOL)isDataSyncEnable

Return Value

是否开启数据同步，true 表示开启，false 表示关闭

Declared In

TEduBoardController.h

isDrawEnable

获取白板是否允许涂鸦

- (BOOL)isDrawEnable

Return Value

是否允许涂鸦，true 表示白板可以涂鸦，false 表示白板不能涂鸦

Declared In

TEduBoardController.h

isHandwritingEnable

获取白板是否开启笔锋

- (BOOL)isHandwritingEnable

Return Value

是否开启笔锋

Declared In

TEduBoardController.h

isPiecewiseErasureEnable

获取分段擦除模式开启状态 2.6.8新增

- (BOOL)isPiecewiseErasureEnable

Declared In

TEduBoardController.h

loadResource:

用于课件预加载，减少课件的加载时间

- (BOOL)loadResource:(NSString *)zipUrl

Discussion

Warning: iOS 11.4、macOS 11.0以上系统有效

Declared In

TEduBoardController.h

new

- (instancetype)new

nextBoard

向后翻页

若当前白板页为当前文件的最后一页，则该接口调用无效

- (void)nextBoard

Declared In

TEduBoardController.h

nextBoard:

向后翻页

- (void)nextBoard:(BOOL)resetStep

Parameters

resetStep

指定翻到指定页以后是否重置 PPT 动画步数

若当前白板页为当前文件的最后一页，则该接口调用无效

Declared In

TEduBoardController.h

nextStep

下一步

每个 Step 对应 PPT 的一个动画效果，若当前没有未展示的动画效果，则该接口调用会导致向后翻页

- (void)nextStep

Declared In

TEduBoardController.h

pauseAudio:

暂停音频

- (void)pauseAudio:(NSString *)elementId

Parameters

elementId

调用 addElement 方法返回的元素 ID

触发状态改变回调 [TEduBoardDelegate onTEBAudioStatusChanged:status:progress:duration:]

Declared In

TEduBoardController.h

pauseVideo

暂停视频

- (void)pauseVideo

Discussion

Warning: 只对当前文件有效

触发状态改变回调 onTEBVideoStatusChanged，一般在使用自定义视频控制栏时使用 移动端退后台调用 pause（WebView 默认行为）

Declared In

TEduBoardController.h

playAudio:

播放音频

- (void)playAudio:(NSString *)elementId

Parameters

elementId

调用 addElement 方法返回的元素 ID

触发状态改变回调 [TEduBoardDelegate onTEBAudioStatusChanged:status:progress:duration:]

Declared In

TEduBoardController.h

playVideo

播放视频

- (void)playVideo

Discussion

Warning: 只对当前文件有效

触发状态改变回调 onTEBVideoStatusChange，一般在使用自定义视频控制栏时使用 移动端回前台调用 play（WebView 默认行为）

Declared In

TEduBoardController.h

preBoard

向前翻页

若当前白板页为当前文件的第一页，则该接口调用无效

- (void)preBoard

Declared In

TEduBoardController.h

preBoard:

向前翻页

- (void)preBoard:(BOOL)resetStep

Parameters

resetStep

指定翻到指定页以后是否重置 PPT 动画步数

若当前白板页为当前文件的第一页，则该接口调用无效

Declared In

TEduBoardController.h

prevStep

上一步 每个 Step 对应 PPT 的一个动画效果，若当前没有已展示的动画效果，则该接口调用会导致向前翻页

- (void)prevStep

Declared In

TEduBoardController.h

redo

重做当前白板页上一次撤销

- (void)redo

Declared In

TEduBoardController.h

refresh

刷新当前页白板，触发 onTEBRefresh 回调

- (void)refresh

Discussion

Warning: 如果当前白板包含 PPT/H5/图片/视频时，刷新白板将会触发对应的回调

Declared In

TEduBoardController.h

removeBackupDomain:backup:

删除资源主备域名映射

- (void)removeBackupDomain:(NSString *)domain backup:(NSString *)backup

Parameters

domain

主域名 (必填）

backup

备用域名 (必填)

Declared In

TEduBoardController.h

removeBoard:inClassGroup:

从分组中删除白板

- (void)removeBoard:(NSString *)boardId inClassGroup:(NSString *)groupId

Parameters

boardId

【必填】白板id

groupId

【必填】分组id

Declared In

TEduBoardController.h

removeClassGroup:

删除分组

- (void)removeClassGroup:(NSString *)groupId

Parameters

groupId

【必填】分组id

Declared In

TEduBoardController.h

removeDelegate:

删除事件回调监听

- (void)removeDelegate:(id<TEduBoardDelegate>)delegate

Parameters

delegate

事件回调监听 TEduBoardDelegate

Declared In

TEduBoardController.h

removeElement:

删除白板元素

- (BOOL)removeElement:(NSString *)elementId

Parameters

elementId

元素 ID

Return Value

删除是否成功

Discussion

删除白板元素

Declared In

TEduBoardController.h

removeUser:inClassGroup:

从分组中删除用户

- (void)removeUser:(NSString *)userId inClassGroup:(NSString *)groupId

Parameters

userId

【必填】用户Id

groupId

【必填】分组id

Declared In

TEduBoardController.h

reset

重置白板

调用该接口后将会删除所有的白板页和文件

- (void)reset

Declared In

TEduBoardController.h

resetClassGroup

重置所有分组

- (void)resetClassGroup

Declared In

TEduBoardController.h

seekAudio:time:

跳转

- (void)seekAudio:(NSString *)elementId time:(CGFloat)time

Parameters

elementId

调用 addElement 方法返回的元素 ID

time

播放进度，单位秒

触发状态改变回调 [TEduBoardDelegate onTEBAudioStatusChanged:status:progress:duration:]

Declared In

TEduBoardController.h

seekVideo:

跳转（仅支持点播视频）

- (void)seekVideo:(CGFloat)time

Parameters

time

播放进度，单位秒

Discussion

Warning: 只对当前文件有效

触发状态改变回调 onTEBVideoStatusChanged，一般在使用自定义视频控制栏时使用

Declared In

TEduBoardController.h

setAccessibleUsers:operationType:

设置允许操作哪些用户绘制的图形 1.ERASER 工具只能擦除 users 参数列出的用户绘制的涂鸦，无法擦除其他人绘制的涂鸦 2.POINTSELECT、SELECT 工具只能选中 users 参数列出的用户绘制的涂鸦，无法选中其他人绘制的涂鸦 3.clear 接口只能用于清空选中涂鸦以及 users 参数列出的用户绘制的涂鸦，无法清空背景及其他人绘制的涂鸦 4.白板包含的其他功能未在本列表明确列出者都可以确定不受本接口影响

- (void)setAccessibleUsers:(NSArray<NSString*> *)users operationType:(NSArray<NSNumber*> *)operationType

Parameters

users

【必填】指定允许操作的用户集，为nil或@[]表示不加限制, @[@‘’]表示限制所有用户

operationType

【选填】指定允许的操作类型 TEduBoardAccessibleOperation

Declared In

TEduBoardController.h

setAudioVolume:volume:

设置音量

- (void)setAudioVolume:(NSString *)elementId volume:(CGFloat)volume

Parameters

elementId

调用 addElement 方法返回的元素 ID

volume

音频音量，取值范围[0-1]

Declared In

TEduBoardController.h

setBackgroundColor:

设置当前白板页的背景色

- (void)setBackgroundColor:(TEColor *)color

Parameters

color

要设置的背景色

白板页创建以后的默认背景色由 SetDefaultBackgroundColor 接口设定

Declared In

TEduBoardController.h

setBackgroundH5:

设置当前白板页的背景 H5 页面

- (void)setBackgroundH5:(NSString *)url

Parameters

url

要设置的背景 H5 页面 URL

该接口与 SetBackgroundImage 接口互斥

Declared In

TEduBoardController.h

setBackgroundImage:mode:

设置当前白板页的背景图片

- (void)setBackgroundImage:(NSString *)url mode:(TEduBoardImageFitMode)mode

Parameters

url

要设置的背景图片 URL，编码格式为 UTF8

mode

要使用的图片填充对齐模式, TEduBoardImageFitMode

当URL是一个有效的本地文件地址时，该文件会被自动上传到 COS

Declared In

TEduBoardController.h

setBoard:remark:

设置白板备注

- (void)setBoard:(NSString *)boardId remark:(NSString *)remark

Parameters

boardId

【必填】要备注的白板id

remark

【必填】要备注的内容

Declared In

TEduBoardController.h

setBoardContainerColor:

设置白板父容器的背景色

- (void)setBoardContainerColor:(TEColor *)color

Parameters

color

要设置的背景色

Declared In

TEduBoardController.h

setBoardContentFitMode:

设置白板内容自适应模式

- (void)setBoardContentFitMode:(TEduBoardContentFitMode)mode

Parameters

mode

要设置的白板内容自适应模式 TEduBoardContentFitMode

设置自适应模式后会影响所有后续白板内容操作,受影响接口包括：[TEduBoardController addTranscodeFile:needSwitch:]

Declared In

TEduBoardController.h

setBoardRatio:

设置当前白板页宽高比

- (void)setBoardRatio:(NSString *)ratio

Parameters

ratio

要设置的白板宽高比

格式如: “4:3"、"16:9”

Declared In

TEduBoardController.h

setBoardScale:

设置当前白板页缩放比例

- (void)setBoardScale:(UInt32)scale

Parameters

scale

要设置的白板缩放比例

支持范围: [100，1600]，实际缩放比为: scale / 100

Declared In

TEduBoardController.h

setBrushColor:

设置画笔颜色

- (void)setBrushColor:(TEColor *)color

Parameters

color

要设置的画笔颜色

画笔颜色用于所有涂鸦绘制

Declared In

TEduBoardController.h

setBrushThin:

设置画笔粗细

- (void)setBrushThin:(UInt32)thin

Parameters

thin

要设置的画笔粗细

画笔粗细用于所有涂鸦绘制，实际像素值取值(thin * 白板的高度 / 10000)px，如果结果小于1px，则涂鸦的线条会比较虚

Declared In

TEduBoardController.h

setClassGroup:boards:users:title:currentBoardId:

添加分组

- (void)setClassGroup:(NSString *)groupId boards:(NSArray<NSString*> *)boards users:(NSArray<NSString*> *)users title:(NSString *)title currentBoardId:(NSString *)currentBoardId

Parameters

groupId

【必填】分组id

boards

【必填】分组白板列表

users

【必填】分组用户列表

title

【必填】分组标题

currentBoardId

【必填】分组初始白板

Declared In

TEduBoardController.h

setClassGroup:title:

设置分组标题

- (void)setClassGroup:(NSString *)groupId title:(NSString *)title

Parameters

groupId

【必填】分组id

title

【必填】分组标题

Declared In

TEduBoardController.h

setClassGroupEnable:

开启分组模式

- (void)setClassGroupEnable:(BOOL)enable

Parameters

enable

【必填】是否开启

Declared In

TEduBoardController.h

setCursorIcon:cursorIcon:

自定义白板工具鼠标样式

- (void)setCursorIcon:(TEduBoardToolType)toolType cursorIcon:(TEduBoardCursorIcon *)cursorIcon

Parameters

toolType

要设置鼠标样式的白板工具类型

cursorIcon

要设置的鼠标样式 TEduBoardCursorIcon

Declared In

TEduBoardController.h

setDataSyncEnable:

设置白板是否开启数据同步

- (void)setDataSyncEnable:(BOOL)enable

Parameters

enable

是否开启

白板创建后默认开启数据同步，关闭数据同步，本地的所有白板操作不会同步到远端和服务器

Declared In

TEduBoardController.h

setDrawEnable:

设置白板是否允许涂鸦

- (void)setDrawEnable:(BOOL)enable

Parameters

enable

是否允许涂鸦，true 表示白板可以涂鸦，false 表示白板不能涂鸦

白板创建后默认为允许涂鸦状态

Declared In

TEduBoardController.h

setEraseLayerLimit:

设置橡皮擦单次擦除图层数量

- (void)setEraseLayerLimit:(NSInteger)limit

Parameters

limit

擦除图层数量，默认为0，即不限制图层数量

Declared In

TEduBoardController.h

setEraseLayerType:

限制橡皮擦可擦除的白板元素类型

- (void)setEraseLayerType:(NSArray<NSNumber*> *)typeArr

Parameters

typeArr

支持设置多个可擦除类型，整型数组 TEduBoardErasableElementType

Declared In

TEduBoardController.h

setEraserSize:

设置橡皮擦大小 2.6.8新增

- (void)setEraserSize:(NSInteger)size

Parameters

size

橡皮擦大小，单位：像素

Declared In

TEduBoardController.h

setGlobalBackgroundColor:

设置所有白板的背景色

- (void)setGlobalBackgroundColor:(TEColor *)color

Parameters

color

要设置的全局背景色

调用该接口将导致所有白板的背景色发生改变 新创建白板的默认背景色取全局背景色

Declared In

TEduBoardController.h

setGlobalBackgroundPic:position:type:

设置白板背景图 2.6.8新增

- (void)setGlobalBackgroundPic:(NSString *)url position:(TEduBoardImageFitMode)position type:(NSInteger)type

Parameters

url

资源链接

position

图片填充对齐模式 TEduBoardImageFitMode

type

背景类型（0: 背景图 1：H5）

Declared In

TEduBoardController.h

setGraphStyle:

设置图形样式

- (void)setGraphStyle:(TEduBoardGraphStyle *)style

Parameters

style

【必填】要设置的图形样式 TEduBoardGraphStyle 示例请参阅demo的 绘制无箭头的虚线直线、绘制终点实心箭头的实线直线、设置虚线直线，起点普通箭头、设置实线直线，起点实心箭头，终点普通箭头、绘制实心三角形、绘制虚线空心矩形

Declared In

TEduBoardController.h

setHandwritingEnable:

设置白板是否开启笔锋

- (void)setHandwritingEnable:(BOOL)enable

Parameters

enable

【必填】是否开启，true 表示开启，false 表示关闭

白板创建后默认为关闭

Declared In

TEduBoardController.h

setHighlighterColor:

设置荧光笔颜色，画笔颜色用于所有荧光笔绘制

- (void)setHighlighterColor:(TEColor *)color

Parameters

color

要设置的荧光笔颜色

Declared In

TEduBoardController.h

setLineStyle:

设置直线样式

- (void)setLineStyle:(TEduBoardLineStyle *)style

Parameters

style

要设置的直线样式 TEduBoardLineStyle

Declared In

TEduBoardController.h

setLogLevel:

设置输出日志级别

- (void)setLogLevel:(TEduBoardLogLevel)level

Parameters

level

输出日志的级别 TEduBoardLogLevel

Discussion

Warning: 建议在白板实例创建后立即调用

Warning: 低于 level 的日志将不会输出

Declared In

TEduBoardController.h

setMathGraphType:mouseTool:

设置几何画板元素

- (void)setMathGraphType:(TEduBoardMathGraphType)graphType mouseTool:(BOOL)mouseTool

Parameters

graphType

几何元素类型 TEduBoardMathGraphType

mouseTool

是否切换到鼠标工具

See Also

Declared In

TEduBoardController.h

setMouseToolBehavior:

设置鼠标工具行为

- (void)setMouseToolBehavior:(TEduBoardMouseToolBehavior *)config

Parameters

config

配置 TEduBoardMouseToolBehavior

Declared In

TEduBoardController.h

setNextTextInput:focus:

预设文本工具内容

- (void)setNextTextInput:(NSString *)input focus:(BOOL)focus

Parameters

input

预设文本内容，取消预设则设置为空

focus

是否继续保持焦点

Discussion

预设文本工具内容

Declared In

TEduBoardController.h

setOvalDrawMode:

设置椭圆绘制模式

- (void)setOvalDrawMode:(TEduBoardOvalDrawMode)mode

Parameters

mode

要设置的椭圆绘制模式 TEduBoardOvalDrawMode

Declared In

TEduBoardController.h

setOwnerNickNameVisible:

是否本地显示自己的别名

- (void)setOwnerNickNameVisible:(BOOL)visiable

Parameters

visiable

设置为false时，画笔部分不显示自己的NickName;

Declared In

TEduBoardController.h

setPenAutoFittingMode:

设置画笔自动拟合模式

- (void)setPenAutoFittingMode:(TEduBoardPenFittingMode)mode

Parameters

mode

画笔自动拟合模式 TEduBoardPenFittingMode

Declared In

TEduBoardController.h

setPiecewiseErasureEnable:

是否启用点擦（分段擦除）功能 2.6.8新增

- (void)setPiecewiseErasureEnable:(BOOL)enable

Parameters

enable

是否开启点擦

Discussion

Warning: 1. 只有2.6.8+的版本画线才能支持点擦，低于2.6.8以下版本的画线会整条线被擦除

Warning: 2. 观看端如果是低于2.6.8的版本，实时是看不到点擦变化，重新进课堂后能看到

Declared In

TEduBoardController.h

setRemoteCursorVisible:model:

设置远端画笔在本地是否可见

- (void)setRemoteCursorVisible:(BOOL)visible model:(TEduBoardRemoteCursorAction)mode

Parameters

visible

是否可见

mode

远端画笔操作类型 TEduBoardRemoteCursorAction

Declared In

TEduBoardController.h

setScaleAnchor:yRatio:

设置缩放锚点

- (void)setScaleAnchor:(CGFloat)xRatio yRatio:(CGFloat)yRatio

Parameters

xRatio

距离白板左边位置，取值【0, 1】

yRatio

距离白板顶部位置，取值【0, 1】

Declared In

TEduBoardController.h

setScaleToolRatio:

设置缩放工具的缩放比例

- (void)setScaleToolRatio:(NSInteger)scale

Parameters

scale

最小缩放步长

Declared In

TEduBoardController.h

setScrollBarVisible:

设置白板滚动条是否可见

- (void)setScrollBarVisible:(BOOL)enable

Parameters

enable

【必填】是否可见

Declared In

TEduBoardController.h

setSyncAudioStatusEnable:

是否同步本地音频操作到远端

- (void)setSyncAudioStatusEnable:(BOOL)enable

Parameters

enable

【必填】是否同步

Discussion

Warning: 全局控制项，对所有视频文件有效

play/pause/seek 接口以及控制栏事件的触发是否影响远端，默认为 true 一般情况下学生设置为 false，老师设置为 true

Declared In

TEduBoardController.h

setSyncFps:

修改信令同步频率，该值的允许范围为 [5, 20] 开启了多指操控后，如果频率不提高，消息会有延时会比较大

- (void)setSyncFps:(NSUInteger)fps

Parameters

fps

频率

Discussion

修改信令同步频率，该值的允许范围为 [5, 20] 开启了多指操控后，如果频率不提高，消息会有延时会比较大

Declared In

TEduBoardController.h

setSyncVideoStatusEnable:

是否同步本地视频操作到远端

- (void)setSyncVideoStatusEnable:(BOOL)enable

Parameters

enable

【必填】是否同步

Discussion

Warning: 全局控制项，对所有视频文件有效

play/pause/seek 接口以及控制栏事件的触发是否影响远端，默认为 true 一般情况下学生设置为 false，老师设置为 true

Declared In

TEduBoardController.h

setSyncVideoStatusEnable:isAppActiveChange:

是否同步本地视频操作到远端

- (void)setSyncVideoStatusEnable:(BOOL)enable isAppActiveChange:(BOOL)isAppActiveChange

Parameters

enable

【必填】是否同步

isAppActiveChange

【选填】只有移动端在app切换前后台的时候需要设置，其他端不需要设置

Discussion

Warning: 全局控制项，对所有视频文件有效

play/pause/seek 接口以及控制栏事件的触发是否影响远端，默认为 true 一般情况下学生设置为 false，老师设置为 true

Declared In

TEduBoardController.h

setSystemCursorEnable:

是否启用原生系统光标

- (void)setSystemCursorEnable:(BOOL)enable

Parameters

enable

启用或禁用，默认禁用

Declared In

TEduBoardController.h

setTextColor:

设置文本颜色

- (void)setTextColor:(TEColor *)color

Parameters

color

要设置的文本颜色

Declared In

TEduBoardController.h

setTextFontFamily:

设置自定义字体

- (void)setTextFontFamily:(NSString *)fontFace

Parameters

fontFace

字体样式名称

Discussion

Warning: 白板内置字体的样式为 ‘customFontFace’

Declared In

TEduBoardController.h

setTextSize:

设置文本大小

- (void)setTextSize:(UInt32)size

Parameters

size

要设置的文本大小

实际像素值取值(size * 白板的高度 / 10000)px

Declared In

TEduBoardController.h

setTextStyle:

设置文本样式

- (void)setTextStyle:(TEduBoardTextStyle)style

Parameters

style

要设置的文本样式 TEduBoardTextStyle

Declared In

TEduBoardController.h

setToolType:

设置要使用的白板工具

- (void)setToolType:(TEduBoardToolType)type

Parameters

type

要设置的白板工具, TEduBoardToolType

Declared In

TEduBoardController.h

setToolTypeTitle:style:toolType:

设置画笔和激光笔工具提示语

- (void)setToolTypeTitle:(NSString *)title style:(TEduBoardToolTypeTitleStyle *)style toolType:(TEduBoardToolType)toolType

Parameters

title

提示语

style

如果为空，则使用默认样式 TEduBoardToolTypeTitleStyle

toolType

工具类型 TEduBoardToolType

Declared In

TEduBoardController.h

setUserInfo:

设置用户信息

- (void)setUserInfo:(TEduBoardUserInfo *)userInfo

Parameters

userInfo

用户信息 TEduBoardUserInfo

Declared In

TEduBoardController.h

setZoomCursorIcon:zoomOutCursorIcon:

预设文本工具内容

- (void)setZoomCursorIcon:(TEduBoardCursorIcon *)zoomIn zoomOutCursorIcon:(TEduBoardCursorIcon *)zoomOut

Parameters

zoomIn

放大工具图标 TEduBoardCursorIcon

zoomOut

缩小工具图标 TEduBoardCursorIcon

Discussion

预设文本工具内容

Warning: 该接口只在桌面端支持

Declared In

TEduBoardController.h

showVideoControl:

显示或隐藏视频控制栏

- (void)showVideoControl:(BOOL)show

Parameters

show

是否显示

Discussion

Warning: 全局控制项，对所有视频文件有效 隐藏和显示默认视频控制栏，默认显示系统自带的 video 控制栏，不同平台界面 UI 样式不同

Declared In

TEduBoardController.h

snapshot:

白板快照

- (void)snapshot:(TEduBoardSnapshotInfo *)info

Parameters

info

快照信息 TEduBoardSnapshotInfo

Declared In

TEduBoardController.h

soundMuteForPPT:

设置PPT静音播放

- (void)soundMuteForPPT:(BOOL)mute

Parameters

mute

true 静音 false 取消静音

Discussion

Warning: 1、只能对本地生效，不会影响远端

Warning: 2、只对旧转码方案生效

Warning: 3、调用时机请在ppt课件加载状态事件中收到加载完成后再调用： -(void)onTEBH5PPTStatusChanged:(NSString )fileId status:(TEduBoardH5PPTStatus)status message:(NSString )message;中收到TEDU_BOARD_H5_PPT_STATUS_LOADED

Declared In

TEduBoardController.h

startSyncVideoStatus:

内部启动定时器，定时同步视频状态到远端（仅限于 mp4）

- (void)startSyncVideoStatus:(NSInteger)interval

Parameters

interval

【选填】同步间隔，例如设置5秒

Discussion

Warning: 只对当前文件有效

一般在老师端视频加载完成后调用，切换文件后内部自动销毁定时器，

Declared In

TEduBoardController.h

stopSyncVideoStatus

停止同步视频状态

- (void)stopSyncVideoStatus

Discussion

Warning: 只对当前文件有效

Declared In

TEduBoardController.h

switchFile:

切换文件

- (void)switchFile:(NSString *)fileId

Parameters

fileId

要切换到的文件 ID

Discussion

Warning: 该接口仅可用于文件切换，如果传入的 fileId 为当前文件 ID，SDK 会忽略其它参数，不做任何操作

文件 ID 为必填项，为 nullptr 或空字符串将导致文件切换失败

Declared In

TEduBoardController.h

switchFile:boardId:stepIndex:

切换文件

- (void)switchFile:(NSString *)fileId boardId:(NSString *)boardId stepIndex:(NSInteger)stepIndex

Parameters

fileId

要切换到的文件 ID

boardId

切换文件并跳转到这个白板页

stepIndex

跳转到白板页并切换到这个动画

Discussion

Warning: 该接口仅可用于文件切换，如果传入的 fileId 为当前文件 ID，SDK 会忽略其它参数，不做任何操作

文件 ID 为必填项，为 nullptr 或空字符串将导致文件切换失败

Declared In

TEduBoardController.h

syncAndReload

同步本地发送失败的数据到远端并刷新本地数据

接口用途：此接口主要用于网络恢复后，同步本地数据到远端，拉取远端数据到本地 调用时机：在网络恢复后调用 使用限制： （1）仅支持2.4.9及以上版本 （2）如果历史数据还没有加载完成，则不允许重复调用，否则回调告警 TEDU_BOARD_WARNING_ILLEGAL_OPERATION

- (void)syncAndReload

Discussion

Warning: Reload等同于重新加载历史数据，会触发白板初始化时除onTEBInit之外的所有回调。

Declared In

TEduBoardController.h

syncRemoteTime:timestamp:

同步远端时间戳

- (void)syncRemoteTime:(NSString *)userId timestamp:(uint64_t)timestamp

Parameters

userId

远端用户 ID

timestamp

远端用户毫秒级同步时间戳

Declared In

TEduBoardController.h

unInit

反初始化白板

- (void)unInit

Discussion

Warning: 调用反初始化接口后会释放内部资源，白板功能将失效。

Declared In

TEduBoardController.h

undo

撤销当前白板页上一次动作

- (void)undo

Declared In

TEduBoardController.h

updateElementById:position:

设置元素的位置，TEduElementOperatorTypeCHANGE_POSITION

- (void)updateElementById:(NSString *)elementId position:(CGPoint)offset

Parameters

elementId

元素id

offset

偏移量 元素在x、y轴上的偏移 offset.x为负数表示左移，正数表示右移 offset.y为负数表示上移，正数表示下移

Declared In

TEduBoardController.h

updateElementById:type:value:

设置元素样式

- (void)updateElementById:(NSString *)elementId type:(TEduElementOperatorType)type value:(NSString *)value

Parameters

elementId

元素id

type

[必填]元素操作类型 元素操作类型 TEduElementOperatorType

value

与元素操作类型对应 TEduElementOperatorTypeBOARDER_COLOR:颜色值,如@“rgba(255, 0, 0, 1)”; TEduElementOperatorTypeBOARDER_WIDTH: 线宽度值, 如'500'; TEduElementOperatorTypeBOARDER_LINE_TYPE: TEduBoardLineType 如TEDU_BOARD_LINE_TYPE_SOLID则为@“1”; TEduElementOperatorTypeEL_DELETE: 传空字符串

Declared In

TEduBoardController.h

useMathTool:

使用数学教具

- (void)useMathTool:(TEduMathToolType)mathToolType

Parameters

mathToolType

【必填】要使用的数学教具TEduMathToolType

Declared In

TEduBoardController.h