文档中心
超级白板
基础功能
共享文件管理

共享文件管理

更新时间：2024-11-20 18:04

共享文件管理包含上传文件和缓存文件两个部分。

上传文件

当用户需要创建文件白板时，用户需要先将文件上传至 ZEGO 文件云服务，获得该文件的 fileID（将被永久保存并适用于所有房间）。

这个 file ID 将会在创建文件白板时使用，详情请参考创建超级白板 - 创建白板。

建议您将文件的名称和 fileID 一一对应，以便快速访问。

ZEGO 超级白板支持客户端 API 和服务端 API 两种方式上传文件。

客户端 API

对于 ZEGO 超级白板 SDK 而言，文件可分为普通文件和 H5 文件。因此，当上传不同类型的文件时，需要调用不同的上传接口。

普通文件包含：

PPT 演示文稿文件
文档类文件（Word/PDF）
表格类文件（Excel）
图片类文件（JPG/JPEG/PNG/BMP）
文本类文件（TXT）

上传的文件必须满足相应的规范：

文件请使用 Microsoft Office 2013 或以上版本编辑/保存，不支持低版本 Microsoft Office 或其他办公软件保存的文件，如 WPS、Keynote、Microsoft Office 2003 等。
文件必须是可编辑的，不支持“只读”、“加密”、或其他受保护的文档，否则会导致转码失败。

全部规范请参考文件规范。

上传普通文件上传 H5 文件

调用 uploadFile 方法上传普通文件。

// filePath 待上传文件的绝对路径
String filePath = "";
ZegoSuperBoardRenderType renderType = ZegoSuperBoardRenderType.IMG;//例如转换成image格式
ZegoSuperBoardManager.getInstance().uploadFile(filePath, renderType, new IZegoSuperBoardUploadFileListener() {
    @Override
    public void onUpload(ZegoSuperBoardUploadFileState state, int errorCode, @NonNull HashMap<String, Object> infoMap) {
        if (errorCode == ZegoSuperBoardError.ZegoSuperBoardSuccess) {
            if (state == ZegoSuperBoardUploadFileState.Upload) {
                // 上传中...
                float uploadPercent = (float) infoMap.get("upload_percent");
                if (uploadPercent == 1f){
                /** 正在转码... */
                }
            } else if (state == ZegoSuperBoardUploadFileState.Convert){
                /** 转换成功 */
                String fileID = (String) infoMap.get(ZegoSuperBoardError.UPLOAD_FILEID);
            }
        } else {
        /** 上传失败 */
        }
    }
});

通过 ZegoUploadCustomH5Config 设置上传 H5 文件的配置参数，并调用 uploadH5File 方法上传 H5 文件。


String filePath = "";

ZegoUploadCustomH5Config mH5Config = new ZegoUploadCustomH5Config();
mH5Config.height = 960;
mH5Config.width = 540;
mH5Config.pageCount = 5;

ZegoSuperBoardManager.getInstance().uploadH5File(filePath, mH5Config, new IZegoSuperBoardUploadFileListener() {
    @Override
    public void onUpload(ZegoSuperBoardUploadFileState state, int errorCode, @NonNull HashMap<String, Object> infoMap) {
        if (errorCode == ZegoSuperBoardError.ZegoSuperBoardSuccess) {
            if (state == ZegoSuperBoardUploadFileState.Upload) {
                // 上传中...
                float uploadPercent = (float) infoMap.get("upload_percent");
                if (uploadPercent == 1f){
                    /** 正在转码... */
                }
            } else if (state == ZegoSuperBoardUploadFileState.Convert){
                /** 转换成功 */
                String fileID = (String) infoMap.get(ZegoSuperBoardError.UPLOAD_FILEID);
            }
        } else {
            /** 上传失败 */
        }
    }
});

调用客户端 API 接口上传文件的过程包含上传（ZegoSuperBoardUploadFileState.Upload）和格式转换（ZegoSuperBoardUploadFileState.Convert）两个阶段。

上传阶段：如果正常上传，会产生多次回调，每次都包含文件上传进度。例如当前上传 50%，则 "infoMap" 内容为 {"upload_percent":0.50}；当前上传 100%，则 "infoMap" 内容为 {"upload_percent":1.00}。
格式转换阶段：如果转换成功，只产生一次回调，包含转换后的文件 ID。例如当前转换完成，则 "infoMap" 内容为 {"upload_fileid":"ekxxxxxxxxv"}。

服务端 API

服务端 API 仅支持上传普通文件，详情请参考服务端接口文档请求文件转码。

缓存文件

当用户上传文件并获取文件的 fileID 之后，如需提高文件加载速度，可以在调用 ZegoSuperBoardManager 的 createFileView 接口创建文件白板之前，提前缓存该文件。

缓存文件

调用 cacheFile 方法将文件缓存到本地。

int seq = ZegoSuperBoardManager.getInstance().cacheFile(fileID, new IZegoSuperBoardCacheFileListener() {
    @Override
    public void onCache(ZegoSuperBoardCacheFileState state, int errorCode, @NonNull HashMap<String, Object> infoMap) {
        if (errorCode == ZegoSuperBoardError.ZegoSuperBoardSuccess) {
            if (state == ZegoSuperBoardCacheFileState.Caching) {
                float cachePercent = (float) infoMap.get("cache_percent") * (float) 100;
                // 缓存中...
            } else if (state == ZegoSuperBoardCacheFileState.Cached) {
            // 缓存成功
            }
        } else {
        // 缓存失败
        }
    }
});

取消缓存文件

调用 cancelCacheFile 方法取消掉正在缓存的文件。

// 保存从调用 cacheFile() 接口返回的 seq值
// 在取消缓存参数中用到
ZegoSuperBoardManager.getInstance().cancelCacheFile(seq, new IZegoSuperBoardApiCalledCallback() {
    @Override
    public void onApiCalledResult(int errorCode) {
        // errorCode等于0，取消缓存成功
    }
});

查询文件是否已经有缓存

调用 queryFileCached 方法查询文件缓存是否存在。

// 通过 fileID 查询指定文件是否已缓存
ZegoSuperBoardManager.getInstance().queryFileCached(fileID, new IZegoSuperBoardQueryFileCachedListener() {
    @Override
    public void onQueryCached(int errorCode, boolean fileCached) {
        // fileCached 是否已有缓存
    }
});