NodeJS SDK

最近更新时间:2019-06-14 17:55:11

对于在服务端上传视频的场景,腾讯云点播提供了 NodeJS SDK 来实现。上传流程请参见 服务端上传指引

集成方式

使用 npm 安装

npm i vod-node-sdk --save

通过源码包安装

如果项目当中没有使用 npm 工具进行依赖管理的,可以直接下载源码导入项目中使用:

简单视频上传

初始化上传对象

使用云 API 密钥初始化 VodUploadClient 实例。

const { VodUploadClient, VodUploadRequest } = require('vod-node-sdk');

client = new VodUploadClient("your secretId", "your secretKey");

构造上传请求对象

let req = new VodUploadRequest();
req.MediaFilePath = "/data/file/Wildlife.mp4";

调用上传

调用上传方法,传入上传地域及上传请求,通过回调方法获取返回的信息。

client.upload("ap-guangzhou", req, function (err, data) {
    if (err) {
        // 处理业务异常
        console.log(err)
    } else {
        // 获取上传成功后的信息
        console.log(data.FileId);
        console.log(data.MediaUrl);
    }
});

高级功能

携带封面

const { VodUploadClient, VodUploadRequest } = require('vod-node-sdk');

client = new VodUploadClient("your secretId", "your secretKey");
let req = new VodUploadRequest();
req.MediaFilePath = "/data/file/Wildlife.mp4";
req.CoverFilePath = "/data/file/Wildlife-cover.png";
client.upload("ap-guangzhou", req, function (err, data) {
    if (err) {
        // 处理业务异常
        console.log(err)
    } else {
        // 获取上传成功后的信息
        console.log(data.FileId);
        console.log(data.MediaUrl);
        console.log(data.CoverUrl);
    }
});

指定任务流

首先 创建任务流模板 并为模板命名,发起任务流时,可以用任务流模板名设置Procedure参数,上传成功后会自动执行任务流。

const { VodUploadClient, VodUploadRequest } = require('vod-node-sdk');

client = new VodUploadClient("your secretId", "your secretKey");
let req = new VodUploadRequest();
req.MediaFilePath = "/data/file/Wildlife.mp4";
req.Procedure = "Your Procedure Name";
client.upload("ap-guangzhou", req, function (err, data) {
    if (err) {
        // 处理业务异常
        console.log(err)
    } else {
        // 获取上传成功后的信息
        console.log(data.FileId);
        console.log(data.MediaUrl);
    }
});

子应用上传

传入 子应用 ID,上传成功后资源只属于具体的子应用。

const { VodUploadClient, VodUploadRequest } = require('vod-node-sdk');

client = new VodUploadClient("your secretId", "your secretKey");
let req = new VodUploadRequest();
req.MediaFilePath = "/data/file/Wildlife.mp4";
req.SubAppId = 101;
client.upload("ap-guangzhou", req, function (err, data) {
    if (err) {
        // 处理业务异常
        console.log(err)
    } else {
        // 获取上传成功后的信息
        console.log(data.FileId);
        console.log(data.MediaUrl);
    }
});

接口描述

上传客户端类VodUploadClient

属性名称 属性描述 类型 必填
secretId 云 API 密钥 ID。 String
secretKey 云 API 密钥 Key。 String

上传请求类VodUploadRequest

属性名称 属性描述 类型 必填
MediaFilePath 媒体文件路径。 String
MediaType 媒体文件类型,可选类型请参见 视频上传综述,若 MediaFilePath 路径带后缀可不填。 String
MediaName 媒体名称,若不填默认采用 MediaFilePath 的文件名。 String
CoverFilePath 封面文件路径。 String
CoverType 媒体文件类型,可选类型请参见 视频上传综述,若 CoverFilePath 路径带后缀可不填。 String
Procedure 任务流,具体的任务流介绍请参见 参数模版与任务流 String
ExpireTime 媒体文件过期时间,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明 String
ClassId 分类 ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。 Integer
SourceContext 来源上下文,用于透传用户请求信息,上传回调接口将返回该字段值,最长250个字符。 String
SubAppId 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。 Integer

上传响应类VodUploadResponse

属性名称 属性描述 类型
FileId 媒体文件的唯一标识。 String
MediaUrl 媒体播放地址。 String
CoverUrl 媒体封面地址。 String
RequestId 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 String

上传方法VodUploadClient.upload(String region, VodUploadRequest request, function callback)

参数名称 参数描述 类型 必填
region 上传地域,具体参考支持的 地域列表 String
request 上传请求 。 VodUploadRequest
callback 上传完成回调函数。 function

上传完成回调函数function(err, data)

参数名称 参数描述 类型 必填
err 错误信息。 Exception
data 上传响应结果。 VodUploadResponse

错误码列表

状态码 含义
InternalError 内部错误。
InvalidParameter.ExpireTime 参数值错误:过期时间。
InvalidParameterValue.CoverType 参数值错误:封面类型。
InvalidParameterValue.MediaType 参数值错误:媒体类型。
InvalidParameterValue.SubAppId 参数值错误:子应用 ID。
InvalidParameterValue.VodSessionKey 参数值错误:点播会话。
ResourceNotFound 资源不存在。