白板控制器更多...

#include <TEduBoard.h>

Public 成员函数
设置 TEduBoardCallback 回调
virtual void	AddCallback (TEduBoardCallback *callback)=0
	设置事件回调监听更多...

virtual void	RemoveCallback (TEduBoardCallback *callback)=0
	删除事件回调监听更多...

基本流程接口
virtual void	Init (const TEduBoardInitParam &initParam=TEduBoardInitParam())=0
	初始化白板更多...

virtual WINDOW_HANDLE	GetBoardRenderView ()=0
	获取白板渲染 View 更多...

virtual void	Refresh ()=0
	刷新当前页白板，触发 onTEBRefresh 回调更多...

virtual void	SyncAndReload ()=0
	同步本地发送失败的数据到远端并刷新本地数据更多...

virtual void	AddSyncData (const char *data)=0
	添加白板同步数据更多...

virtual void	SetDataSyncEnable (bool enable)=0
	设置白板是否开启数据同步更多...

virtual bool	IsDataSyncEnable ()=0
	获取白板是否开启数据同步更多...

virtual void	Reset ()=0
	重置白板更多...

virtual const char *	ExportInLocalMode (const char *filter=nullptr)=0
	导出白板数据，可用于本地还原更多...

virtual void	ImportInLocalMode (const char data, const char filter=nullptr)=0
	导入白板数据，可用于本地还原更多...

virtual void	SetBoardRenderViewPos (int32_t x, int32_t y, uint32_t width, uint32_t height)=0
	设置白板渲染 View 的位置和大小更多...

virtual uint64_t	GetSyncTime ()=0
	获取同步时间戳更多...

virtual void	SyncRemoteTime (const char *userId, uint64_t timestamp)=0
	同步远端时间戳更多...

virtual void	SetSystemCursorEnable (bool enable)=0
	是否启用原生系统光标更多...

virtual void	AddBackupDomain (const char domain, const char backup, uint32_t priority=0)=0

virtual void	RemoveBackupDomain (const char domain, const char backup)=0

virtual void	SetProxyServer (const char *settingStr)=0
	设置服务的代理服务器更多...

virtual const char *	CallExperimentalAPI (const char *apiExp)=0
	调用白板实验性接口更多...

离屏渲染输入事件相关接口
virtual void	SendKeyEvent (const TEduBoardKeyEvent &event)=0
	发送键盘事件到白板更多...

virtual void	SendMouseClickEvent (const TEduBoardMouseEvent &event, TEduBoardMouseButtonType type, bool mouseUp, int clickCount)=0
	发送鼠标点击事件到白板更多...

virtual void	SendMouseMoveEvent (const TEduBoardMouseEvent &event, bool mouseLeave)=0
	发送鼠标移动事件到白板更多...

virtual void	SendMouseWheelEvent (const TEduBoardMouseEvent &event, int deltaX, int deltaY)=0
	发送鼠标滚轮事件到白板更多...

virtual void	SendTouchEvent (const TEduBoardTouchEvent &event)=0
	发送触摸事件到白板更多...

涂鸦相关接口
virtual void	SetDrawEnable (bool enable)=0
	设置白板是否允许涂鸦更多...

virtual bool	IsDrawEnable ()=0
	获取白板是否允许涂鸦更多...

virtual void	SetHandwritingEnable (bool enable)=0
	设置白板是否开启笔锋特性更多...

virtual bool	IsHandwritingEnable ()=0
	获取白板是否开启笔锋特性更多...

virtual void	SetEraseLayerLimit (uint32_t limit=0)=0
	设置橡皮擦单次擦除图层数量更多...

virtual void	SetEraseLayerType (const TEduBoardErasableElementType *typeArr=nullptr, uint32_t typeArrCount=0)=0
	限制橡皮擦可擦除的白板元素类型更多...

virtual void	SetAccessibleUsers (char *users, uint32_t userCount, TEduBoardAccessibleOperation operatorType, uint32_t typeCount)=0
	设置允许操作哪些用户绘制的图形更多...

virtual void	SetGlobalBackgroundColor (const TEduBoardColor &color)=0
	设置所有白板的背景色更多...

virtual TEduBoardColor	GetGlobalBackgroundColor ()=0
	获取白板全局背景色更多...

virtual void	SetBackgroundColor (const TEduBoardColor &color)=0
	设置当前白板页的背景色更多...

virtual TEduBoardColor	GetBackgroundColor ()=0
	获取当前白板页的背景色更多...

virtual void	SetToolType (TEduBoardToolType type)=0
	设置要使用的白板工具更多...

virtual TEduBoardToolType	GetToolType ()=0
	获取正在使用的白板工具更多...

virtual void	SetToolTypeTitle (const char title, const TEduBoardToolTypeTitleStyle style, TEduBoardToolType type)=0
	设置画笔和激光笔工具提示语更多...

virtual void	SetCursorIcon (TEduBoardToolType type, const TEduBoardCursorIcon &icon)=0
	自定义白板工具鼠标样式更多...

virtual void	SetBrushColor (const TEduBoardColor &color)=0
	设置画笔颜色更多...

virtual TEduBoardColor	GetBrushColor ()=0
	获取画笔颜色更多...

virtual void	SetBrushThin (uint32_t thin)=0
	设置画笔粗细更多...

virtual uint32_t	GetBrushThin ()=0
	获取画笔粗细更多...

virtual void	SetTextColor (const TEduBoardColor &color)=0
	设置文本颜色更多...

virtual TEduBoardColor	GetTextColor ()=0
	获取文本颜色更多...

virtual void	SetTextSize (uint32_t size)=0
	设置文本大小更多...

virtual uint32_t	GetTextSize ()=0
	获取文本大小更多...

virtual void	SetTextStyle (TEduBoardTextStyle style)=0
	设置文本样式更多...

virtual TEduBoardTextStyle	GetTextStyle ()=0
	获取文本样式更多...

virtual void	SetLineStyle (const TEduBoardLineStyle &style)=0
	设置直线样式更多...

virtual TEduBoardLineStyle	GetLineStyle ()=0
	获取直线样式更多...

virtual void	SetOvalDrawMode (TEduBoardOvalDrawMode drawMode)=0
	设置椭圆绘制模式更多...

virtual TEduBoardOvalDrawMode	GetOvalDrawMode ()=0
	获取椭圆绘制模式更多...

virtual void	Clear (bool clearBackground=false, bool clearSelectedOnly=false)=0
	清空当前白板页涂鸦更多...

virtual void	SetBackgroundImage (const char *url, TEduBoardImageFitMode mode)=0
	设置当前白板页的背景图片更多...

virtual TEduBackgroundImage	GetBackgroundImage (const char *boardId=nullptr)=0
	获取白板页背景图更多...

virtual void	SetBackgroundImageAngle (float angle)=0
	设置背景图片旋转角度更多...

virtual void	SetBackgroundH5 (const char *url)=0
	设置当前白板页的背景 H5 页面更多...

virtual void	Undo ()=0
	撤销当前白板页上一次动作更多...

virtual void	Redo ()=0
	重做当前白板页上一次撤销更多...

白板页操作接口
virtual const char *	AddBoard (const char *url=nullptr, const TEduBoardImageFitMode mode=TEDU_BOARD_IMAGE_FIT_MODE_CENTER, const TEduBoardBackgroundType type=TEDU_BOARD_BACKGROUND_IMAGE, bool needSwitch=true)=0
	增加一页白板更多...

virtual void	AddImageElement (const char *url)=0
	添加图片资源更多...

virtual const char *	AddElement (TEduBoardElementType type, TEduAddBoardBase *pTag, const TEduBoardElementOptions &options=TEduBoardElementOptions())=0

virtual bool	RemoveElement (const char *elementId)=0
	删除白板元素更多...

virtual void	LockElements (const char **elementIds, uint32_t idsCount, bool locked)=0

virtual TEduBoardElementInfoList *	GetBoardElementList (const char *boardId=nullptr, bool includeHideElement=false)=0
	获取白板中所有元素更多...

virtual void	SetElementsDisplay (TEduBoardElementType types, uint32_t typesCount, const char *ids, uint32_t idsCount, bool visible)=0
	设置元素显示状态更多...

virtual void	DeleteBoard (const char *boardId=nullptr)=0
	删除一页白板更多...

virtual void	PrevStep ()=0
	上一步每个 Step 对应 PPT 的一个动画效果，若当前没有已展示的动画效果，则该接口调用会导致向前翻页更多...

virtual void	NextStep ()=0
	下一步更多...

virtual void	PrevBoard (bool resetStep=false)=0
	向前翻页更多...

virtual void	NextBoard (bool resetStep=false)=0
	向后翻页更多...

virtual void	GotoBoard (const char *boardId, bool resetStep=false)=0
	跳转到指定白板页更多...

virtual const char *	GetCurrentBoard ()=0
	获取当前白板页 ID 更多...

virtual TEduBoardStringList *	GetBoardList ()=0
	获取所有文件的白板列表更多...

virtual void	SetBoardRatio (const char *ratio)=0
	设置当前白板页宽高比更多...

virtual const char *	GetBoardRatio ()=0
	获取当前白板页宽高比更多...

virtual void	SetBoardScale (uint32_t scale)=0
	设置当前白板页缩放比例更多...

virtual uint32_t	GetBoardScale ()=0
	获取当前白板页缩放比例更多...

virtual void	SetFileScale (const char *fileId, uint32_t scale)=0
	设置文件缩放比例更多...

virtual uint32_t	GetFileScale (const char *fileId)=0
	获取文件缩放比例更多...

virtual void	SetScaleToolRatio (uint32_t scale)=0
	设置白板缩放工具的缩放比例更多...

virtual void	SetScaleAnchor (double xRatio, double yRation)=0
	移动当前白板缩放展示位置更多...

virtual void	SetBoardContentFitMode (TEduBoardContentFitMode mode)=0
	设置白板内容自适应模式更多...

virtual TEduBoardContentFitMode	GetBoardContentFitMode ()=0
	获取白板内容自适应模式更多...

virtual void	Snapshot (const TEduBoardSnapshotInfo &info)=0
	白板快照更多...

virtual void	SetNextTextInput (const char *input, bool focus)=0
	预设文本工具内容更多...

virtual void	SetZoomCursorIcon (const TEduBoardCursorIcon &zoomIn, const TEduBoardCursorIcon &zoomOut)=0
	设置放大缩小工具的指针图标更多...

virtual void	SetRemoteCursorVisible (bool visible, TEduBoardRemoteCursorActionType mode)=0
	设置远端画笔在本地是否可见更多...

文件操作接口
virtual void	ApplyFileTranscode (const char *path, const TEduBoardTranscodeConfig &config=TEduBoardTranscodeConfig())=0
	发起文件转码请求更多...

virtual void	GetFileTranscodeProgress (const char *taskId)=0
	主动查询文件转码进度更多...

virtual const char *	AddTranscodeFile (const TEduBoardTranscodeFileResult &result, bool needSwitch=true)=0
	添加转码文件更多...

virtual const char *	AddImagesFile (const char *urls, uint32_t urlCount, const char title=nullptr, bool needSwitch=true)=0
	添加图片文件更多...

virtual const char *	AddVideoFile (const char url, const char title=nullptr, bool needSwitch=true)=0
	添加视频文件更多...

virtual void	ShowVideoControl (bool show)=0
	显示或隐藏视频控制栏更多...

virtual void	PlayVideo ()=0
	播放视频更多...

virtual void	PauseVideo ()=0
	暂停视频更多...

virtual void	SeekVideo (double time)=0
	跳转（仅支持点播视频）更多...

virtual void	SetSyncVideoStatusEnable (bool enable)=0
	是否同步本地视频操作到远端更多...

virtual void	StartSyncVideoStatus (uint32_t interval)=0
	内部启动定时器，定时同步视频状态到远端（仅限于 mp4）更多...

virtual void	StopSyncVideoStatus ()=0
	停止同步视频状态更多...

virtual void	EnableAudioControl (bool enable)=0
	是否启用音频控制面板更多...

virtual void	PlayAudio (const char *elementId)=0
	播放音频更多...

virtual void	PauseAudio (const char *elementId)=0
	暂停音频更多...

virtual void	SeekAudio (const char *elementId, double time)=0
	跳转更多...

virtual void	SetAudioVolume (const char *elementId, double volume)=0
	设置音频播放音量更多...

virtual double	GetAudioVolume (const char *elementId)=0
	获取音频播放音量更多...

virtual const char *	AddH5File (const char url, const char title=nullptr, bool needSwitch=true)=0
	添加 H5 页面更多...

virtual void	DeleteFile (const char *fileId)=0
	删除文件更多...

virtual void	SwitchFile (const char fileId, const char boardId=nullptr, int32_t stepIndex=-1)=0
	切换文件更多...

virtual const char *	GetCurrentFile ()=0
	获取当前文件 ID 更多...

virtual TEduBoardFileInfo	GetFileInfo (const char *fileId)=0
	获取白板中指定文件的文件信息更多...

virtual TEduBoardFileInfoList *	GetFileInfoList ()=0
	获取白板中上传的所有文件的文件信息列表更多...

virtual TEduBoardStringList *	GetFileBoardList (const char *fileId)=0
	获取指定文件的白板 ID 列表更多...

virtual TEduBoardStringList *	GetThumbnailImages (const char *fileId)=0
	获取指定文件的缩略图，不支持默认文件（fileId=DEFAULT）更多...

virtual void	ClearFileDraws (const char *fileId)=0
	清空指定文件的所有白板涂鸦更多...

virtual void	SetUserInfo (const TEduUserInfo &userInfo)=0
	设置用户信息更多...

virtual void	SetPenAutoFittingMode (const TEduBoardPenFittingMode &penMode)=0
	设置画笔自动拟合模式更多...

virtual void	AddSnapshotMark ()=0
	生成板书图片调用此接口可在后台生成当前白板的板书内容更多...

virtual void	SetMouseToolBehavior (const TEduMouseToolBehavior &turnPage)=0
	设置鼠标工具行为调用此接口设置鼠标工具行为更多...

virtual void	SetMathGraphType (const TEduBoardMathGraphType &graphType, bool setMouseToolopt=true)=0
	设置几何画板元素调用此接口设置几何画板元素更多...

virtual void	SetBoardRemark (const char boardId, const char remark)=0
	设置白板备注为某个白板设置备注, 当前白板可省略boardId参数更多...

virtual TEduBoardRemarkInfoList *	GetBoardRemark (const char *boardId=nullptr)=0
	获取白板备注更多...

virtual void	SetClassGroupEnable (bool enable)=0
	开启分组模式更多...

virtual bool	GetClassGroupEnable ()=0
	获取分组模式状态更多...

virtual void	SetClassGroup (const char groudId, char boards, uint32_t boardCount, char users, uint32_t userCount, const char titleId, const char *currentBoardId=nullptr)=0
	添加分组更多...

virtual void	ResetClassGroup ()=0
	重置所有分组更多...

virtual void	RemoveClassGroup (const char *groudId)=0
	删除分组更多...

virtual TEduBoardClassGroupInfo	GetClassGroupInfoByGroupId (const char *groupId)=0
	获取分组信息更多...

virtual TEduBoardStringList *	GetClassGroupIdByUserId (const char *userId)=0
	获取用户所在的分组更多...

virtual void	RemoveUserInClassGroup (const char group, const char userId)=0
	从分组中删除用户更多...

virtual void	RemoveBoardInClassGroup (const char group, const char boardId)=0
	从分组中删除白板更多...

virtual void	GotoClassGroupBoard (const char *boardId)=0
	分组内跳转分组模式下切换白板只能通过此方法进行，必须知道需要跳转的白板id 更多...

virtual void	SetClassGroupTitle (const char groupId, const char title)=0
	设置分组标题更多...

virtual void	AddBoardToClassGroup (const char groupId, const char boardId)=0
	新增白板ID 更多...

virtual void	AddUserToClassGroup (const char groupId, const char userId)=0
	添加用户到分组更多...

virtual TEduBoardStringList *	GetAllClassGroupIds ()=0
	获取所有分组id 更多...

virtual void	SetLogLevel (const TEduBoardLogLevel &logLevel)=0
	设置输出日志级别更多...

virtual void	SetScrollBarVisible (bool enable)=0
	设置白板滚动条是否可见更多...

virtual void	SetTextFontFamily (const char *fontFace)=0
	设置自定义字体更多...

virtual void	AddTextFontFamily (const char fontFace, const char fontUrl)=0
	添加自定义字体更多...

virtual const char *	GetTextFontFamily ()=0
	获取当前使用字体更多...

virtual void	GotoStep (const char *boardId, uint32_t step)=0
	跳转到指定动画步数更多...

virtual TEduScrollPosition	GetBoardScroll ()=0
	获取白板滚动位置更多...

virtual void	SetPiecewiseErasureEnable (bool enable)=0
	是否启用点擦（分段擦除）功能更多...

virtual bool	IsPiecewiseErasureEnable ()=0
	获取分段擦除模式开启状态更多...

virtual void	SetEraserSize (uint32_t radius)=0
	设置橡皮擦大小更多...

virtual uint32_t	GetEraserSize ()=0
	获取橡皮擦大小更多...

virtual void	SetGlobalBackgroundImage (const char *url, const TEduBoardImageFitMode mode, int type)=0
	设置白板背景图更多...

virtual TEduBackgroundImage	GetGlobalBackgroundImage ()=0
	获取白板背景图更多...

virtual void	SoundMuteForPPT (bool mute)=0
	对转码后的H5PPT进行静音更多...

virtual void	SetOwnerNickNameVisible (bool enable)=0
	是否显示自己的别名更多...

virtual TEduPPtRemarkInfoList *	GetPPtRemark (const char *fid, const int pageIndex=-1)=0
	获取ppt备注更多...

virtual void	UseMathTool (const TEduBoardMathToolType mathType)=0
	使用数学教具更多...

virtual TEduBoardSelectedElementInfo	GetElementById (const char *elementID)=0
	获取元素信息更多...

virtual void	UpdateElementById (const char *elementID, TEduBoardStyleObject &styleObj)=0
	设置元素样式更多...

virtual void	SetGraphStyle (TEduBoardGraphStyle &graphStyle)=0
	设置绘制图形得样式更多...

virtual TEduBoardGraphStyle	GetGraphStyle ()=0
	获取绘制图形样式结构更多...

virtual void	EnablePenAutoFit (bool enable, int delay=2000)=0
	开启绘制涂鸦过程中自动拟合图形更多...

virtual void	SetHighlighterColor (const TEduBoardColor &color)=0
	设置荧光笔颜色，画笔颜色用于所有荧光笔绘制更多...

virtual TEduBoardColor	GetHighlighterColor ()=0

virtual void	EnableMultiTouch (bool enable)=0
	设置是否开启多点触控更多...

virtual void	SetSyncFps (const int iFps)=0
	设置信令同步频率的更多...

virtual void	EnableShowGraffiti (bool enable)=0
	是否显示涂鸦更多...

virtual void	EnablePermissionChecker (char permissions, int permissionCount, char operatorUsers, int operatorCount, char **creatorUsers, int creatorCount)=0
	启用互动白板操作权限校验更多...

virtual void	DisablePermissionChecker (char **permissions, int permissionCount)=0
	关闭互动白板操作权限校验更多...

virtual void	ResetPermissionChecker ()=0
	重置互动白板操作权限校验更多...

virtual void	DisablePointerEventResponding (bool disable)=0
	禁止白板响应鼠标事件更多...

Protected 成员函数
virtual	~TEduBoardController ()=default

详细描述

白板控制器

构造及析构函数说明

◆ ~TEduBoardController()

virtual ~TEduBoardController ( )

protectedvirtualdefault

成员函数说明

◆ AddBackupDomain()

virtual void AddBackupDomain	(	const char *	domain,
		const char *	backup,
		uint32_t	priority = `0`
	)

pure virtual

添加备用域名

参数

domain	要添加备用域名的主域名
backup	要添加的备用域名
priority	备用域名优先级，数字越大优先级越高

主备域名均需要包含协议类型（支持http/https）当使用主域名访问资源超时后，按优先级逐个尝试使用备用域名去访问，资源访问超时时间默认为5秒多次调用此接口，可以为同一个主域名添加多个备用域名，重复添加相同的备用域名会被忽略

◆ AddBoard()

virtual const char* AddBoard	(	const char *	url = `nullptr`,
		const TEduBoardImageFitMode	mode = `TEDU_BOARD_IMAGE_FIT_MODE_CENTER`,
		const TEduBoardBackgroundType	type = `TEDU_BOARD_BACKGROUND_IMAGE`,
		bool	needSwitch = `true`
	)

pure virtual

增加一页白板

参数

url	要使用的背景图片 URL，编码格式为 UTF8，为 nullptr 表示不指定背景图片，只支持https协议的图片url
mode	要使用的图片填充对齐模式，当设置url时有效 TEduBoardImageFitMode
type	背景类型 TEduBoardBackgroundType
needSwitch	是否切换到添加的白板页

返回: 白板 ID

警告: 白板页会被添加到默认文件（文件 ID 为::DEFAULT)，自行上传的文件无法添加白板页触发 TEduBoard.EVEN.TEB_ADDBOARD 事件返回值内存由SDK内部管理，用户不需要自己释放

◆ AddBoardToClassGroup()

virtual void AddBoardToClassGroup	(	const char *	groupId,
		const char *	boardId
	)

pure virtual

新增白板ID

参数

groupId	分组id
boardId	白板id

返回

◆ AddCallback()

virtual void AddCallback ( TEduBoardCallback * callback )

pure virtual

设置事件回调监听

参数

callback 事件回调监听

警告: 建议在 Init 之前调用该方法以支持错误处理

◆ AddElement()

virtual const char* AddElement	(	TEduBoardElementType	type,
		TEduAddBoardBase *	pTag,
		const TEduBoardElementOptions &	options = `TEduBoardElementOptions()`
	)

pure virtual

添加白板元素

参数

type	元素类型，当设置TEDU_BOARD_ELEMENT_IMAGE时，等价于addImageElement方法
pTag	网页或者图片的 url，只支持 https 协议的网址或者图片 url，编码格式为 UTF8，为 nullptr 表示不指定URL
options	元素参数

返回: 元素ID

警告: （1）当 type = TEDU_BOARD_ELEMENT_IMAGE，支持 png、jpg、gif、svg 格式的本地和网络图片，当 url 是一个有效的本地文件地址时，该文件会被自动上传到 COS，上传进度回调 onTEBFileUploadStatus （2）当 type = TEDU_BOARD_ELEMENT_CUSTOM_GRAPH，仅支持网络 url，请与自定义图形工具 TEDU_BOARD_TOOL_TYPE_BOARD_CUSTOM_GRAPH 配合使用（3）当 type = TEDU_BOARD_ELEMENT_AUDIO 或 TEDU_BOARD_ELEMENT_GLOBAL_AUDIO，仅支持网络 url 对应类型和子类对象的匹配： TEDU_BOARD_ELEMENT_MATH_GRAPH --—> TEduAddBoardElementMathGraph TEDU_BOARD_ELEMENT_MATH_BOARD --—> TEduAddBoardElementMathBoard 其他类型暂时对应-—> TEduAddBoardElementUrl

◆ AddH5File()

virtual const char* AddH5File	(	const char *	url,
		const char *	title = `nullptr`,
		bool	needSwitch = `true`
	)

pure virtual

添加 H5 页面

注解: 只支持展示，不支持互动

参数

url	网页地址
title	文件名
needSwitch	添加文件后是否切换到该文件

返回: 文件 ID

◆ AddImageElement()

virtual void AddImageElement ( const char * url )

pure virtual

添加图片资源

参数

url	要添加的图片元素 URL 地址，编码格式为 UTF8

警告: 该接口已废弃，请使用AddElement接口代替

◆ AddImagesFile()

virtual const char* AddImagesFile	(	const char **	urls,
		uint32_t	urlCount,
		const char *	title = `nullptr`,
		bool	needSwitch = `true`
	)

pure virtual

添加图片文件

参数

urls	要使用的图片URL列表，编码格式为UTF8，不允许为nullptr
urlCount	图片URL个数
title	文件名
needSwitch	添加转码文件，是否需要立刻跳转到该文件，默认为 true

返回: 文件 ID

警告: 当传入文件的 URL 重复时，文件 ID 返回为空字符串; 在收到对应的 onTEBAddImagesFile 回调前，无法用返回的文件 ID 查询到文件信息

参见: TEduBoardCallback::onTEBAddImagesFile

文件加载成功后，将自动切换到该文件

◆ AddSnapshotMark()

virtual void AddSnapshotMark ( )

pure virtual

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

◆ AddSyncData()

virtual void AddSyncData ( const char * data )

pure virtual

添加白板同步数据

参数

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

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

◆ AddTextFontFamily()

virtual void AddTextFontFamily	(	const char *	fontFace,
		const char *	fontUrl
	)

pure virtual

添加自定义字体

参数

fontFace	字体样式名称
fontUrl	字体资源链接

返回

注解: 建议在创建白板实例后立刻调用;本地端和远端都需要设置字体样式，否则可能出现两端字体显示样式不同步;添加系统内置字体时，fontUrl可以传入空字符串

◆ AddTranscodeFile()

virtual const char* AddTranscodeFile	(	const TEduBoardTranscodeFileResult &	result,
		bool	needSwitch = `true`
	)

pure virtual

添加转码文件

参数

result	文件转码结果
needSwitch	是否需要在文件加载成功后自动切换到该文件

返回: 文件 ID

警告: 当传入文件的 URL 重复时，返回 URL 对应的文件 ID; 在收到对应的 onTEBAddTranscodeFile 回调前，无法用返回的文件 ID 查询到文件信息

参见: TEduBoardCallback::onTEBAddTranscodeFile

TEduBoardTranscodeFileResult 的字段信息主要来自：

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

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

◆ AddUserToClassGroup()

virtual void AddUserToClassGroup	(	const char *	groupId,
		const char *	userId
	)

pure virtual

添加用户到分组

参数

groupId	分组id
userId	用户id

返回

◆ AddVideoFile()

virtual const char* AddVideoFile	(	const char *	url,
		const char *	title = `nullptr`,
		bool	needSwitch = `true`
	)

pure virtual

添加视频文件

参数

url	文件播放地址
title	文件名
needSwitch	添加转码文件，是否需要立刻跳转到该文件，默认为 true

返回: 文件 ID

移动端支持 mp4/m3u8，桌面端支持 mp4/m3u8/flv/rtmp；触发状态改变回调 onTEBVideoStatusChange

◆ ApplyFileTranscode()

virtual void ApplyFileTranscode	(	const char *	path,
		const TEduBoardTranscodeConfig &	config = `TEduBoardTranscodeConfig()`
	)

pure virtual

发起文件转码请求

参数

path	要转码的文件路径，编码格式为 UTF8
config	转码参数

警告: 本接口设计用于在接入阶段快速体验转码功能，原则上不建议在生产环境中使用，生产环境中的转码请求建议使用后台服务接口发起; 从2.6.5版本起此接口被废弃，请使用腾讯云文档转码服务进行文档转码

参见: TEduBoardCallback::onTEBFileTranscodeProgress

支持 PPT、PDF、Word 文件转码 PPT 文档默认转为 H5 动画，能够还原 PPT 原有动画效果，其它文档转码为静态图片 PPT 动画转码耗时约1秒/页，所有文档的静态转码耗时约0.5秒/页转码进度和结果将会通过 onTEBFileTranscodeProgress 回调返回，详情参见该回调说明文档

◆ CallExperimentalAPI()

virtual const char* CallExperimentalAPI ( const char * apiExp )

pure virtual

调用白板实验性接口

参数

apiExp 要执行的白板相关 JS 代码

返回: JS 执行后的返回值转换而来的字符串

◆ Clear()

virtual void Clear	(	bool	clearBackground = `false`,
		bool	clearSelectedOnly = `false`
	)

pure virtual

清空当前白板页涂鸦

参数

clearBackground	是否同时清空背景色以及背景图片
clearSelectedOnly	是否只清除选中部分涂鸦

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

◆ ClearFileDraws()

virtual void ClearFileDraws ( const char * fileId )

pure virtual

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

参数

fileId 文件 ID

◆ DeleteBoard()

virtual void DeleteBoard ( const char * boardId = nullptr )

pure virtual

删除一页白板

参数

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

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

◆ DeleteFile()

virtual void DeleteFile ( const char * fileId )

pure virtual

删除文件

参数

fileId 要删除的文件 ID

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

◆ DisablePermissionChecker()

virtual void DisablePermissionChecker	(	char **	permissions,
		int	permissionCount
	)

pure virtual

关闭互动白板操作权限校验

参数

TEduBoardPermissionParam

返回

◆ DisablePointerEventResponding()

virtual void DisablePointerEventResponding ( bool disable )

pure virtual

禁止白板响应鼠标事件

参数

disable true 表示禁止白板响应鼠标事件 false 表示允许响应鼠标事件

返回

◆ EnableAudioControl()

virtual void EnableAudioControl ( bool enable )

pure virtual

是否启用音频控制面板

参数

enable 启用或禁止

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

◆ EnableMultiTouch()

virtual void EnableMultiTouch ( bool enable )

pure virtual

设置是否开启多点触控

参数

enable 是否开启多点触控：true 开启；false 关闭

返回

◆ EnablePenAutoFit()

virtual void EnablePenAutoFit	(	bool	enable,
		int	delay = `2000`
	)

pure virtual

开启绘制涂鸦过程中自动拟合图形

参数

enable	是否开启拟合：true 开启；false 关闭
delay	触发时延，默认2000ms

返回

◆ EnablePermissionChecker()

virtual void EnablePermissionChecker	(	char **	permissions,
		int	permissionCount,
		char **	operatorUsers,
		int	operatorCount,
		char **	creatorUsers,
		int	creatorCount
	)

pure virtual

启用互动白板操作权限校验

参数

users userid 列表; userCount：用户个数，operatorType：操作类型: 0:creator;1:operator ,permissionParam 权限设置参数结构体

返回

◆ EnableShowGraffiti()

virtual void EnableShowGraffiti ( bool enable )

pure virtual

是否显示涂鸦

参数

enable true 显示；false 不显示

返回

◆ ExportInLocalMode()

virtual const char* ExportInLocalMode ( const char * filter = nullptr )

pure virtual

导出白板数据，可用于本地还原

参数

filter 导出数据过滤规则，JSON格式字符串，具体格式参见 Web端文档

◆ GetAllClassGroupIds()

virtual TEduBoardStringList* GetAllClassGroupIds ( )

pure virtual

获取所有分组id

参数

◆ GetAudioVolume()

virtual double GetAudioVolume ( const char * elementId )

pure virtual

获取音频播放音量

参数

elementId 调用 addElement 返回的元素 ID

返回: 当前音量

◆ GetBackgroundColor()

virtual TEduBoardColor GetBackgroundColor ( )

pure virtual

获取当前白板页的背景色

返回: 当前白板页的背景色

◆ GetBackgroundImage()

virtual TEduBackgroundImage GetBackgroundImage ( const char * boardId = nullptr )

pure virtual

获取白板页背景图

参数

要获取背景图的白板页ID，如果为空表示获取当前白板页的背景图

返回: TEduBackgroundImage白板背景图结构

注解: end 2.6.8

◆ GetBoardContentFitMode()

virtual TEduBoardContentFitMode GetBoardContentFitMode ( )

pure virtual

获取白板内容自适应模式

返回: 白板内容自适应模式

◆ GetBoardElementList()

virtual TEduBoardElementInfoList* GetBoardElementList	(	const char *	boardId = `nullptr`,
		bool	includeHideElement = `false`
	)

pure virtual

获取白板中所有元素

参数

boardId	白板 ID，如果为空则获取当前白板所有元素
includeHideElement	是否包含隐藏元素（使用SetElementsDisplay接口隐藏的元素），删除元素不返回（橡皮擦，RemoveElement接口）

返回: 白板元素列表

◆ GetBoardList()

virtual TEduBoardStringList* GetBoardList ( )

pure virtual

获取所有文件的白板列表

返回: 所有文件的白板列表

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

◆ GetBoardRatio()

virtual const char* GetBoardRatio ( )

pure virtual

获取当前白板页宽高比

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

◆ GetBoardRemark()

virtual TEduBoardRemarkInfoList* GetBoardRemark ( const char * boardId = nullptr )

pure virtual

获取白板备注

参数

boardId 为空时，获取所有设置过白板备注

返回: 返回白板备注列表

◆ GetBoardRenderView()

virtual WINDOW_HANDLE GetBoardRenderView ( )

pure virtual

获取白板渲染 View

返回: 白板渲染 View

◆ GetBoardScale()

virtual uint32_t GetBoardScale ( )

pure virtual

获取当前白板页缩放比例

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

◆ GetBoardScroll()

virtual TEduScrollPosition GetBoardScroll ( )

pure virtual

获取白板滚动位置

返回: 白板滚动位置 scrollLeft, scrollTop 以百分比形式展示，范围在 [0,1]

◆ GetBrushColor()

virtual TEduBoardColor GetBrushColor ( )

pure virtual

获取画笔颜色

返回: 画笔颜色

◆ GetBrushThin()

virtual uint32_t GetBrushThin ( )

pure virtual

获取画笔粗细

返回: 画笔粗细

◆ GetClassGroupEnable()

virtual bool GetClassGroupEnable ( )

pure virtual

获取分组模式状态

返回: true: 开启 false: 未开启

◆ GetClassGroupIdByUserId()

virtual TEduBoardStringList* GetClassGroupIdByUserId ( const char * userId )

pure virtual

获取用户所在的分组

参数

userId 用户id

返回

◆ GetClassGroupInfoByGroupId()

virtual TEduBoardClassGroupInfo GetClassGroupInfoByGroupId ( const char * groupId )

pure virtual

获取分组信息

参数

groupId 分组id

返回: 分组信息

◆ GetCurrentBoard()

virtual const char* GetCurrentBoard ( )

pure virtual

获取当前白板页 ID

返回: 当前白板页 ID

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

◆ GetCurrentFile()

virtual const char* GetCurrentFile ( )

pure virtual

获取当前文件 ID

返回: 当前文件 ID

◆ GetElementById()

virtual TEduBoardSelectedElementInfo GetElementById ( const char * elementID )

pure virtual

获取元素信息

参数

elementId 设置元素样式

返回

◆ GetEraserSize()

virtual uint32_t GetEraserSize ( )

pure virtual

获取橡皮擦大小

返回: 橡皮擦大小，单位：像素

◆ GetFileBoardList()

virtual TEduBoardStringList* GetFileBoardList ( const char * fileId )

pure virtual

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

参数

fileId 文件 ID

返回: 白板 ID 列表

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

◆ GetFileInfo()

virtual TEduBoardFileInfo GetFileInfo ( const char * fileId )

pure virtual

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

返回: 文件信息

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

◆ GetFileInfoList()

virtual TEduBoardFileInfoList* GetFileInfoList ( )

pure virtual

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

返回: 文件信息列表

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

◆ GetFileScale()

virtual uint32_t GetFileScale ( const char * fileId )

pure virtual

获取文件缩放比例

参数

fileId 文件ID

返回: 文件缩放比例，格式与 SetFileScale 接口参数格式一致

◆ GetFileTranscodeProgress()

virtual void GetFileTranscodeProgress ( const char * taskId )

pure virtual

主动查询文件转码进度

参数

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

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

参见: TEduBoardCallback::onTEBFileTranscodeProgress

转码进度和结果将会通过 onTEBFileTranscodeProgress 回调返回，详情参见该回调说明文档

◆ GetGlobalBackgroundColor()

virtual TEduBoardColor GetGlobalBackgroundColor ( )

pure virtual

获取白板全局背景色

返回: 全局背景色

◆ GetGlobalBackgroundImage()

virtual TEduBackgroundImage GetGlobalBackgroundImage ( )

pure virtual

获取白板背景图

返回: TEduBackgroundImage白板背景图结构

注解: end 2.6.8

◆ GetGraphStyle()

virtual TEduBoardGraphStyle GetGraphStyle ( )

pure virtual

获取绘制图形样式结构

返回: TEduBoardGraphStyle绘制图形样式结构

◆ GetHighlighterColor()

virtual TEduBoardColor GetHighlighterColor ( )

pure virtual

获取荧光笔颜色

返回: TEduBoardColor 荧光笔颜色

◆ GetLineStyle()

virtual TEduBoardLineStyle GetLineStyle ( )

pure virtual

获取直线样式

返回: 直线样式

◆ GetOvalDrawMode()

virtual TEduBoardOvalDrawMode GetOvalDrawMode ( )

pure virtual

获取椭圆绘制模式

返回: 椭圆绘制模式

◆ GetPPtRemark()

virtual TEduPPtRemarkInfoList* GetPPtRemark	(	const char *	fid,
		const int	pageIndex = `-1`
	)

pure virtual

获取ppt备注

参数

fid	文件id 必填项
pageIndex	ppt索引页，-1或者默认值：获取当前文件下所有ppt页面的备注;索引从0开始

返回: 返回fid对应的ppt备注列表

注解: 此方法的回调时机：收到TEDU_BOARD_H5_PPT_STATUS_LOADED状态后才能调用改接口

◆ GetSyncTime()

virtual uint64_t GetSyncTime ( )

pure virtual

获取同步时间戳

返回: 毫秒级同步时间戳

◆ GetTextColor()

virtual TEduBoardColor GetTextColor ( )

pure virtual

获取文本颜色

返回: 文本颜色

◆ GetTextFontFamily()

virtual const char* GetTextFontFamily ( )

pure virtual

获取当前使用字体

返回: 当前使用字体

◆ GetTextSize()

virtual uint32_t GetTextSize ( )

pure virtual

获取文本大小

返回: 文本大小

◆ GetTextStyle()

virtual TEduBoardTextStyle GetTextStyle ( )

pure virtual

获取文本样式

返回: 文本样式

◆ GetThumbnailImages()

virtual TEduBoardStringList* GetThumbnailImages ( const char * fileId )

pure virtual

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

参数

fileId 文件 ID

返回: 缩略图 URL 列表

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

◆ GetToolType()

virtual TEduBoardToolType GetToolType ( )

pure virtual

获取正在使用的白板工具

返回: 正在使用的白板工具

◆ GotoBoard()

virtual void GotoBoard	(	const char *	boardId,
		bool	resetStep = `false`
	)

pure virtual

跳转到指定白板页

参数

boardId	要跳转到的白板页 ID
resetStep	指定翻到指定页以后是否重置 PPT 动画步数

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

◆ GotoClassGroupBoard()

virtual void GotoClassGroupBoard ( const char * boardId )

pure virtual

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

参数

boardId 白板id

返回

◆ GotoStep()

virtual void GotoStep	(	const char *	boardId,
		uint32_t	step
	)

pure virtual

跳转到指定动画步数

注解: begin 2.6.8

参数

boardId	白板id
step	动画步数

返回

◆ ImportInLocalMode()

virtual void ImportInLocalMode	(	const char *	data,
		const char *	filter = `nullptr`
	)

pure virtual

导入白板数据，可用于本地还原

参数

data	ExportInLocalMode()接口获取到的白板数据
filter	导入数据过滤规则，JSON格式字符串，具体格式参见 Web端文档

警告

当调用本接口时候，将直接覆盖本地数据
仅限于关闭数据同步的场景下使用（SetDataSyncEnable(false)）

◆ Init()

virtual void Init ( const TEduBoardInitParam & initParam = TEduBoardInitParam() )

pure virtual

初始化白板

参数

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

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

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

◆ IsDataSyncEnable()

virtual bool IsDataSyncEnable ( )

pure virtual

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

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

◆ IsDrawEnable()

virtual bool IsDrawEnable ( )

pure virtual

获取白板是否允许涂鸦

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

◆ IsHandwritingEnable()

virtual bool IsHandwritingEnable ( )

pure virtual

获取白板是否开启笔锋特性

返回: 是否开启笔锋特性

◆ IsPiecewiseErasureEnable()

virtual bool IsPiecewiseErasureEnable ( )

pure virtual

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

返回: true 已开启； false 未开启

