NIM PC Cross Platform SDK
Public Types | Static Public Member Functions | List of all members
nim::DocTrans Class Reference

NIM SDK提供的文档转换相关接口 More...

#include <nim_cpp_doc_trans.h>

Public Types

typedef std::function< void(int32_t code, const DocTransInfo &doc_info)> DocInfoCallback
 
typedef std::function< void(int32_t code, int32_t count, const std::list< DocTransInfo > &doc_infos)> DocInfosCallback
 

Static Public Member Functions

static void RegNotifyCb (const DocInfoCallback &cb)
 
static void GetInfo (const std::string &id, const std::string &json_extension, const DocInfoCallback &cb)
 
static void GetInfoList (const std::string &id, int32_t limit, const std::string &json_extension, const DocInfosCallback &cb)
 
static void DeleteInfo (const std::string &id, const std::string &json_extension, const DocInfoCallback &cb)
 
static std::string GetSourceFileUrl (const std::string &url_prefix, NIMDocTranscodingFileType file_type)
 
static std::string GetPageUrl (const std::string &url_prefix, NIMDocTranscodingImageType img_type, NIMDocTranscodingQuality quality, int32_t page_num)
 

Detailed Description

NIM SDK提供的文档转换相关接口

Member Function Documentation

◆ DeleteInfo()

void nim::DocTrans::DeleteInfo ( const std::string &  id,
const std::string &  json_extension,
const DocInfoCallback &  cb 
)
static

根据文档id删除服务器记录，对于正在转码中的文档，删除后将不会收到转码结果的通知

Parameters
[in]id文档id
[in]json_extension无效扩展字段
[in]cb结果回调见nim_doc_trans_def.h，返回的json_extension无效
Returns
void 无返回值

◆ GetInfo()

void nim::DocTrans::GetInfo ( const std::string &  id,
const std::string &  json_extension,
const DocInfoCallback &  cb 
)
static

根据文档id查询文档信息

Parameters
[in]id文档id
[in]json_extension无效扩展字段
[in]cb返回错误码和文档信息
Returns
void 无返回值

◆ GetInfoList()

void nim::DocTrans::GetInfoList ( const std::string &  id,
int32_t  limit,
const std::string &  json_extension,
const DocInfosCallback &  cb 
)
static

根据文档id查询文档信息

Parameters
[in]查询的起始docId，若为空，表示从头开始查找，按照文档转码的发起时间降序排列
[in]limit查询的文档的最大数目，有最大值限制，目前为30
[in]json_extension无效扩展字段
[in]cb返回错误码和文档信息
Returns
void 无返回值

◆ GetPageUrl()

std::string nim::DocTrans::GetPageUrl ( const std::string &  url_prefix,
NIMDocTranscodingImageType  img_type,
NIMDocTranscodingQuality  quality,
int32_t  page_num 
)
static

拼接文档图片的下载地址

Parameters
[in]url_prefix文档信息中的url前缀
[in]img_type文档转换的图片类型
[in]quality需要的图片清晰度
[in]page_num图片页码（从1开始计算）
[in]cb结果回调见nim_doc_trans_def.h，成功返回的json_extension中带有一条记录
Returns
std::string 返回文档图片的下载地址

◆ GetSourceFileUrl()

std::string nim::DocTrans::GetSourceFileUrl ( const std::string &  url_prefix,
NIMDocTranscodingFileType  file_type 
)
static

拼接文档源的下载地址

Parameters
[in]url_prefix文档信息中的url前缀
[in]file_type文档源类型
Returns
std::string 返回文档源的下载地址

◆ RegNotifyCb()

void nim::DocTrans::RegNotifyCb ( const DocInfoCallback &  cb)
static

注册文档转换的结果的回调通知

Parameters
[in]cb返回错误码和文档信息
Returns
void 无返回值
The documentation for this class was generated from the following files: