集成方式
使用 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);}});
指定任务流
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);}});
应用上传
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);}});
指定存储地域
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.StorageRegion = "ap-chongqing";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("Credentials TmpSecretId", "Credentials TmpSecretKey", "Credentials Token");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);}});
自适应码流文件上传
本 SDK 支持上传的自适应码流格式包括 HLS 和 DASH,同时要求 manifest(M3U8 或 MPD)所引用的媒体文件必须为相对路径(即不可以是 URL 和绝对路径),且位于 manifest 的同级目录或者下级目录(即不可以使用
../
)。在调用 SDK 上传接口时,MediaFilePath
参数填写 manifest 路径,SDK 会解析出相关的媒体文件列表一并上传。const { VodUploadClient, VodUploadRequest } = require('vod-node-sdk');client = new VodUploadClient("your secretId", "your secretKey");let req = new VodUploadRequest();req.MediaFilePath = "/data/file/prog_index.m3u8";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 | 待上传的媒体文件路径。必须为本地路径(用户服务器上的路径),不支持 URL。 | String | 是 |
SubAppId | Integer | 否 | |
MediaType | String | 否 | |
MediaName | 上传后的媒体名称,若不填默认采用 MediaFilePath 的文件名。 | String | 否 |
CoverFilePath | 待上传的封面文件路径。必须为本地路径(用户服务器上的路径),不支持 URL。 | String | 否 |
CoverType | String | 否 | |
Procedure | String | 否 | |
ExpireTime | String | 否 | |
ClassId | Integer | 否 | |
SourceContext | 来源上下文,用于透传用户请求信息,上传回调接口将返回该字段值,最长250个字符。 | String | 否 |
StorageRegion | String | 否 |
上传响应类
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 | 资源不存在 |