◆ LockElements()

virtual void LockElements	(	const char **	elementIds,
		uint32_t	idsCount,
		bool	locked
	)

pure virtual

锁定元素

参数

elementIds	要修改的元素ID集合
idsCount	元素ID个数
locked	是否锁定

◆ NextBoard()

virtual void NextBoard ( bool resetStep = false )

pure virtual

向后翻页

参数

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

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

◆ NextStep()

virtual void NextStep ( )

pure virtual

下一步

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

◆ PauseAudio()

virtual void PauseAudio ( const char * elementId )

pure virtual

暂停音频

参数

elementId 调用 addElement 方法返回的元素 ID

触发状态改变回调 onTEBAudioStatusChange

◆ PauseVideo()

virtual void PauseVideo ( )

pure virtual

暂停视频

警告: 只对当前文件有效

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

◆ PlayAudio()

virtual void PlayAudio ( const char * elementId )

pure virtual

播放音频

参数

elementId 调用 addElement 方法返回的元素 ID

触发状态改变回调 onTEBAudioStatusChange

◆ PlayVideo()

virtual void PlayVideo ( )

pure virtual

播放视频

警告: 只对当前文件有效

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

◆ PrevBoard()

virtual void PrevBoard ( bool resetStep = false )

pure virtual

向前翻页

参数

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

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

◆ PrevStep()

virtual void PrevStep ( )

pure virtual

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

◆ Redo()

virtual void Redo ( )

pure virtual

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

◆ Refresh()

virtual void Refresh ( )

pure virtual

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

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

◆ RemoveBackupDomain()

virtual void RemoveBackupDomain	(	const char *	domain,
		const char *	backup
	)

pure virtual

删除备用域名

参数

domain	要删除备用域名的主域名
backup	要删除的备用域名，nullptr或空字符串表示删除主域名对应的所有备用域名

◆ RemoveBoardInClassGroup()

virtual void RemoveBoardInClassGroup	(	const char *	group,
		const char *	boardId
	)

pure virtual

从分组中删除白板

参数

group	分组id
boardId	白板id

返回

◆ RemoveCallback()

virtual void RemoveCallback ( TEduBoardCallback * callback )

pure virtual

删除事件回调监听

参数

callback 事件回调监听

◆ RemoveClassGroup()

virtual void RemoveClassGroup ( const char * groudId )

pure virtual

删除分组

参数

groudId 分组id

返回

◆ RemoveElement()

virtual bool RemoveElement ( const char * elementId )

pure virtual

删除白板元素

参数

elementId 元素 ID（特殊ID：'-100' -> 图片水印，'-101' -> 动态文本水印，'-102' -> 静态文本水印）

返回: 删除操作是否成功

◆ RemoveUserInClassGroup()

virtual void RemoveUserInClassGroup	(	const char *	group,
		const char *	userId
	)

pure virtual

从分组中删除用户

参数

group	分组id
userId	用户id

返回

◆ Reset()

virtual void Reset ( )

pure virtual

重置白板

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

◆ ResetClassGroup()

virtual void ResetClassGroup ( )

pure virtual

重置所有分组

返回

◆ ResetPermissionChecker()

virtual void ResetPermissionChecker ( )

pure virtual

重置互动白板操作权限校验

返回

◆ SeekAudio()

virtual void SeekAudio	(	const char *	elementId,
		double	time
	)

pure virtual

跳转

参数

elementId	调用 addElement 方法返回的元素 ID
time	播放进度，单位秒

触发状态改变回调 onTEBAudioStatusChange

◆ SeekVideo()

virtual void SeekVideo ( double time )

pure virtual

跳转（仅支持点播视频）

参数

time 播放进度，单位秒

警告: 只对当前文件有效

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

◆ SendKeyEvent()

virtual void SendKeyEvent ( const TEduBoardKeyEvent & event )

pure virtual

发送键盘事件到白板

参数

event 要发送的键盘事件

◆ SendMouseClickEvent()

virtual void SendMouseClickEvent	(	const TEduBoardMouseEvent &	event,
		TEduBoardMouseButtonType	type,
		bool	mouseUp,
		int	clickCount
	)

pure virtual

发送鼠标点击事件到白板

参数

event	要发送的鼠标事件
type	鼠标按键类型
mouseUp	鼠标是否弹起
clickCount	点击次数

◆ SendMouseMoveEvent()

virtual void SendMouseMoveEvent	(	const TEduBoardMouseEvent &	event,
		bool	mouseLeave
	)

pure virtual

发送鼠标移动事件到白板

参数

event	要发送的鼠标事件
mouseLeave	鼠标是否离开白板

◆ SendMouseWheelEvent()

virtual void SendMouseWheelEvent	(	const TEduBoardMouseEvent &	event,
		int	deltaX,
		int	deltaY
	)

pure virtual

发送鼠标滚轮事件到白板

参数

event	要发送的鼠标事件
deltaX	滚轮在X方向的移动增量
deltaY	滚轮在Y方向的移动增量

◆ SendTouchEvent()

virtual void SendTouchEvent ( const TEduBoardTouchEvent & event )

pure virtual

发送触摸事件到白板

参数

event 要发送的触摸事件

◆ SetAccessibleUsers()

virtual void SetAccessibleUsers	(	char **	users,
		uint32_t	userCount,
		TEduBoardAccessibleOperation *	operatorType,
		uint32_t	typeCount
	)

pure virtual

设置允许操作哪些用户绘制的图形

参数

users	指定允许操作的用户集，为 nullptr 表示不加限制
userCount	指定 users 参数包含的用户个数
operatorType	用户操作类型
typeCount	操作类型个数该接口会产生以下影响： ERASER 工具只能擦除 users 参数列出的用户绘制的涂鸦，无法擦除其他人绘制的涂鸦 POINTSELECT、SELECT 工具只能选中 users 参数列出的用户绘制的涂鸦，无法选中其他人绘制的涂鸦 clear 接口只能用于清空选中涂鸦以及 users 参数列出的用户绘制的涂鸦，无法清空背景及其他人绘制的涂鸦白板包含的其他功能未在本列表明确列出者都可以确定不受本接口影响

◆ SetAudioVolume()

virtual void SetAudioVolume	(	const char *	elementId,
		double	volume
	)

pure virtual

设置音频播放音量

参数

elementId	调用 addElement 返回的元素 ID
volume	音频音量，取值范围[0-1]

◆ SetBackgroundColor()

virtual void SetBackgroundColor ( const TEduBoardColor & color )

pure virtual

设置当前白板页的背景色

参数

color 要设置的背景色

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

◆ SetBackgroundH5()

virtual void SetBackgroundH5 ( const char * url )

pure virtual

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

参数

url	要设置的背景 H5 页面 URL

该接口与 SetBackgroundImage 接口互斥

◆ SetBackgroundImage()

virtual void SetBackgroundImage	(	const char *	url,
		TEduBoardImageFitMode	mode
	)

pure virtual

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

参数

url	要设置的背景图片 URL，编码格式为 UTF8
mode	要使用的图片填充对齐模式

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

◆ SetBackgroundImageAngle()

virtual void SetBackgroundImageAngle ( float angle )

pure virtual

设置背景图片旋转角度

参数

angle 旋转角度(0-360)

◆ SetBoardContentFitMode()

virtual void SetBoardContentFitMode ( TEduBoardContentFitMode mode )

pure virtual

设置白板内容自适应模式

参数

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

设置自适应模式后会影响所有后续白板内容操作,受影响接口包括：AddTranscodeFile

◆ SetBoardRatio()

virtual void SetBoardRatio ( const char * ratio )

pure virtual

设置当前白板页宽高比

参数

ratio 要设置的白板宽高比

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

◆ SetBoardRemark()

virtual void SetBoardRemark	(	const char *	boardId,
		const char *	remark
	)

pure virtual

设置白板备注为某个白板设置备注, 当前白板可省略boardId参数

参数

boardId	白板id
remark	对应白板备注

◆ SetBoardRenderViewPos()

virtual void SetBoardRenderViewPos	(	int32_t	x,
		int32_t	y,
		uint32_t	width,
		uint32_t	height
	)

pure virtual

设置白板渲染 View 的位置和大小

