api.video是一个API,在去上编码以方便即时回放,增强多个设备和平台的取景器流出经验. 您可以在几分钟内流出现场或点播在线视频.

api.video 节点JS SDK

警告:这个SDK很快会 已贬值 将不再保留。 现改为: 节点JS API 客户端请使用它.

这个 视频 网络服务帮助您将视频放入网络而无需麻烦. 此文档帮助您使用相应的节点JS客户端.

安装

npm install @api.video/nodejs-sdk

使用量

const apiVideo = require('@api.video/nodejs-sdk');

(async () => {
  try {
    // Create client for Production and authenticate
    const client = new apiVideo.Client({ apiKey: 'xxx' });

    // Create and upload a video ressource
    const video = await client.videos.upload('test/data/small.webm', { title: 'Course #4 - Part B' });
    console.log(video);
  } catch (e) {
    console.error(e);
  }
})();

见 沙盒. spec.js (英语) 用于更多使用实例.

完整 API

/**
 * VIDEO
 */
const client = new apiVideo.Client({ apiKey: 'xxx' });

// Show a video
client.videos.get(videoId);

// Show a video status
client.videos.getStatus(videoId);

// List or search videos
client.videos.search(parameters = {});

// Create video properties
client.videos.create(title, properties = {});

// Upload a video media file
// Create a video, if videoId is null
client.videos.upload(source, properties = {}, videoId = null);

// Create a video by downloading it from a third party
client.videos.download(source, title, properties = {});

// Update video properties
client.videos.update(videoId, properties);

// Set video public
client.videos.makePublic(videoId);

// Set video private
client.videos.makePrivate(videoId);

// Delete video (file and data)
client.videos.delete(videoId);

// Delegated upload (generate a token for someone to upload a video into your account)
result = client.tokens.generate(); // string(3): "xyz"
result.then(function(token) {
  // ...then upload from anywhere without authentication:
  //  curl https://ws.api.video/upload?token=xyz -F [email protected]
});

/**
 * VIDEO THUMBNAIL
 */
// Upload a thumbnail for video
client.videos.uploadThumbnail(source, videoId);

// Update video's thumbnail by picking timecode
client.videos.updateThumbnailWithTimecode(videoId, timecode);

/**
 * VIDEO CAPTIONS
 */
// Get caption for a video
client.videos.captions.get(videoId, language);

// Get all captions for a video
client.videos.captions.getAll(videoId);

// Upload a caption file for a video (.vtt)
client.videos.captions.upload(source, properties);


// Set default caption for a video
client.videos.captions.updateDefault(videoId, language, isDefault);

// Delete video's caption
client.videos.captions.delete(videoId, language);

/**
 * VIDEO CHAPTERS
 */
// Get caption for a video
client.videos.chapters.get(videoId, language);

// Get all chapters for a video
client.videos.chapters.getAll(videoId);

// Upload a chapter file for a video (.vtt)
client.videos.chapters.upload(source, properties);

// Delete video's chapter
client.videos.chapters.delete(videoId, language);

/**
 * PLAYERS
 */
// Get a player
client.players.get(playerId);

// List players
client.players.search(parameters = {});

// Create a player
client.players.create(properties = {});

// Update player's properties
client.players.uploadLogo(source, playerId, link);

// Update player's properties
client.players.update(playerId, properties);

// Delete a player logo
client.players.deleteLogo(playerId);

// Delete a player
client.players.delete(playerId);

/**
 * LIVE
 */
// Show a live
client.lives.get(liveStreamId);

// List or search lives
client.lives.search(parameters = {});

// Create live properties
client.lives.create(name, properties = {});

// Update live properties
client.lives.update(liveStreamId, properties);

// Delete live (file and data)
client.lives.delete(liveStreamId);

/**
 * LIVE THUMBNAIL
 */
// Upload a thumbnail for live
client.lives.uploadThumbnail(source, liveStreamId);

/**
 * ANALYTICS
 */
// Get video analytics between period
client.analyticsVideo.get(videoId, period);

// Get live analytics between period
client.analyticsLive.get(liveStreamId, period);

// Get analytics session events
client.analyticsLive.get(sessionId, parameters);

API 全部细节执行

视频

| 函数 | 参数 | 说明 | 需求 | 允许的值 |
|:相去相去也;相去相去也;相去相去也;相去也;相去也;相去也;相去也;相去也;相去也;相去也 | 起来 QQ 视频Id( 字符串) QQ 视频标识符 QQ : havy check mark: QQ - 说吧 | | 获取状态 QQ 视频Id( 字符串) QQ 视频标识符 QQ : havy check mark: QQ - 说吧 | | 搜索 | - 说吧 | - 说吧 | - 说吧 | - 说吧 | | - 说吧 QQ参数(对象) QQ搜索参数 Q:x:QQ

• 当前页( int)
• 页面大小( int)
• 排序By( 字符串)
• 排序顺序( 字符串)
• 关键字( 字符串)
• 标记( 字符串- 阵列( 字符串))
• 元数据( 阵列( 字符串) )

• 说明(字符串)
• 标记( 阵列( 字符串) )
• 播放器Id( 字符串)
• 元数据( 阵列 (a)
  数组( r)
  钥匙 钥匙 钥匙,
  “ 值” qq“ 值1 ”
  , (中文(简体) ),
  数组( r)
  钥匙 钥匙 钥匙,
  “ 值” qq“ 值 2 ”
  (中文(简体) )
  (中文(简体) )
• 全景( 布尔)
• 公开( 博尔)
• mp4 支持( 布尔)

• 标题(字符串)
• 说明(字符串)
• 标记( 阵列( 字符串) )
• 播放器Id( 字符串)
• 元数据( 阵列 (a)
  数组( r)
  钥匙 钥匙 钥匙,
  “ 值” qq“ 值1 ”
  , (中文(简体) ),
  数组( r)
  钥匙 钥匙 钥匙,
  “ 值” qq“ 值 2 ”
  (中文(简体) )
  (中文(简体) )

• 标题(字符串)
• 说明(字符串)
• 标记( 阵列( 字符串) )
• 播放器Id( 字符串)
• 元数据( 阵列 (a)
  数组( r)
  钥匙 钥匙 钥匙,
  “ 值” qq“ 值1 ”
  , (中文(简体) ),
  数组( r)
  钥匙 钥匙 钥匙,
  “ 值” qq“ 值 2 ”
  (中文(简体) )
  (中文(简体) )
• 全景( 布尔)
• 公开( 博尔)
• mp4 支持( 布尔)

玩家

说明

章节

活着

| 函数 | 参数 | 说明 | 需求 | 允许的值 |
|:相去相去也;相去相去也;相去相去也;相去也;相去也;相去也;相去也;相去也;相去也;相去也 | 起来 ################################################################################################################################################################################################################################################################ - 说吧 | | 搜索 | - 说吧 | - 说吧 | - 说吧 | - 说吧 | | - 说吧 QQ参数(对象) QQ搜索参数 Q:x:QQ

• 当前页( int)
• 页面大小( int)
• 排序By( 字符串)
• 排序顺序( 字符串)

• 记录(布尔)
• 播放器Id( 字符串)

• 名称( 字符串)
• 记录(布尔)
• 播放器Id( 字符串)

分析视频

| 函数 | 参数 | 说明 | 需求 | 允许的值/格式 |
|:相去相去也;相去相去也;相去相去也;相去也;相去也;相去也;相去也;相去也;相去也;相去也 | 起来 | - 说吧 | - 说吧 | - 说吧 | - 说吧 | | - 说吧 QQ 视频Id( 字符串) QQ 视频标识符 QQ : havy check mark: QQ - 说吧 | | - 说吧 时间(弦) 时间(弦) 研究 : : :

• 一天时间: 2018-01-01
• 一个星期:2018-W01
• 一个月:2018-01
• 为期一年:2018年
• 日期范围:2018-01-2018-01-15
|

分析活性

| 函数 | 参数 | 说明 | 需求 | 允许的值/格式 |
|:相去相去也;相去相去也;相去相去也;相去也;相去也;相去也;相去也;相去也;相去也;相去也 | 起来 | - 说吧 | - 说吧 | - 说吧 | - 说吧 | | - 说吧 ################################################################################################################################################################################################################################################################ - 说吧 | | - 说吧 时间(弦) 时间(弦) 研究 : : :

• 一天时间: 2018-01-01
• 一个星期:2018-W01
• 一个月:2018-01
• 为期一年:2018年
• 日期范围:2018-01-2018-01-15
|

分析会话

| 函数 | 参数 | 说明 | 需求 | 允许的值/格式 |
|:相去相去也;相去相去也;相去相去也;相去也;相去也;相去也;相去也;相去也;相去也;相去也 | 起来 | - 说吧 | - 说吧 | - 说吧 | - 说吧 | | - 说吧 QQ会话Id( 字符串) QQ会话标识符 : @: havy check mark: @ @ - 说吧 | | - 说吧 QQ 参数( 阵列) QQ 搜索参数 QQ: x: QQ

• 当前页( int)
• 页面大小( int)
|

键

| 函数 | 参数 | 说明 | 需求 | 允许的值 |
|:相去相去也;相去相去也;相去相去也;相去也;相去也;相去也;相去也;相去也;相去也;相去也 | 生成 | - 说吧 QQ 用于授权上传QQ - 说吧 | - 说吧 |

账户

| 函数 | 参数 | 说明 | 需求 | 允许的值 |
|:相去相去也;相去相去也;相去相去也;相去也;相去也;相去也;相去也;相去也;相去也;相去也 | 起来 | - 说吧 | 获取账户信息( 配额, 特性) | - 说吧 | - 说吧 |

更多关于 api.video

技术文件全文见 页:1

测试

npm run test

您也可以针对您实际的沙盒运行一系列命令 :

API_KEY=xxx npm run test:sandbox

使用 沙盒 API 密钥 而不是你的制作钥匙.