提交工单
咨询集成、功能及报价等问题
共享文件管理包含上传文件和缓存文件两个部分。
当用户需要创建文件白板时,用户需要先将文件上传至 ZEGO 文件云服务,获得该文件的 fileID(将被永久保存并适用于所有房间)。
这个 file ID 将会在创建文件白板时使用,详情请参考 创建超级白板 - 创建白板。
建议您将文件的名称和 fileID 一一对应,以便快速访问。
ZEGO 超级白板支持客户端 API 和服务端 API 两种方式上传文件。
对于 ZEGO 超级白板 SDK 而言,文件可分为普通文件和 H5 文件。因此,当上传不同类型的文件时,需要调用不同的上传接口。
普通文件包含:
上传的文件必须满足相应的规范:
全部规范请参考 文件规范。
调用 uploadFile 方法上传普通文件。
var file; // 待上传文件
if (!file) return alert('请先选择文件');
var zegoSuperBoard = ZegoSuperBoardManager.getInstance();
//上传文件后转码后渲染模式类型,如果用户涉及到 iOS、Web、Windows、Mac、小程序各端的业务,推荐使用 VectorAndIMG 模式。
zegoSuperBoard
.uploadFile(file, renderType, function(infoMap) {
<pre><code> // 上传中...
if(infoMap.status === ZegoSuperBoardUploadFileState.UPLOADING){
}
// 排队中...
if(infoMap.status === ZegoSuperBoardUploadFileState. WAITING){
}
// 转码中...
if(infoMap.status === ZegoSuperBoardUploadFileState.CONVERTING){
}
// 转换成功
if(infoMap.status === ZegoSuperBoardUploadFileState.CONVERTED){
// 获得转码成功的文件 ID
var fileID = infoMap.fileID;
}
})
.then(function(fileID) {
// 这里上传完成立即创建文件白板,开发者根据实际情况处理
})
.catch(function(error){
// 上传失败
console.log(error)
});</code></pre>
<pre><code> </md-content>
</div>
<!--嵌套其它html模板示例-->
<div class="multipletabs-content-item ">
<md-content>
通过 [ZegoSuperboardCustomH5Config\|_blank](/article/api?doc=superboard_API~javascript_web~interface~ZegoSuperboardCustomH5Config) 设置上传 H5 文件的配置参数,并调用 [uploadH5File\|_blank](/article/api?doc=superboard_API~javascript_web~class~ZegoSuperBoardManager#upload-h5-file) 方法上传 H5 文件。
``` javascript
var selectedH5File = null; // 当前选择的 H5 压缩包文件
var config = {
width: 1600, // 自定义文件的宽
height: 900, // 自定义文件的高
pageCount: 7, // 自定义文件的页数
// 自定义文件缩略图相对路径数组
thumbnailList: ['thumbnail/1.png','thumbnail/2.png','thumbnail/3.png','thumbnail/4.png','thumbnail/5.png','thumbnail/6.png','thumbnail/7.png']
};
zegoSuperBoard
.uploadH5File(selectedH5File, config, function(res) {
// 上传进度
console.log(res.uploadPercent + '%');
})
.then(function(fileID) {
// 上传成功,得到 H5 文件 ID
// 这里上传完成立即创建文件白板,开发者根据实际情况处理
})
.catch(function(error) {
// 上传失败
console.log(error)
}); </code></pre>
文件上传分为上传中,排队中,转换中,和转换成功等多个阶段。具体上传状态请查看 ZegoSuperBoardUploadFileState
{"uploadPercent":0.50}
;当前上传 100%,则 "infoMap" 内容为 {"uploadPercent":1.00}
。{"fileID":"ekxxxxxxxxv"}
。服务端 API 仅支持上传普通文件,详情请参考服务端接口文档 请求文件转码。
当用户上传文件并获取文件的 fileID 之后,如需提高文件加载速度,可以在调用 ZegoSuperBoardManager 的 createFileView 接口创建文件白板之前,提前缓存该文件。
调用 cacheFile 方法提前请求该文件中的资源。
var zegoSuperBoard = ZegoSuperBoardManager.getInstance()
zegoSuperBoard.cacheFile(fileID).then(function(res){
// 回调中返回的参数:failedFileNum - 请求失败资源数,totalFileNum - 该文件预请求总资源数
}).catch(function(error){
// 缓存失败
})
联系我们
文档反馈