tencentTIC
createBoard openBoardRenderView addBoardListener addSyncData setDataSyncEnable isDataSyncEnable reset getVersion setDrawEnable isDrawEnable setGlobalBackgroundColor getGlobalBackgroundColor setBackgroundColor getBackgroundColor setBackgroundImage setBackgroundH5 setToolType getToolType setBrushColor getBrushColor setBrushThin getBrushThin setTextColor getTextColor setTextStyle getTextStyle setTextSize getTextSize setOvalDrawMode getOvalDrawMode undo redo clear clearDraws addBoardWithBackgroundImage deleteBoard prevStep nextStep preBoard nextBoard gotoBoard preBoard nextBoard gotoBoardWithBoardId getCurrentBoard getBoardList setBoardRatio getBoardRatio setBoardScale getBoardScale setBoardContentFitMode getBoardContentFitMode applyFileTranscode getFileTranscodeProgress addTranscodeFile deleteFile switchFile switchFileBoardIdStepIndex getCurrentFile getFileInfoList getFileInfo getFileBoardList clearFileDraws getThumbnailImages getSyncTime syncRemoteTime
原生插件概述
本原生插件封装了腾讯云互动白板 SDK。腾讯云互动白板（Tencent Interactive Whiteboard，TIW）提供整套完备的多人实时白板互动服务，打破线上教学中师生信息传递障碍，拥有比面授教学板书更丰富、直观和多样的功能。包含的功能有互动涂鸦、轨迹实时同步、文档共享、媒体共享、文档转码、白板与音视频实时同步录制、回放等功能。具备灵活易用、扩展性强的优点，帮助用户高度还原线下面授教学的互动体验，显著提升线上教学质量。
原生插件接口
createBoard
创建白板控制器
createBoard({params})
params
sdkAppId：
- 类型：数字类型
- 描述：应用标识，腾讯腾讯互动白板控制台获取
userId：
- 类型：字符串类型
- 描述：用户标识
userSig：
- 类型：字符串类型
- 描述：签名
roomId：
- 类型：字符串类型
- 描述：课堂ID,android必须为纯数字
ratio：
- 类型：字符串类型
- 描述：（可选项）默认白板宽高比，可传格式如“4:3”、“16:9”的字符串
- 默认：'16:9'
drawEnable：
- 类型：布尔类型
- 描述：（可选项）是否允许涂鸦
- 默认：true
globalBgColor：
- 类型：字符串类型
- 描述：（可选项）全局背景色，支持rgb、rgba、#
- 默认：'#000000'
toolType：
- 类型：数字类型
- 描述：（可选项）白板工具
- 默认：1
- 取值范围：
- 0：鼠标
- 1：画笔
- 2：橡皮擦
- 3：激光笔
- 4：直线
- 5：空心椭圆
- 6：空心矩形
- 7：实心椭圆
- 8：实心矩形
- 9：点选工具
- 10：选框工具
- 11：文本工具
- 12：缩放移动
brushColor：
- 类型：字符串类型
- 描述：（可选项）画笔颜色，支持rgb、rgba、#
- 默认：'#FFFFFF'
brushThin：
- 类型：数字类型
- 描述：（可选项）画笔粗细
- 默认：100
textColor：
- 类型：字符串类型
- 描述：（可选项）文本颜色，支持rgb、rgba、#
- 默认：'#FFFFFF'
textSize：
- 类型：数字类型
- 描述：（可选项）文本粗细
- 默认：320
textStyle：
- 类型：数字类型
- 描述：（可选项）文本样式
- 默认：0
- 取值范围：
- 0：常规样式
- 1：粗体样式
- 2：斜体样式
- 3：粗斜体样式
timSync：
- 类型：布尔类型
- 描述：（可选项）是否使用腾讯云IMSDK进行实时数据同步
- 默认：true
dataSyncEnable：
- 类型：布尔类型
- 描述：（可选项）是否启用数据同步，禁用后将导致本地白板操作不会被同步给远端
- 默认：true
preloadDepth：
- 类型：数字类型
- 描述：（可选项）图片预加载深度，默认值5，表示预加载当前页前后5页的图片
- 默认：5
smoothLevel：
- 类型：数字类型
- 描述：（可选项）平滑系数，范围[0，1]
- 默认：0.1
boardContentFitMode：
- 类型：数字类型
- 描述：（可选项）白板内容自适应模式
- 默认：0
- 取值范围：
- 0：不使用内容自适应，默认模式，不自动调整白板宽高比，内容等比例缩放居中显示，内容宽高<=白板宽高
- 1：自动调整白板宽高比与内容一致，内容铺满白板，白板等比例缩放居中显示，白板宽高<=容器宽高
- 2：自动调整白板宽高比与内容一致，内容铺满白板，白板等比例缩放居中显示，白板宽高>=容器宽高
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.createBoard({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
openBoardRenderView
白板窗口获取及显示
openBoardRenderView({params})
params
rect:
- 类型：JSON对象
- 描述：(可选项）白板窗口位置及长宽
{
x: 0, //（可选项）数字类型；窗口 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
y: 0, //（可选项）数字类型；窗口 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
w: 320, //（可选项）数字类型；窗口的高度（相对于所属的 Window 或 Frame）；支持设置'auto'；默认值：所属的 Window 或 Frame 的宽度
h: 300, //（可选项）数字类型；窗口的宽度（相对于所属的 Window 或 Frame）；支持设置'auto'；默认值：所属的 Window 或 Frame 的高度
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）原生插件视图添加到指定 frame 的名字（ios：只指 frame，传 window 无效）(android可以是frame或者Window，但是在全屏的时候，需要挂在Window上或者frame是全屏)
- 默认：原生插件依附于当前 window
fixed：
- 类型：布尔类型
- 描述：（可选项）原生插件是否随所属 window 或 frame 滚动
- 默认：true（不随之滚动）
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.openBoardRenderView({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
addBoardListener
添加监听
addBoardListener({params},callback(ret))
params
name：
- 类型：字符串
- 描述：监听事件名字（仅iOS支持）
- 取值范围：
- basic：基本流程相关回调
- scrawl：涂鸦相关回调
- board：白板页操作回调
- file：文件操作回调
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
basic: { //JSON对象；基本流程相关回调，仅当name 为basic时有值
eventType :'onTEBError', //字符串类型；事件类型，事件对应信息取值对应json对象
// 取值范围：
// onTEBError:白板错误回调
// onTEBWarning:白板警告回调
// onTEBInit:白板初始化完成回调，收到该回调后表示白板已处于可正常工作状态
// onTEBHistroyDataSyncCompleted:白板历史数据同步完成回调
// onTEBSyncData:白板同步数据回调
// onTEBUndoStatusChanged:白板可撤销状态改变回调
// onTEBRedoStatusChanged:白板可重做状态改变回调
onTEBError:{ //jaon对象；白板错误信息
code:0, //数字类型，错误码
//取值范围：
//1：白板加载失败
//2：服务鉴权失败，请先购买服务
//3：白板加载失败
//4：腾讯云IMSDK不可用
//5：同步历史数据失败
//6：白板运行错误
msg:'', //字符串类型，错误信息
},
onTEBWarning:{ //jaon对象；白板警告信息
code:0, //数字类型，错误码
//取值范围：
//1：接收到其他端的同步数据解析失败
//2：腾讯IMSDK发送消息失败
//3：当要添加的H5PPT已存在时抛出该警告
//4：白板历史数据加载完成之前禁止操作
msg:'', //字符串类型，错误信息
},
onTEBSyncData:{ //jaon对象；白板同步数据
data:'' //字符串类型，白板同步数据（JSON格式字符串），收到该回调时需要将回调数据通过信令通道发送给房间内其他人，接受者收到后调用AddSyncData接口将数据添加到白板以实现数据同步,该回调用于多个白板间的数据同步，使用内置IM作为信令通道时，不会收到该回调
},
onTEBUndoStatusChanged:{ //jaon对象；白板可撤销状态改变信息
canUndo:true //布尔类型，白板当前是否还能执行Undo操作
},
onTEBRedoStatusChanged:{ //jaon对象；白板可重做状态改变信息
canRedo:true //布尔类型，白板当前是否还能执行Redo操作
},
},
scrawl:{ JSON对象；涂鸦相关回调，仅当name 为scrawl时有值
eventType :'', //字符串类型；事件类型，事件对应信息取值对应json对象
// 取值范围：
// onTEBImageStatusChanged:白板图片状态改变回调
// onTEBSetBackgroundImage:设置白板背景图片回调
// onTEBBackgroundH5StatusChanged:白板H5状态改变回调
// onTEBAddImageElement：白板添加图片回调（仅android支持）
onTEBImageStatusChanged:{//jaon对象；白板图片状态改变信息
boardId:'', //字符串类型，白板ID
url:'', //字符串类型，白板图片URL
status:0, //数字类型，新的白板图片状态
//取值范围：
//1：背景图片正在加载
//2：背景图片加载完成
//3：背景图片加载中断
//4：背景图片加载错误
},
onTEBSetBackgroundImage:{//jaon对象；白板图片状态改变信息
url:'' //字符串类型，调用setBackgroundImage时传入的url，只有本地调用setBackgroundImage时会收到该回调，收到该回调表示背景图片已经上传或下载成功，并且显示出来
},
onTEBBackgroundH5StatusChanged:{//jaon对象；白板H5状态改变信息
boardId:'', //字符串类型，白板ID
url:'', //字符串类型，H5的URL
status:0, //数字类型，新的H5状态
//取值范围：
//1：H5背景正在加载
//2：H5背景加载完成
},
onTEBAddImageElement:{ //Json对象；添加图片信息
url:'', //字符串类型；
}
},
board: { //JSON对象；白板页操作回调，仅当name 为board时有值
eventType :'', //字符串类型；事件类型，事件对应信息取值对应json对象
// 取值范围：
// onTEBAddBoard:增加白板页回调
// onTEBDeleteBoard:删除白板页回调
// onTEBGotoBoard:跳转白板页回调
// onTEBGotoStep:白板页动画步数回调
onTEBAddBoard:{ //jaon对象；增加白板页信息
boardIds:[], //字符串数组类型；增加的白板页IDs
fileId:'' //字符串类型；增加的白板页所属的文件ID
},
onTEBDeleteBoard:{ //jaon对象；删除白板页信息
boardIds:[], //字符串数组类型；删除的白板页IDs
fileId:'' //字符串类型；删除的白板页所属的文件ID
},
onTEBGotoBoard:{ //jaon对象；跳转白板页信息
boardId:'', //字符串类型；跳转到的白板页ID
fileId:'' //字符串类型；跳转到的白板页所属的文件ID
},
onTEBGotoStep:{ //jaon对象；白板页动画步数信息
currentStep:0, //数字类型；当前白板页动画步数
totalStep:0 //数字类型；当前白板页动画总步数 },
},
file: { //JSON对象；文件操作回调，仅当name 为file时有值
eventType :'', //字符串类型；事件类型，事件对应信息取值对应json对象
// 取值范围：
// onTEBFileTranscodeProgress:文件转码进度回调
// onTEBAddTranscodeFile:增加转码文件回调，文件加载完成后才会触发该回调
// onTEBDeleteFile:删除文件回调
// onTEBSwitchFile:切换文件回调
// onTEBFileUploadProgress:文件上传进度回调
// onTEBFileUploadStatus:文件上传状态回调
//onTEBH5FileStatusChanged；H5文件上传回调（仅android支持）
//onTEBVideoStatusChanged；视频状态回调（仅android支持）
onTEBFileTranscodeProgress:{ //jaon对象；文件转码进度信息
result:{ //json对象，文件信息
taskId:'', //字符串类型；任务ID
status：0， //数字类型；转码状态
//取值如下：
//1：转码错误
//2：文件上传中
//3：发起转码任务
//4：排队中
//5：转码中
//6：转码完成
progress:0, //数字类型；转码进度（百分比）
title:'', //字符串类型；文件标题
resolution:'', //字符串类型；文件分辨率，如@"1024x768"
pages:0, //数字类型；文件总页数
url:'', //字符串类型；转码结果URL
thumbnailResolution:'',//字符串类型；文件生成缩略图的分辨率，如@"200x200"
thumbnailUrl:'', //字符串类型；文件生成缩略图URL
},
path:'', //字符串类型；路径
errorCode:'', //字符串类型；文件转码错误码，无异常时为空字符串 ""
errorMsg:'' //字符串类型；文件转码错误信息，无异常时为空字符串 ""
},
onTEBAddTranscodeFile:{ //jaon对象；增加转码文件信息
fileId:'' //字符串类型；增加的文件ID
},
onTEBDeleteFile:{ //jaon对象；删除文件信息
fileId:'' //字符串类型；删除的文件ID
},
onTEBSwitchFile:{ //jaon对象；切换文件信息
fileId:'' //字符串类型；切换到的文件ID
},
onTEBFileUploadProgress:{ //jaon对象；文件上传进度信息
fileId:'', //字符串类型；文件Id
currentBytes:0, //数字类型；当前已上传大小，单位bytes
totalBytes:0, //数字类型；文件总大小，单位bytes
uploadSpeed:0, //数字类型；文件上传速度，单位bytes
percent:0, //数字类型；文件上传百分比，小数形式，如0.5
},
onTEBFileUploadStatus:{ //jaon对象；文件上传状态信息
fileId:'', //字符串类型；文件Id
status：0， //数字类型；文件上传状态
//取值如下：
//1：上传成功
//2：上传失败
errorCode:0, //数字类型；错误码
errorMsg:'' //字符串类型；错误信息
},
onTEBH5FileStatusChanged:{ //json对象；h5文件上传信息
fileId:'', //字符串类型；文件Id
status：0， //数字类型；文件上传状态
},
onTEBVideoStatusChanged:{ //json对象；视频状态回调
fileId:'', //字符串类型；文件id
status:, //数字类型；文件状态
progress:, //小数类型当前进度（秒）
duration:, //小数类型；总时长（秒）
}
}
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.addBoardListener(function(ret) {
if (ret) {
api.alert({
msg: JSON.stringify(ret)
})
} else {
api.alert({
msg: JSON.stringify(err)
})
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
addSyncData
添加白板同步数据，该接口用于多个白板间的数据同步，使用内置IM作为信令通道时，不需要调用该接口
addSyncData({params})
params
data：
- 类型：字符串类型
- 描述：接收到的房间内其他人发送的同步数据
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.addSyncData({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setDataSyncEnable
设置白板是否开启数据同步，关闭数据同步，本地的所有白板操作不会同步到远端和服务器
setDataSyncEnable({params})
params
enable：
- 类型：布尔类型
- 描述：（可选项）是否开启
- 默认：true
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setDataSyncEnable({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
isDataSyncEnable
获取白板是否开启数据同步
isDataSyncEnable(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
enable:true //布尔类型，是否开启数据同步，true 表示开启，false 表示关闭
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.isDataSyncEnable(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
reset
重置白板，调用该接口后将会删除所有的白板页和文件
reset()
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.reset();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getVersion
获取版本号
getVersion(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
version:'' //字符串类型；版本号
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getVersion(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setDrawEnable
设置白板是否允许涂鸦
setDrawEnable({params})
params
enable：
- 类型：布尔类型
- 描述：（可选项）是否允许涂鸦，true 表示白板可以涂鸦，false 表示白板不能涂鸦，白板创建后默认为允许涂鸦状态
- 默认：true
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setDrawEnable({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
isDrawEnable
获取白板是否允许涂鸦
isDrawEnable(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
enable:true //布尔类型，是否允许涂鸦，true 表示白板可以涂鸦，false 表示白板不能涂鸦
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.isDrawEnable(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setGlobalBackgroundColor
设置白板默认背景色
setGlobalBackgroundColor({params})
params
color：
- 类型：字符串类型
- 描述：要设置的默认背景色，支持rgb、rgba、#
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setGlobalBackgroundColor({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getGlobalBackgroundColor
获取白板默认背景色
getGlobalBackgroundColor(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
color:'' //字符串类型，白板默认背景色，十六进制颜色
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getGlobalBackgroundColor(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setBackgroundColor
设置当前白板页的背景色
setBackgroundColor({params})
params
color：
- 类型：字符串类型
- 描述：要设置的背景色，支持rgb、rgba、#
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setBackgroundColor({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getBackgroundColor
获取当前白板页的背景色
getBackgroundColor(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
color:'' //字符串类型，当前白板页的背景色，十六进制颜色
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getBackgroundColor(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setBackgroundImage
设置当前白板页的背景图片，当URL是一个有效的本地文件地址时，该文件会被自动上传到COS,该接口与setBackgroundH5接口互斥
setBackgroundImage({params})
params
url：
- 类型：字符串类型
- 描述：要设置的背景图片URL，支持widget、fs（android仅支持fs）
mode：
- 类型：数字类型
- 描述：（可选项）要使用的图片填充对齐模式，当以宽度基准等比例放大，则居左和居右同居中对齐效果一致；当以高度基准等比例放大，则居顶和居底同居中对齐效果一致
- 默认：0
- 取值范围：
- 0：以宽度或者高度为基准居中对齐等比例放大
- 1：以宽度或者高度为基准左对齐等比例放大
- 2：以宽度或者高度为基准顶对齐等比例放大
- 3：以宽度或者高度为基准右对齐等比例放大
- 4：以宽度或者高度为基准底对齐等比例放大
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setBackgroundImage({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setBackgroundH5
设置当前白板页的背景H5页面，该接口与setBackgroundImage接口互斥
setBackgroundH5({params})
params
url：
- 类型：字符串类型
- 描述：要设置的背景H5页面URL
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setBackgroundH5({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setToolType
设置要使用的白板工具
setToolType({params})
params
toolType：
- 类型：数字类型
- 描述：（可选项）白板工具
- 默认：1
- 取值范围：
- 0：鼠标
- 1：画笔
- 2：橡皮擦
- 3：激光笔
- 4：直线
- 5：空心椭圆
- 6：空心矩形
- 7：实心椭圆
- 8：实心矩形
- 9：点选工具
- 10：选框工具
- 11：文本工具
- 12：缩放移动
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setToolType({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getToolType
获取正在使用的白板工具
getToolType(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
toolType:0 //数字类型；白板工具；取值如下：
- 0：鼠标
- 1：画笔
- 2：橡皮擦
- 3：激光笔
- 4：直线
- 5：空心椭圆
- 6：空心矩形
- 7：实心椭圆
- 8：实心矩形
- 9：点选工具
- 10：选框工具
- 11：文本工具
- 12：缩放移动
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getToolType(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setBrushColor
设置画笔颜色，画笔颜色用于所有涂鸦绘制
setBrushColor({params})
params
color：
- 类型：字符串类型
- 描述：要设置的画笔颜色，支持rgb、rgba、#
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setBrushColor({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getBrushColor
获取画笔颜色
getBrushColor(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
color:'' //字符串类型，画笔颜色，十六进制颜色
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getBrushColor(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setBrushThin
设置画笔粗细，画笔粗细用于所有涂鸦绘制，实际像素值取值(thin * 白板的高度 / 10000)px，如果结果小于1px，则涂鸦的线条会比较虚
setBrushThin({params})
params
thin：
- 类型：数字类型
- 描述：要设置的画笔粗细
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setBrushThin({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getBrushThin
获取画笔粗细
getBrushThin(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
thin:1 //数字类型，画笔粗细
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getBrushThin(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setTextColor
设置文本颜色
setTextColor({params})
params
color：
- 类型：字符串类型
- 描述：要设置的文本颜色，支持rgb、rgba、#
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setTextColor({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getTextColor
获取文本颜色
getTextColor(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
color:'' //字符串类型，文本颜色，十六进制颜色
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getTextColor(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setTextStyle
设置文本样式
setTextStyle({params})
params
style：
- 类型：数字类型
- 描述：（可选项）要设置的文本样式
- 默认：0
- 取值范围：
- 0：常规样式
- 1：粗体样式
- 2：斜体样式
- 3：粗斜体样式
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setTextStyle({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getTextStyle
获取文本样式
getTextStyle(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
style:0 //数字类型；文本样式；取值如下：
- 0：常规样式
- 1：粗体样式
- 2：斜体样式
- 3：粗斜体样式
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getTextStyle(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setTextSize
设置文本大小，实际像素值取值(size * 白板的高度 / 10000)px
setTextSize({params})
params
size：
- 类型：数字类型
- 描述：要设置的文本大小
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setTextSize({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getTextSize
获取文本大小
getTextSize(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
size:1 //数字类型，文本大小
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getTextSize(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setOvalDrawMode
设置椭圆绘制模式
setOvalDrawMode({params})
params
mode：
- 类型：数字类型
- 描述：（可选项）椭圆绘制模式
- 默认：0
- 取值范围：
- 0：固定起始点，起始点和终点的中点为圆心
- 1：固定圆心，起始点为圆心
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setOvalDrawMode({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getOvalDrawMode
获取椭圆绘制模式
getOvalDrawMode(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
mode:0 //数字类型；椭圆绘制模式；取值如下：
- 0：固定起始点，起始点和终点的中点为圆心
- 1：固定圆心，起始点为圆心
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getOvalDrawMode(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
undo
撤销当前白板页上一次动作
undo()
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.undo();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
redo
重做当前白板页上一次撤销
redo()
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.redo();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
clear
清除涂鸦，同时清空背景色以及背景图片
params
clearBackground：
- 类型：布尔类型；
- 描述：是否同时清空背景色以及背景图片（仅android支持）
- 默认：true
clear()
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.clear();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
clearDraws
清除涂鸦
clearDraws()
params
clearSelectedOnly：
- 类型：布尔类型；
- 描述：是否只清除选中部分涂鸦（仅android支持）
- 默认：true
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.clearDraws();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
addBoardWithBackgroundImage
增加一页白板，白板页会被添加到当前文件
addBoardWithBackgroundImage({params},callback(ret))
params
url：
- 类型：字符类型
- 描述：（可选项）要使用的背景图片URL，为空表示不指定背景图片，支持widget、fs
- 默认：空
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
boardId:'' //字符类型；白板ID
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.addBoardWithBackgroundImage({
},function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
deleteBoard
删除一页白板
deleteBoard({params})
params
boardId：
- 类型：字符串类型
- 描述：（可选项）要删除的白板ID，为空表示删除当前页
- 默认：空
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.deleteBoard({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
prevStep
上一步，每个Step对应PPT的一个动画效果，若当前没有已展示的动画效果，则该接口调用会导致向前翻页
prevStep()
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.prevStep();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
nextStep
下一步，每个Step对应PPT的一个动画效果，若当前没有未展示的动画效果，则该接口调用会导致向后翻页
nextStep()
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.nextStep();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
gotoBoard
跳转到指定白板页，允许跳转到任意文件的白板页
gotoBoard({params})
params
boardId：
- 类型：字符串类型
- 描述：要跳转到的白板页ID
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.gotoBoard({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
preBoard
向前翻页，若当前白板页为当前文件的第一页，则该接口调用无效
preBoard({params})
params
resetStep：
- 类型：布尔类型
- 描述：（可选项）是否重置白板步数
- 默认：false
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.preBoard({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
nextBoard
向后翻页，若当前白板页为当前文件的最后一页，则该接口调用无效
nextBoard({params})
params
resetStep：
- 类型：布尔类型
- 描述：（可选项）是否重置白板步数
- 默认：false
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.nextBoard({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
gotoBoardWithBoardId
跳转到指定白板页，允许跳转到任意文件的白板页
gotoBoardWithBoardId({params})
params
boardId：
- 类型：字符串类型
- 描述：要跳转到的白板页ID
resetStep：
- 类型：布尔类型
- 描述：（可选项）是否重置白板步数
- 默认：false
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.gotoBoardWithBoardId({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getCurrentBoard
获取当前白板页ID
getCurrentBoard(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
boardId:'' //字符类型；当前白板页ID
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getCurrentBoard(function(ret){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getBoardList
获取所有文件的白板列表
getBoardList(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
boards:[] //字符数组；所有文件的白板列表
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getBoardList(function(ret){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setBoardRatio
设置当前白板页宽高比
setBoardRatio({params})
params
ratio：
- 类型：字符串类型
- 描述：要设置的白板宽高比，格式如"4:3" "16:9"
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setBoardRatio({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getBoardRatio
获取当前白板页宽高比
getBoardRatio(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
ratio:'' //字符串类型，板宽高比，格式与setBoardRatio接口参数格式一致
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getBoardRatio(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setBoardScale
设置当前白板页缩放比例
setBoardScale({params})
params
scale：
- 类型：数字类型
- 描述：要设置的白板缩放比例，支持范围: [100，300]，实际缩放比为: scale/100
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setBoardScale({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getBoardScale
获取当前白板页缩放比例
getBoardScale(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
scale:100 //数字类型，白板缩放比例，格式与setBoardScale接口参数格式一致
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getBoardScale(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
setBoardContentFitMode
设置白板内容自适应模式，设置自适应模式后会影响所有后续白板内容操作
setBoardContentFitMode({params})
params
mode：
- 类型：数字类型
- 描述：（可选项）要设置的白板内容自适应模式
- 默认：0
- 取值范围：
- 0：不使用内容自适应，默认模式，不自动调整白板宽高比，内容等比例缩放居中显示，内容宽高<=白板宽高
- 1：自动调整白板宽高比与内容一致，内容铺满白板，白板等比例缩放居中显示，白板宽高<=容器宽高
- 2：自动调整白板宽高比与内容一致，内容铺满白板，白板等比例缩放居中显示，白板宽高>=容器宽高
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.setBoardContentFitMode({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getBoardContentFitMode
获取白板内容自适应模式
getBoardContentFitMode(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
mode:0 //数字类型；白板内容自适应模式；取值如下：
- 0：不使用内容自适应，默认模式，不自动调整白板宽高比，内容等比例缩放居中显示，内容宽高<=白板宽高
- 1：自动调整白板宽高比与内容一致，内容铺满白板，白板等比例缩放居中显示，白板宽高<=容器宽高
- 2：自动调整白板宽高比与内容一致，内容铺满白板，白板等比例缩放居中显示，白板宽高>=容器宽高
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getBoardContentFitMode(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
applyFileTranscode
发起文件转码请求，支持 PPT、PDF、Word文件转码，PPT文档默认转为H5动画，能够还原PPT原有动画效果，其它文档转码为静态图片，PPT动画转码耗时约1秒/页，所有文档的静态转码耗时约0.5秒/页
applyFileTranscode({params})
params
path：
- 类型：字符串类型
- 描述：要转码的文件路径，编码格式为UTF8，支持fs、widget
config：
- 类型：JSON对象
- 描述：（可选项）转码参数
- 内部字段：
{
minResolution:'', //字符串类型；指定转码结果最小分辨率，可用于提高转码结果清晰度，如960x540，宽高分隔符为x
isStaticPPT:'', //（可选项）布尔类型；指定对于PPT文件是否启用静态转码（转为静态图片），默认转为H5动画（转码耗时较长）；默认：false
thumbnailResolution:'' //字符串类型；指定文件生成缩略图分辨率，默认不生成缩略图（生成缩略图增加额外转码消耗），如200x200，宽高分隔符为x
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.applyFileTranscode({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getFileTranscodeProgress
主动查询文件转码进度，该接口仅用于特殊业务场景下主动查询文件转码进度
getFileTranscodeProgress({params})
params
taskId：
- 类型：字符串类型
- 描述：转码任务taskId
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getFileTranscodeProgress({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
addTranscodeFile
添加转码文件
addTranscodeFile({params},callback(ret))
params
config：
- 类型：JSON对象
- 描述：（可选项）转码参数
- 内部字段：
{
title:'', //字符串类型；文件标题
resolution:'', //字符串类型；文件分辨率，如@"1024x768"
url:'', //字符串类型；转码结果URL
pages:'' //数字类型；文件总页数
}
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
fileId:'' //字符类型；文件ID
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.addTranscodeFile({
},function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
deleteFile
删除文件，文件ID为空时表示当前文件，默认文件无法删除
deleteFile({params})
params
fileId：
- 类型：字符串类型
- 描述：（可选项）要删除的文件ID
- 默认：空
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.deleteFile({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
switchFile
切换文件，文件ID为必填项，为空将导致文件切换失败
switchFile({params})
params
fileId：
- 类型：字符串类型
- 描述：要切换到的文件ID
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.switchFile({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
switchFileBoardIdStepIndex
跳转到文件指定白班指定步，只在首次加载文件时有效，跳转到非当前文件的指定白板指定步
switchFileBoardIdStepIndex({params})
params
fileId：
- 类型：字符串类型
- 描述：文件ID
boardId：
- 类型：字符串类型
- 描述：白板ID
stepIndex：
- 类型：数字类型
- 描述：步数索引
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.switchFileBoardIdStepIndex({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getCurrentFile
获取当前文件ID
getCurrentFile(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
fileId:'' //字符串类型，当前文件ID
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getCurrentFile(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getFileInfoList
获取白板中上传的所有文件的文件信息列表
getFileInfoList(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
fileInfos:[{ //json数组类型，文件信息列表
fileId:'', //字符串类型；文件标识
title:'', //字符串类型；文件名称
downloadURL:'', //字符串类型；文件下载地址
pageIndex:'', //数字类型；当前页数
pageCount:'', //数字类型；页数
boardInfos:[{ //json对象类型，白板信息列表
boardId:'', //字符串类型；白板ID
backgroundUrl:'', //字符串类型；背景图或者背景H5页面的URL
backgroundColor:'',//字符串类型；白板背景色,16进制
}]
}]
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getFileInfoList(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getFileInfo
获取指定文件id的文件信息
getFileInfo({params},callback(ret))
params
fileId：
- 类型：字符串类型
- 描述：文件ID
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
fileInfo:{ //json对象类型，文件信息列表
fileId:'', //字符串类型；文件标识
title:'', //字符串类型；文件名称
downloadURL:'', //字符串类型；文件下载地址
pageIndex:'', //数字类型；当前页数
pageCount:'', //数字类型；页数
boardInfos:[{ //json对象类型，白板信息列表
boardId:'', //字符串类型；白板ID
backgroundUrl:'', //字符串类型；背景图或者背景H5页面的URL
backgroundColor:'',//字符串类型；白板背景色,16进制
}]
}
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getFileInfo({
},function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getFileBoardList
获取指定文件id的文件信息
getFileBoardList({params},callback(ret))
params
fileId：
- 类型：字符串类型
- 描述：文件ID
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
boards:[] //字符串数组类型；白板列表ID
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getFileBoardList({
},function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
clearFileDraws
清空指定文件的所有白板涂鸦
clearFileDraws({params})
params
fileId：
- 类型：字符串类型
- 描述：文件ID
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.clearFileDraws({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getThumbnailImages
获取指定文件的缩略图，不支持默认文件（fileId=#DEFAULT），用户在调用rest api请求转码时，需要带上 "thumbnail_resolution" 参数，开启缩略图功能，否则返回的缩略图url无效
getThumbnailImages({params},callback(ret))
params
fileId：
- 类型：字符串类型
- 描述：文件ID
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
thumbnailImages:[] //字符串数组类型；缩略图urls
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getThumbnailImages({
},function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getSyncTime
获取同步时间
getSyncTime(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
time:0 //数字类型；毫秒级时间戳
}
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.getSyncTime(function(ret, err){
api.alert({
msg: JSON.stringify(ret)
})
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
syncRemoteTime
同步远程时间
syncRemoteTime({params})
params
userId：
- 类型：字符串类型
- 描述：用户Id
timestamp：
- 类型：数字类型
- 描述：毫秒级时间戳
示例代码
var tencentTIC = api.require('tencentTIC');
tencentTIC.syncRemoteTime({
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本