云点播 Node.js SDK

一、使用 npm 安装

npm i vod-node-sdk –save

二、通过源码包安装

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

·从 Github 访问

·单击下载 Node.js SDK

三、初始化上传对象

使用云 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); }});

九、指定存储地域

在 控制台 确认已经开通目标存储地域，若没有开通可以参考 上传存储设置，最后通过StorageRegion属性设置存储地域的 英文简称。

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

上传请求类VodUploadRequest

上传响应类VodUploadResponse

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

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

十三、错误码表