terasum

GitHub - bitmovin/bitmovin-javascript: Bitmovin Javascript API 客户端

terasum · 2017-04-26翻译 · 643阅读 原文链接

Javascript-API-Client 可以让你在项目中无缝集成 Bitmovin API

使用这个API客户端需要拥有一个有效的账户。 Sign up for a Bitmovin API key.

完整的 Bitmovin API 参考文档 可以在这个网站找到。

安装

npm install bitmovin-javascript

或者用 yarnpkg

yarn add bitmovin-javascript

初始化

使用 Babel/ES6:

import Bitmovin from 'bitmovin-javascript';
const bitmovin = new Bitmovin({'apiKey': BITMOVIN_API_KEY, debug: false});

使用 NodeJS:

const Bitmovin = require('bitmovin-javascript').default;
const bitmovin = new Bitmovin({'apiKey': BITMOVIN_API_KEY, debug: false});

使用方法

Bitmovin-Javascript API 客户端是完全实现了我们的 Bitmovin API 参考文档 Bitmovin API. 每一个在API参考文档中出现的资源都1:1地对应到了我们的API 客户端中。

所有的方法都返回了Promise 对象,这个对象将会从API中取得相应的结果并返回。

举例而言,列出所有的输入调用在我们的API文档中定义是GET v1/encoding/inputs 简单对应到代码就是:

const limit = 100;
const offset = 0;
bitmovin.encoding.inputs.list(limit, offset).then((inputs) => {
  inputs.forEach((input) => {
    console.log(input.name);
  });
});

例子

一个简单的 DASH & HLS 编码样例可以在这里找到: examples/encoding/01_simple_encoding_dash_manifest.js

更多的例子可以到 样例页面 或者到 集成测试页面 查看

贡献

如果你想为我们的项目做贡献,你可以发起Pull-Requests。首先确定你能够跑过所有的测试,其次新的函数需要有足够的覆盖率。

运行测试:

yarn test
yarn coverage

译者terasum尚未开通打赏功能

相关文章