发起文档转码任务 WbTranscodeCreate

为了在白板互动中共享文件，你可能需要将文档转为静态图片或动态的 HTML5 页面。通过调用服务端 OpenAPI WbTranscodeCreate 发起文档转码任务。

转码的任务处理是异步的，你可以通过 WbTranscodeQuery 查询到转码任务完成后，调用 WbTranscodeGet 获取转换好的链接集合。

调用服务端接口完成文档转码后，你还需要调用客户端接口，将转码后的文档共享到白板房间。文件上传的完整流程参见 文档上传。

接口行为

WbTranscodeCreate 发起一个文档转码任务。

• 静态转码：可将 PPT、PPTX、DOC、DOCX、PDF 格式文件转为 PNG、JPG/JPEG 的静态图片。文档中的每个页面转换为一张图片。
• 动态转码：可将 PPT、PPTX 格式文件转换为 HTML5 页面，支持实时交互，动态展示动画或多媒体。对照动态转码文件要求检查文件，以确保动态文档转码任务顺利执行。

• 调用本接口前，你需要先将文件上传到 TOS。
• 如果你需要对多个文件进行转码，请分别调用 WbTranscodeCreate 传入相应的文件和参数设置。

前提条件

• 在 RTC 控制台开通转码服务
• 在火山引擎或其他 TOS 服务商开通了 TOS 服务

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

• 请求方式：POST
• 请求地址：https://rtc.volcengineapi.com?Action=WbTranscodeCreate&Version=2023-11-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Body

收起全部

参数	类型	是否必选	示例值	描述
AppId	String	是	Your_AppId	应用的唯一标志。你可以通过控制台查看和复制你的 app_id。或通过调用 ListApps 接口获取。
Operator	String	是	Operator	发起转码的用户 ID
Resource	String	是	Your_resource_url	需要转换为图片的文档链接地址。每次调用接口只能请求处理一份文档。
ResourceAttr	Object	否	-	动态转码文件设置。动态转码必填，静态转码无需填写
FileName	String	是	Your_file_name	文件名
Size	Integer	是	10000	文件大小，单位字节
TranscodeMode	Integer	是	0	转码类型 0: 静态转码 1: 动态转码 默认值为 0。
Priority	Integer	是	0	静态转码的转码优先级 0: 非实时转码 1: 实时转码 默认值为 0。
TranscodeConfig	Object	否	-	转码配置，静态转码时必填，动态转码需要生成缩略图时必填
ForceUseResolution	Boolean	是	false	是否按照指定分辨率拉伸页面 默认为 false，按照文件的原始宽高比适配指定分辨率。
InputFormat	Integer	是	2	输入文件类型 1: ppt 2: pptx 3: doc 4: docx 5: pdf
OutputFormat	Integer	是	1	输出文件类型 1: png 2: jpg/jpeg
OutputWidth	Integer	是	1080	转码后的页面宽度，单位为像素
OutputHeight	Integer	是	720	转码后的页面高度，单位为像素
Thumbnail	Boolean	是	true	是否需要缩略图。 true：需要 false：不需要。 默认为 false。
ThumbnailWidth	Integer	是	270	缩略图分辨率宽，单位为像素，默认为 320
ThumbnailHeight	Integer	是	180	缩略图分辨率高，单位为像素，默认为 180
StorageConfig	Object	否		转码结果存储配置，参数优先级高于控制台配置。 若控制台未进行设置，此参数必填。
Type	Integer	否	0	存储平台。 0: TOS 1: 第三方对象存储接口。 默认值为 0。
TosConfig	Object	否	-	火山引擎的对象存储服务参数设置
AccountId	String	是	Your_account_id	Bucket 所属的火山引擎账号 ID。在登录火山引擎后，可在头像的悬浮菜单中找到账号 ID。
Region	Integer	是	0	参看 Region 对照表。
Bucket	String	是	Your_bucket	桶名称。登录 TOS 控制台 开通和获取。
CustomConfig	Object	否	-	第三方对象存储服务参数设置
Vendor	Integer	是	0	第三方存储供应商 0: Amazon 亚马逊 1: Alicloud 阿里云
Region	Integer	是	0	参看 Region 对照表 当 vendor =0 时，7、9、15、16、17、23 均不支持。
Bucket	String	是	Your_bucket	桶名称
AccessKey	String	是	Your_access_key	第三方存储平台账号的密钥。需确保此账号对存储桶有写权限，不建议开启读权限。
SecretKey	String	是	Your_secret_key	第三方存储平台账号的密钥
PreSignDuration	Integer	否	0	TOS 桶中存储对象的预签名 URL 有限期。单位为秒，取值范围为[0,604800]。默认值为 0，表示无限期。

返回参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

请求示例

POST https://rtc.volcengineapi.com?Action=WbTranscodeCreate&Version=2023-11-01
{
    "AppId": "Your_AppId",
    "Operator": "Operator`",
    "PreSignDuration": 0,
    "Priority": 0,
    "Resource": "Your_resource_url",
    "ResourceAttr": {
        "FileName": "Your_file_name",
        "Size": 10000
    },
    "StorageConfig": {
        "Type": 0,
        "TosConfig": {
            "AccountId": "Your_account_id",
            "Region": 0,
            "Bucket": "Your_bucket"
        },
        "CustomConfig": {
            "Vendor": 0,
            "Region": 0,
            "Bucket": "Your_bucket",
            "AccessKey": "Your_access_key",
            "SecretKey": "Your_secret_key"
        }
    },
    "TranscodeConfig": {
        "ForceUseResolution": false,
        "InputFormat": 2,
        "OutputFormat": 1,
        "OutputWidth": 1080,
        "OutputHeight": 720,
        "Thumbnail": true,
        "ThumbnailWidth": 270,
        "ThumbnailHeight": 180
    },
    "TranscodeMode": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "your_request_id",
        "Service": "rtc",
        "Region": "cn-north-1",
        "Action": "WbTranscodeCreate",
        "Version": "2023-11-01"
    },
    "Result": {
        "TaskId": "Your_TaskId"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。