api.video Node.js 客户端

视频 是产品制造者的视频基础设施。 闪电快视频 API 用于在您的应用程序中集成,缩放,并管理点播后低空直播功能.

目录

• 项目说明
• 开始
  • 安装
  • 移徙
  • 发展
  • 代码样本
• 文档
  • API 终点
    • 分析学
    • 说明Api
    • 章节Api
    • LiveStreams 亚庇
    • 玩家主题Api
    • 摘要Api
    • 标签Api
    • 上传托肯斯Api
    • 视频Api
    • 水上标记Api
    • 网络用户
  • 模型
  • 限制费率
  • 授权
    • API 密钥
    • 获取访问符
    • 公共终点
• 你从这个API客户端得到了使用吗?
• 捐款

项目说明

api.video的Java Node.js是一个轻量级客户端,构建于 TypeScript 简化了编码程序。 弹簧文件是为你处理的, 以及重新刷新您的符号.

开始

安装

与 npm数字 :

npm install @api.video/nodejs-client --save

...或者说 yarn数字 :

yarn add @api.video/nodejs-client

移徙

如果你来自 @api.video/nodejs-sdk (英语) 确保阅读我们的 移徙指南 先说.

发展

要构建和编译用于 Javascript 的打字源 :

npm install
npm run build

代码样本

const ApiVideoClient = require('@api.video/nodejs-client');
// or: import ApiVideoClient from '@api.video/nodejs-client';

(async () => {
    try {
        const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });

        // create a video
        const videoCreationPayload = {
            title: "Maths video", // The title of your new video.
            description: "A video about string theory.", // A brief description of your video.
        };
        const video = await client.videos.create(videoCreationPayload);

        // upload a video file into the video container
        await client.videos.upload(video.videoId, "my-video-file.mp4");
    } catch (e) {
        console.error(e);
    }
})();

文档

API 终点

分析学

说明Api

章节Api

LiveStreams 亚庇

玩家主题Api

摘要Api

标签Api

上传托肯斯Api

视频Api

水上标记Api

网络用户

模型

• 访问脚本
• 附加失败请求错误
• 分析
• 分析
• 分析
• 分析数据
• 分析计量分解反应
• 分析计量分解响应
• 分析计量分类响应数据
• 分析计量 超时响应
• 分析计量 超时响应
• 分析计量 超时响应数据
• 分析 Plays400 错误
• 分析程序响应
• 认证文件
• 错误请求
• 字节行距
• 说明
• 说明列表回复
• 说明 更新日期
• 章 次 页 次
• 章节列表回复
• 冲突错误
• 已丢弃的视频更新文件
• 过滤By
• 过滤By1
• 过滤By2
• 链接
• 列表标签响应
• 列表响应数据
• 活体结构
• 生活结构
• LiveStream 创造费
• LiveStream List 反应
• LiveStream Update Payload 下载
• 元数据
• 模型403 错误计划
• 无果
• 倾斜
• 连接
• 玩家会话事件
• 玩家主题
• 玩家主题集
• 玩家主题 创建Payload
• 玩家主题 更新 Payload
• 玩家主题列表响应
• 质量
• 刷新托肯页
• 复流请求对象
• 复流响应对象
• 摘要
• 内容提要
• 简编
• 来源摘要
• 简况
• 托肯创建
• TokenList 响应
• 太多请求
• 未识别请求Url
• 上传文件夹
• 视频
• 视频集
• 视频剪辑
• 视频创建
• 视频来源
• 视频源代码Stream
• 视频源代码StreamLink
• 视频状态
• 视频状态编码
• 视频状态编码元数据
• 视频状态
• 视频状态接收组件
• 视频ThumbnailPickPayload 下载
• 视频更新Payload
• 视频水印
• 视频列表响应
• 水印
• 水印列表响应
• 网页
• Webhooks 创建
• 网络用户列表响应

限制费率

api.video执行限制费率,以确保服务的公平使用和稳定性。 API为您提出的任何 API 请求提供响应头中的速率限制值. /auth终点是唯一没有费率限制的路线.

在这个Node.js客户端中,您可以通过使用 *WithResponseHeaders() 方法的版本。 这些方法既返回反应体,又返回信头,允许您检查 X-RateLimit-Limit, (中文(简体) ), X-RateLimit-Remaining,以及 X-RateLimit-Retry-After 要了解您当前利率限制状态的页眉 .

更多信息,请访问 API 参考。 。 。 .

以下是如何使用这些方法的例子:

const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const { body: videos, headers } = await client.videos.listWithResponseHeaders();
console.log('Rate Limit:', headers['x-ratelimit-limit']);
console.log('Rate Limit Remaining:', headers['x-ratelimit-remaining']);
console.log('Rate Limit Retry after:', headers['x-ratelimit-retry-after']);

授权

API 密钥

多数终点需要使用我们描述的API关键机制进行认证 文档。 。 。 . 访问符生成机制由客户端自动处理.

您只需要提供一个 API 键, 当即时 ApiVideoClient :

const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });

获取访问符

如果您需要访问使用 API 密钥获得的存取键值, 您可以使用客户端的获取 AccessToken () 方法 :

const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const accessToken = await client.getAccessToken();

公共终点

一些端点不需要认证. 这些可以使用没有 API 键的 ApiVideoClient 即时调用:

const client = new ApiVideoClient();

你从这个API客户端得到了使用吗?

请花点时间给客户留下一颗星星

这有助于其他用户找到客户,也帮助我们了解哪些客户最受欢迎. 谢谢!

捐款

由于这个API客户端是由OpenAPI描述生成的,我们不能接受直接向寄存器提出的拉取请求. 如果你想贡献,你可以打开拉 请求我们的仓库 客户端生成器。否则,您也可以简单地打开一个问题,详述您在这个寄存器库中的需要.