接口说明

Web 上传 SDK 支持视频、图片、普通文件的上传。本文介绍 Web 上传 SDK 的相关参数、方法、生命周期和错误码等内容。

initConfig

在初始化 TTUploader 实例时，您可以通过 initConfig 进行初始化配置。

const uploader = new TTUploader(initConfig);

initConfig 支持的参数如下表所示。

videoConfig

videoConfig 为视频或普通文件上传专用配置，支持的参数如下表所示。

示例代码如下：

videoConfig: {
    spaceName: 'xxx', 
}

本节为您介绍 Web 上传 SDK 提供的方法。

addFile(fileOption)

添加视频文件。调用该方法时，您需传入 fileOption。该方法返回当前文件的 key 值，在启动和取消文件上传时使用。示例代码如下：

const key = uploader.addFile({
    file: Blob, // 上传文件的 Blob 对象
    stsToken: {},
    type: 'video',
    processAction: [
        {
            Name: 'GetMeta'
        },
        {
            Name: 'StartWorkflow',
            Input: {
                TemplateId: '25524a2dae4541db93b2e891d******' // 工作流模板 ID
            }
        },
        {
            Name: 'Snapshot',
            Input: {
                SnapshotTime: 2
            }
        }
    ]
});
console.log(key);  // 示例：file_1495442273603_999031

fileOption

fileOption 支持的参数如下表所示。

processAction

processAction 对象的结构如下表所示。

processAction 对象目前支持的 Action 如下表所示。

StartWorkflowInput

StartWorkflowInput 支持的参数如下表所示。

SnapshotInput

SnapshotInput 支持的参数如下表所示。

AddOptionInfoInput

AddOptionInfoInput 支持的参数如下表所示。

fileOption.type 和 AddOptionInfoInput.Category 参数取值的对应关系如下表所示。

start(key)

启动上传任务。如果上传被暂停，则再次调用此方法时将从断点处开始上传。调用该方法时，您需传入文件的 key 值；如不传，则开始所有文件的上传。示例代码如下：

uploader.start();

removeFile(key)

移除某个待上传的文件或者取消该文件的上传。其中，key 值从 addFile 方法中返回。示例代码如下：

uploader.removeFile('file_1495442273603_999031');

cancel(key)

取消某一文件的上传，同时删除暂存的上传信息。调用该方法时，您需传入文件的 key 值；如不传，则取消所有文件的上传。示例代码如下：

uploader.cancel();

pause(key)

暂停上传，将暂存当前文件的上传信息。调用该方法时，您需传入文件的 key 值；如不传，则暂停所有文件的上传。示例代码如下：

uploader.pause();

此处的生命周期是指上传某一个文件时候的生命周期，即一个视频上传产品线上的各个任务。

捕获某个生命周期的示例代码如下所示。

uploader.on('xxx', function(data) {
    console.log('xxx', data);
});

生命周期各阶段如下表所示。

Returned Value

在捕获每一个生命周期时都可获得描述当前状态的 data 信息，该信息在整个周期中不断完善，最终得到的 data 信息如下表所示：

uploadResult

视频上传

对于视频上传的返回结果，默认情况下只会返回 Vid，如果想获取详细的视频 meta 信息、封面图，请在上传时添加配置。

普通文件上传

详见上传 SDK 错误码。