IMP(低代码音视频工厂)SDK v1.5.0
IMP SDK API Reference Manual for Windows Platforms
IDoc Class Referenceabstract
Inheritance diagram for IDoc:
IPlugin

Public Member Functions

virtual void CreateDoc (const ::alibaba::doc::CreateDocReq &req, const std::function< void(const ::alibaba::doc::CreateDocRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error)> &on_failure)=0
 创建文档 More...
 
virtual void ReportUploadStatus (const ::alibaba::doc::ReportUploadStatusReq &req, const std::function< void(const ::alibaba::doc::ReportUploadStatusRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error)> &on_failure)=0
 上报服务端文档上传的状态 More...
 
virtual void GetDoc (const ::alibaba::doc::GetDocReq &req, const std::function< void(const ::alibaba::doc::GetDocRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error)> &on_failure)=0
 获取文档详细信息 More...
 
virtual void CreateDocConversionTask (const ::alibaba::doc::CreateDocConversionTaskReq &req, const std::function< void(const ::alibaba::doc::CreateDocConversionTaskRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error)> &on_failure)=0
 创建文档转换任务,ppt无法直接显示在白板上,需要先转换为静态图片 More...
 
virtual void UploadFile (const std::string &file_path, const std::string &doc_name, const std::string &doc_type, const std::string &room_id, bool private_path, const std::function< void(size_t increment, int64_t transferred, int64_t total)> &progress_callback, const std::function< void(const std::string &)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &)> &on_fail)=0
 上传文件接口 More...
 
virtual void ConvertDocToPic (const std::string &doc_id, const std::string &target_name, const std::string &target_type, const std::function< void(const std::string &, const std::vector< std::string > &)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &)> &on_fail)=0
 转换文档格式接口 More...
 
- Public Member Functions inherited from IPlugin
virtual PluginEnum GetPluginType ()=0
 获取插件类型 More...
 
virtual bool IsValid ()=0
 插件是否有效 More...
 

Member Function Documentation

◆ ConvertDocToPic()

virtual void IDoc::ConvertDocToPic ( const std::string &  doc_id,
const std::string &  target_name,
const std::string &  target_type,
const std::function< void(const std::string &, const std::vector< std::string > &)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &)> &  on_fail 
)
pure virtual

转换文档格式接口

Parameters
doc_id要转换的文档Id
target_name指定目标名称
target_type要转换成图片的格式,例如"jpg"
on_success成功回调,返回转换后的文档Id
on_fail失败回调

◆ CreateDoc()

virtual void IDoc::CreateDoc ( const ::alibaba::doc::CreateDocReq req,
const std::function< void(const ::alibaba::doc::CreateDocRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error)> &  on_failure 
)
pure virtual

创建文档

Parameters
req传教文档参数, 参考::alibaba::doc::CreateDocReq
on_success成功回调,参考::alibaba::doc::CreateDocRsp
on_failure失败回调

◆ CreateDocConversionTask()

virtual void IDoc::CreateDocConversionTask ( const ::alibaba::doc::CreateDocConversionTaskReq req,
const std::function< void(const ::alibaba::doc::CreateDocConversionTaskRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error)> &  on_failure 
)
pure virtual

创建文档转换任务,ppt无法直接显示在白板上,需要先转换为静态图片

Parameters
req传教文档参数, 参考::alibaba::doc::CreateDocConversionTaskReq
on_success成功回调,参考::alibaba::doc::CreateDocConversionTaskRsp
on_failure失败回调

◆ GetDoc()

virtual void IDoc::GetDoc ( const ::alibaba::doc::GetDocReq req,
const std::function< void(const ::alibaba::doc::GetDocRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error)> &  on_failure 
)
pure virtual

获取文档详细信息

Parameters
req传教文档参数, 参考::alibaba::doc::GetDocReq
on_success成功回调,参考::alibaba::doc::GetDocRsp
on_failure失败回调

◆ ReportUploadStatus()

virtual void IDoc::ReportUploadStatus ( const ::alibaba::doc::ReportUploadStatusReq req,
const std::function< void(const ::alibaba::doc::ReportUploadStatusRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error)> &  on_failure 
)
pure virtual

上报服务端文档上传的状态

Parameters
req上传状态参数, 参考::alibaba::doc::ReportUploadStatusReq
on_success成功回调,参考::alibaba::doc::ReportUploadStatusRsp
on_failure失败回调

◆ UploadFile()

virtual void IDoc::UploadFile ( const std::string &  file_path,
const std::string &  doc_name,
const std::string &  doc_type,
const std::string &  room_id,
bool  private_path,
const std::function< void(size_t increment, int64_t transferred, int64_t total)> &  progress_callback,
const std::function< void(const std::string &)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &)> &  on_fail 
)
pure virtual

上传文件接口

Parameters
file_path文件的路径
doc_name文档名称
doc_type文档类型 例如“docx”
room_id房间Id
private_path是否验签
progress_callback上传进度回调
on_success成功回调
on_fail失败回调

The documentation for this class was generated from the following file: