文档

白板图片与页码操作

更新时间:

白板可以设置URL形式背景图片,此能力可以与文档模块结合起来,实现白板内展示文档的功能。配合使用的API有上报、获取页码映射关系。

注意

  • 使用白板图片与页码操作的前提是完成白板初始化。初始化接口请参见初始化

  • 支持的功能有:为当前白板添加背景图片、上报白板页码映射关系、获取白板文档映射关系。

API使用示例

添加背景图

iOS:

// 添加背景图,背景图既可以是从我们的文档能力来,也可以是其他来源
id<AIRBRoomChannelProtocol> room = [[AIRBRoomEngine sharedInstance] getRoomChannelWithRoomID:@"xxx"];
//来自低代码音视频工厂文档能力的背景图,可以填入documentID
[room.whiteboard addPagesWithDocumentID:@"文档对应的documentID" backgroundImages:@[@"https://xxx1.png",@"https://xxx2.png"]];

//其他来源的图片,填入图片地址即可
[room.whitebaord addPagesWithBackgroundImages:@[@"https://xxx1.png",@"https://xxx2.png"]];

Android:

whiteboardService.addBackgroundImage(url);

Web:

Web端请直接使用白板API。详细信息请参见API使用示例描述

Windows:

暂无相关API。

上报白板页码映射关系

iOS:

暂无。

Android:

暂无。

Web:

/**
 * 上报白板页码映射关系
 * @param {string} operate 操作类型(目前只有add,未来可扩展)
 * @param {string} pageGroup 添加的页所属组(自定义,建议白板页使用wb,文档页直接使用docid的值)
 * @param {number} pageNumber 进行操作的页码,如2
 * @param {number} pageSize 涉及页数,如4,默认为1
 * @param {'page' | 'img'} type 插入资源类型,page对应白板新的页,img对应插入的页内资源
 */
whiteboardService.reportWhiteboardPageOperate('add', docId, pageNumber, pageSize, 'page').then((pageInfo) => {
    console.log(pageInfo.pageList)
    console.log(pageInfo.intraPageResourceList)
})

Windows:

auto room_ptr = alibaba::meta_space::MetaSpace::GetInstance()->GetRoomInstance(room_id);
std::shared_ptr<IWhiteBoard> wb_plugin = std::dynamic_pointer_cast<IWhiteBoard>(room_ptr->GetPlugin(PluginWhiteBoard));
::alibaba::wb::ReportWhiteboardPageOperateReq req;
wb_plugin->ReportWhiteboardPageOperate(req, [](const ::alibaba::wb::ReportWhiteboardPageOperateRsp& rsp) {
  },[](const ::alibaba::dps::DPSError & error_msg){
  });

获取白板文档映射关系

iOS:

暂无。

Android:

whiteboardService.getWhiteboardPageInfo(instanceId, new Callback<GetWhiteboardPageInfoRsp>() {
    @Override

    public void onSuccess(GetWhiteboardPageInfoRsp rsp) {
        Logger.i(TAG, "getWhiteboardPageInfo onSuccess: " + rsp);
    }

    @Override
    public void onError(String errorMsg) {
        Logger.e(TAG, "getWhiteboardPageInfo onError: " + errorMsg);
    }
});

Web:

whiteboardService.getWhiteboardPageInfo().then((pageInfo) => {
    console.log(pageInfo.pageList)
    console.log(pageInfo.intraPageResourceList)
})

Windows:

auto room_ptr = alibaba::meta_space::MetaSpace::GetInstance()->GetRoomInstance(room_id);
std::shared_ptr<IWhiteBoard> wb_plugin = std::dynamic_pointer_cast<IWhiteBoard>(room_ptr->GetPlugin(PluginWhiteBoard));
::alibaba::wb::GetWhiteboardPageInfoReq req;
wb_plugin->GetWhiteboardPageInfo(req, [](const ::alibaba::wb::GetWhiteboardPageInfoRsp& rsp) {
  },[](const ::alibaba::dps::DPSError & error_msg){
  });

  • 本页导读 (1)
文档反馈