参数

x	要设置的白板渲染 View 的位置X分量
y	要设置的白板渲染 View 的位置Y分量
width	要设置的白板渲染 View 的宽度
height	要设置的白板渲染 View 的高度

白板渲染 View 有父窗口时，(x, y) 指定相对其父窗口的位置

◆ SetBoardScale()

virtual void SetBoardScale ( uint32_t scale )

pure virtual

设置当前白板页缩放比例

参数

scale 要设置的白板缩放比例

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

◆ SetBrushColor()

virtual void SetBrushColor ( const TEduBoardColor & color )

pure virtual

设置画笔颜色

参数

color 要设置的画笔颜色

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

◆ SetBrushThin()

virtual void SetBrushThin ( uint32_t thin )

pure virtual

设置画笔粗细

参数

thin 要设置的画笔粗细

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

◆ SetClassGroup()

virtual void SetClassGroup	(	const char *	groudId,
		char **	boards,
		uint32_t	boardCount,
		char **	users,
		uint32_t	userCount,
		const char *	titleId,
		const char *	currentBoardId = `nullptr`
	)

pure virtual

添加分组

参数

groudId	分组id
boards	分组白板列表
boardCount	分组白板个数
users	分组用户列表
userCount	分组用户个数
titleId	分组标题
currentBoardId	分组初始白板

返回

◆ SetClassGroupEnable()

virtual void SetClassGroupEnable ( bool enable )

pure virtual

开启分组模式

参数

enable 是否启用

◆ SetClassGroupTitle()

virtual void SetClassGroupTitle	(	const char *	groupId,
		const char *	title
	)

pure virtual

设置分组标题

参数

groupId	分组id
title	分组标题

返回

◆ SetCursorIcon()

virtual void SetCursorIcon	(	TEduBoardToolType	type,
		const TEduBoardCursorIcon &	icon
	)

pure virtual

自定义白板工具鼠标样式

参数

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

◆ SetDataSyncEnable()

virtual void SetDataSyncEnable ( bool enable )

pure virtual

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

参数

enable 是否开启

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

◆ SetDrawEnable()

virtual void SetDrawEnable ( bool enable )

pure virtual

设置白板是否允许涂鸦

参数

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

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

◆ SetElementsDisplay()

virtual void SetElementsDisplay	(	TEduBoardElementType *	types,
		uint32_t	typesCount,
		const char **	ids,
		uint32_t	idsCount,
		bool	visible
	)

pure virtual

设置元素显示状态

参数

types	要设置的元素类型，支持指定多个
typesCount	要设置的元素类型个数
ids	要设置的元素ID，支持指定多个
idsCount	要设置的元素ID个数
visible	是否显示

◆ SetEraseLayerLimit()

virtual void SetEraseLayerLimit ( uint32_t limit = 0 )

pure virtual

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

参数

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

单次擦除：鼠标/手指按下 -> 鼠标/手指移动 -> 鼠标/手指抬起。

◆ SetEraseLayerType()

virtual void SetEraseLayerType	(	const TEduBoardErasableElementType *	typeArr = `nullptr`,
		uint32_t	typeArrCount = `0`
	)

pure virtual

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

参数

typeArr	限制可擦除的白板元素类型数组，默认为nullptr则不限制元素类型
typeArrCount	要限制的可擦除的白板元素类型数量

◆ SetEraserSize()

virtual void SetEraserSize ( uint32_t radius )

pure virtual

设置橡皮擦大小

参数

radius 橡皮擦擦除半径，单位：像素

返回

◆ SetFileScale()

virtual void SetFileScale	(	const char *	fileId,
		uint32_t	scale
	)

pure virtual

设置文件缩放比例

参数

fileId	文件ID
scale	要设置的文件缩放比例

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

◆ SetGlobalBackgroundColor()

virtual void SetGlobalBackgroundColor ( const TEduBoardColor & color )

pure virtual

设置所有白板的背景色

参数

color 要设置的全局背景色

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

◆ SetGlobalBackgroundImage()

virtual void SetGlobalBackgroundImage	(	const char *	url,
		const TEduBoardImageFitMode	mode,
		int	type
	)

pure virtual

设置白板背景图

参数

url	资源链接
mode	图片填充对齐模式
type	背景类型（0: 背景图 1：H5）

返回

◆ SetGraphStyle()

virtual void SetGraphStyle ( TEduBoardGraphStyle & graphStyle )

pure virtual

设置绘制图形得样式

参数

elementId 绘制图形样式结构

返回

◆ SetHandwritingEnable()

virtual void SetHandwritingEnable ( bool enable )

pure virtual

设置白板是否开启笔锋特性

参数

enable 是否开启笔锋，true 表示开启，false 表示关闭

白板创建后默认为关闭

◆ SetHighlighterColor()

virtual void SetHighlighterColor ( const TEduBoardColor & color )

pure virtual

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

参数

TEduBoardColor color 要设置的荧光笔颜色

返回

◆ SetLineStyle()

virtual void SetLineStyle ( const TEduBoardLineStyle & style )

pure virtual

设置直线样式

参数

style 要设置的直线样式

◆ SetLogLevel()

virtual void SetLogLevel ( const TEduBoardLogLevel & logLevel )

pure virtual

设置输出日志级别

参数

logLevel 控制台输出的日志级别

返回

注解: 建议在白板实例创建后立即调用低于 level 的日志将不会输出

◆ SetMathGraphType()

virtual void SetMathGraphType	(	const TEduBoardMathGraphType &	graphType,
		bool	setMouseToolopt = `true`
	)

pure virtual

设置几何画板元素调用此接口设置几何画板元素

参数

graphType	几何图形类型
setMouseToolopt	是否切换到鼠标工具默认为true

◆ SetMouseToolBehavior()

virtual void SetMouseToolBehavior ( const TEduMouseToolBehavior & turnPage )

pure virtual

设置鼠标工具行为调用此接口设置鼠标工具行为

◆ SetNextTextInput()

virtual void SetNextTextInput	(	const char *	input,
		bool	focus
	)

pure virtual

预设文本工具内容

参数

input	预设文本内容，取消预设则设置为空
focus	是否继续保持焦点

◆ SetOvalDrawMode()

virtual void SetOvalDrawMode ( TEduBoardOvalDrawMode drawMode )

pure virtual

设置椭圆绘制模式

参数

drawMode 要设置的椭圆绘制模式

◆ SetOwnerNickNameVisible()

virtual void SetOwnerNickNameVisible ( bool enable )

pure virtual

是否显示自己的别名

参数

enable:true 显示、false 不显示

返回

◆ SetPenAutoFittingMode()

virtual void SetPenAutoFittingMode ( const TEduBoardPenFittingMode & penMode )

pure virtual

设置画笔自动拟合模式

参数

penMode 画笔自动拟合模式 TEduBoardPenFittingMode

◆ SetPiecewiseErasureEnable()

virtual void SetPiecewiseErasureEnable ( bool enable )

pure virtual

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

参数

enable : true 支持；false 不支持

返回

注解: 1、只有2.6.8+的版本画线才能支持点擦，低于2.6.8以下版本的画线会整条线被擦除 2、观看端如果是低于2.6.8的版本，实时是看不到点擦变化，重新进课堂后能看到

◆ SetProxyServer()

virtual void SetProxyServer ( const char * settingStr )

pure virtual

设置服务的代理服务器

参数

settingStr 代理服务器配置字符串，字符串内容为一个JSON对象，格式参考如下：

{ '服务类型': '代理服务器地址', ... }

可选的服务类型如下： ALL 所有服务 TIW_SERVER 白板基础服务 TIW_RESOURCE 白板内部资源 PPT_THUMBNAIL PPT缩略图 LOG_SERVER 白板日志模块 LOG_KEY 关键日志 LOG_VERBOSE 流水日志

代理服务器的地址需包含协议类型（支持http/https），域名（IP地址）。端口若不填则默认使用80端口开启代理服务后，可在HTTP报文头部的X-Forwarded-Host字段获取代理的源域名。如果头部没有X-Forwarded-Host字段，需要将请求代理至https://res.qcloudtiw.com 服务类型必须全量代理，可使用ALL统一设置，也可以单独指定。单独指定的优先级高于ALL

◆ SetRemoteCursorVisible()

virtual void SetRemoteCursorVisible	(	bool	visible,
		TEduBoardRemoteCursorActionType	mode
	)

pure virtual

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

参数

visible	远端画笔在本地是否可见
mode	远端画笔操作类型

◆ SetScaleAnchor()

virtual void SetScaleAnchor	(	double	xRatio,
		double	yRation
	)

pure virtual

移动当前白板缩放展示位置

参数

xRatio	白板左上角X坐标，取值[0, 1]
yRation	白板左上角Y坐标，取值[0, 1]

◆ SetScaleToolRatio()

virtual void SetScaleToolRatio ( uint32_t scale )

pure virtual

设置白板缩放工具的缩放比例

参数

scale 如果设置为50，则每次滚轮滚动（或鼠标点击），缩放会在原来基础上进行50的缩放。等价于 teduBoard.setBoardScale(teduBoard.getBoardScale() + 50) 或 teduBoard.setBoardScale(teduBoard.getBoardScale() - 50)

◆ SetScrollBarVisible()

virtual void SetScrollBarVisible ( bool enable )

pure virtual

设置白板滚动条是否可见

参数

enable 是否可见

返回

◆ SetSyncFps()

virtual void SetSyncFps ( const int iFps )

pure virtual

设置信令同步频率的

参数

iFps	信令同步频率，该值的允许范围为 [5, 20]

返回

◆ SetSyncVideoStatusEnable()

virtual void SetSyncVideoStatusEnable ( bool enable )

pure virtual

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

参数

enable 是否同步

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

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

◆ SetSystemCursorEnable()

virtual void SetSystemCursorEnable ( bool enable )

pure virtual

是否启用原生系统光标

参数

enable 启用或禁用，默认禁用

◆ SetTextColor()

virtual void SetTextColor ( const TEduBoardColor & color )

pure virtual

设置文本颜色

参数

color 要设置的文本颜色

◆ SetTextFontFamily()

virtual void SetTextFontFamily ( const char * fontFace )

pure virtual

设置自定义字体

参数

fontFace 字体样式名称白板内置字体的样式为 'customFontFace'

返回

◆ SetTextSize()

virtual void SetTextSize ( uint32_t size )

pure virtual

设置文本大小

参数

size 要设置的文本大小

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

◆ SetTextStyle()

virtual void SetTextStyle ( TEduBoardTextStyle style )

pure virtual

设置文本样式

参数

style 要设置的文本样式

◆ SetToolType()

virtual void SetToolType ( TEduBoardToolType type )

pure virtual

设置要使用的白板工具

参数

type 要设置的白板工具

◆ SetToolTypeTitle()

virtual void SetToolTypeTitle	(	const char *	title,
		const TEduBoardToolTypeTitleStyle *	style,
		TEduBoardToolType	type
	)

pure virtual

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

参数

title	提示语
style	提示语样式，如果为nullptr，则使用默认样式

◆ SetUserInfo()

virtual void SetUserInfo ( const TEduUserInfo & userInfo )

pure virtual

设置用户信息

参数

userInfo 用户信息

◆ SetZoomCursorIcon()

virtual void SetZoomCursorIcon	(	const TEduBoardCursorIcon &	zoomIn,
		const TEduBoardCursorIcon &	zoomOut
	)

pure virtual

设置放大缩小工具的指针图标

参数

zoomIn	放大工具图标
zoomOut	缩小工具图标

◆ ShowVideoControl()

virtual void ShowVideoControl ( bool show )

pure virtual

显示或隐藏视频控制栏

参数

show 是否显示

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

◆ Snapshot()

virtual void Snapshot ( const TEduBoardSnapshotInfo & info )

pure virtual

白板快照

参数

info 快照信息

◆ SoundMuteForPPT()

virtual void SoundMuteForPPT ( bool mute )

pure virtual

对转码后的H5PPT进行静音

参数

mute(true:静音,false:取消静音)

返回

注解: 只能对本地生效,不会影响远端;只对当次有效,切换文件后需要重新调用v2.6.9

◆ StartSyncVideoStatus()

virtual void StartSyncVideoStatus ( uint32_t interval )

pure virtual

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

参数

interval 同步间隔，例如设置5秒

警告: 只对当前文件有效

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

◆ StopSyncVideoStatus()

virtual void StopSyncVideoStatus ( )

pure virtual

停止同步视频状态

警告: 只对当前文件有效

◆ SwitchFile()

virtual void SwitchFile	(	const char *	fileId,
		const char *	boardId = `nullptr`,
		int32_t	stepIndex = `-1`
	)

pure virtual

切换文件

参数

fileId	要切换到的文件 ID
boardId	切换文件并跳转到这个白板页
stepIndex	跳转到白板页并切换到这个动画

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

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

◆ SyncAndReload()

virtual void SyncAndReload ( )

pure virtual

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

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

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

◆ SyncRemoteTime()

virtual void SyncRemoteTime	(	const char *	userId,
		uint64_t	timestamp
	)

pure virtual

同步远端时间戳

参数

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

◆ Undo()

virtual void Undo ( )

pure virtual

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

◆ UpdateElementById()

virtual void UpdateElementById	(	const char *	elementID,
		TEduBoardStyleObject &	styleObj
	)

pure virtual

设置元素样式

参数

elementId	元素ID（特殊ID：'-100' -> 图片水印，'-101' -> 动态文本水印，'-102' -> 静态文本水印）
styleObj	元素样式

返回

◆ UseMathTool()

virtual void UseMathTool ( const TEduBoardMathToolType mathType )

pure virtual

使用数学教具

参数

mathType 数学教具类型

返回

Public 成员函数

Protected 成员函数

详细描述

构造及析构函数说明

◆ ~TEduBoardController()

成员函数说明

◆ AddBackupDomain()

◆ AddBoard()

◆ AddBoardToClassGroup()

◆ AddCallback()

◆ AddElement()

◆ AddH5File()

◆ AddImageElement()

◆ AddImagesFile()

◆ AddSnapshotMark()

◆ AddSyncData()

◆ AddTextFontFamily()

◆ AddTranscodeFile()

◆ AddUserToClassGroup()

◆ AddVideoFile()

◆ ApplyFileTranscode()

◆ CallExperimentalAPI()

◆ Clear()

◆ ClearFileDraws()

◆ DeleteBoard()

◆ DeleteFile()

◆ DisablePermissionChecker()

◆ DisablePointerEventResponding()

◆ EnableAudioControl()

◆ EnableMultiTouch()

◆ EnablePenAutoFit()

◆ EnablePermissionChecker()

◆ EnableShowGraffiti()

◆ ExportInLocalMode()

◆ GetAllClassGroupIds()

◆ GetAudioVolume()

◆ GetBackgroundColor()

◆ GetBackgroundImage()

◆ GetBoardContentFitMode()

◆ GetBoardElementList()

◆ GetBoardList()

◆ GetBoardRatio()

◆ GetBoardRemark()

◆ GetBoardRenderView()

◆ GetBoardScale()

◆ GetBoardScroll()

◆ GetBrushColor()

◆ GetBrushThin()

◆ GetClassGroupEnable()

◆ GetClassGroupIdByUserId()

◆ GetClassGroupInfoByGroupId()

◆ GetCurrentBoard()

◆ GetCurrentFile()

◆ GetElementById()

◆ GetEraserSize()

◆ GetFileBoardList()

◆ GetFileInfo()

◆ GetFileInfoList()

◆ GetFileScale()

◆ GetFileTranscodeProgress()

◆ GetGlobalBackgroundColor()

◆ GetGlobalBackgroundImage()

◆ GetGraphStyle()

◆ GetHighlighterColor()

◆ GetLineStyle()

◆ GetOvalDrawMode()

◆ GetPPtRemark()

◆ GetSyncTime()

◆ GetTextColor()

◆ GetTextFontFamily()

◆ GetTextSize()

◆ GetTextStyle()

◆ GetThumbnailImages()

◆ GetToolType()

◆ GotoBoard()

◆ GotoClassGroupBoard()

◆ GotoStep()

◆ ImportInLocalMode()

◆ Init()

◆ IsDataSyncEnable()