简介
本文档提供关于文档转码同步请求的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.1.1。
API | 操作描述 |
文档预览功能支持对多种文件类型生成图片格式预览,并可对转换后的图片同步进行基础处理操作,可以解决文档内容的页面展示问题,满足 PC、App 等多个用户端的文档在线浏览需求,适用于在线教育、企业 OA、网站转码等业务场景 |
文档转码同步请求
功能说明
文档预览功能支持对多种文件类型生成图片格式预览,并可对转换后的图片同步进行基础处理操作,可以解决文档内容的页面展示问题,满足 PC、App 等多个用户端的文档在线浏览需求,适用于在线教育、企业 OA、网站转码等业务场景。
使用示例
function getDocPreview() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const ObjectKey = "test.docx";const key = `${ObjectKey}` // ObjectKey:{ObjectKey};const host = `${config.Bucket}.cos.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Query: {// 数据万象处理能力,文档预览固定为 doc-preview;是否必传:是"ci-process": "doc-preview",// 源数据的后缀类型,当前文档转换根据 COS 对象的后缀名来确定源数据类型。当 COS 对象没有后缀名时,可以设置该值;是否必传:否srcType: "",// 需转换的文档页码,默认从1开始计数;表格文件中 page 表示转换的第 X 个 sheet 的第 X 张图;是否必传:否page: 0,// 转换输出目标文件类型:png,转成 png 格式的图片文件jpg,转成 jpg 格式的图片文件 PDF,转成 PDF 格式文件。 无法选择页码,page 参数不生效如果传入的格式未能识别,默认使用 jpg 格式;是否必传:否dstType: "jpg",// Office 文档的打开密码,如果需要转换有密码的文档,请设置该字段;是否必传:否password: "",// 是否隐藏批注和应用修订,默认为00:隐藏批注,应用修订1:显示批注和修订;是否必传:否comment: 0,// 表格文件参数,转换第 X 个表,默认为1;是否必传:否sheet: 0,// 表格文件转换纸张方向,0代表垂直方向,非0代表水平方向,默认为0;是否必传:否excelPaperDirection: 0,// 设置纸张(画布)大小,对应信息为: 0 → A4 、 1 → A2 、 2 → A0 ,默认 A4 纸张 (需配合 excelRow 或 excelCol 一起使用);是否必传:否excelPaperSize: 0,// 转换后的图片处理参数,支持 基础图片处理 所有处理参数,多个处理参数可通过 管道操作符 分隔,从而实现在一次访问中按顺序对图片进行不同处理;是否必传:否ImageParams: "",// 生成预览图的图片质量,取值范围为 [1, 100],默认值100。 例如取值为100,代表生成图片质量为100%;是否必传:否quality: 0,// 预览图片的缩放参数,取值范围为 [10, 200], 默认值100。 例如取值为200,代表图片缩放比例为200% 即放大两倍;是否必传:否scale: 0,// 按指定 dpi 渲染图片,该参数与 scale 共同作用,取值范围 96-600 ,默认值为 96 。转码后的图片单边宽度需小于65500像素;是否必传:否imageDpi: 0,},},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}getDocPreview()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | {ObjectKey} | String | 是 |
Query | 请求参数 | Object | 否 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
ci-process | 数据万象处理能力,文档预览固定为 doc-preview | String | 是 |
srcType | 源数据的后缀类型,当前文档转换根据 COS 对象的后缀名来确定源数据类型。当 COS 对象没有后缀名时,可以设置该值 | String | 否 |
page | 需转换的文档页码,默认从1开始计数;表格文件中 page 表示转换的第 X 个 sheet 的第 X 张图 | Integer | 否 |
dstType | 转换输出目标文件类型:png,转成 png 格式的图片文件jpg,转成 jpg 格式的图片文件 PDF,转成 PDF 格式文件。 无法选择页码,page 参数不生效如果传入的格式未能识别,默认使用 jpg 格式 | String | 否 |
password | Office 文档的打开密码,如果需要转换有密码的文档,请设置该字段 | String | 否 |
comment | 是否隐藏批注和应用修订,默认为00:隐藏批注,应用修订1:显示批注和修订 | Integer | 否 |
sheet | 表格文件参数,转换第 X 个表,默认为1 | Integer | 否 |
excelPaperDirection | 表格文件转换纸张方向,0代表垂直方向,非0代表水平方向,默认为0 | Integer | 否 |
excelPaperSize | 设置纸张(画布)大小,对应信息为: 0 → A4 、 1 → A2 、 2 → A0 ,默认 A4 纸张 | Integer | 否 |
ImageParams | 转换后的图片处理参数,支持 基础图片处理 所有处理参数,多个处理参数可通过 管道操作符 分隔,从而实现在一次访问中按顺序对图片进行不同处理 | String | 否 |
quality | 生成预览图的图片质量,取值范围为 [1, 100],默认值100。 例如取值为100,代表生成图片质量为100% | Integer | 否 |
scale | 预览图片的缩放参数,取值范围为 [10, 200], 默认值100。 例如取值为200,代表图片缩放比例为200% 即放大两倍 | Integer | 否 |
imageDpi | 按指定 dpi 渲染图片,该参数与 scale 共同作用,取值范围 96-600 ,默认值为 96 。转码后的图片单边宽度需小于65500像素 | Integer | 否 |
回调函数说明
function(err, data) { ... }